Using Swagger

Latest update: September 20st, 2022

The system has a Swagger-based user interface for a quick testing of the APIs REST and for reviewing the contract models available only for developers ,at the following URL:

https://{{domain}}/documents-web/api-docs/ ¹

Access to Swagger does not require authentication, it just presents the description of the main services offered to developers, such as sending requests, checking the status and downloading signed documents. To access the rest of the advanced features, authentication is required with the credentials (Basic Auth) that were previously sent.

¹For private installations, you can enable access to Swagger by adding the API_DOCS_ENABLED property to the main configuration file of the Service (More information at https://doc.viafirma.com/documents/install/latest/es/configuration/configsecurity.html)