Uso de Swagger

Última revisión: 20 septiembre 2022

El sistema cuenta con una interfaz de usuario basada en Swagger para un rápido testing de las APIs REST y revisión de los modelos de contratos expuestos para integradores, en la siguiente URL:

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

El acceso a Swagger no requiere autenticación, mostrando la descripción de los servicios principales ofrecidos a integradores, como el envío de procesos, consulta de su estado y descarga de documentos firmados. Para el acceso al resto de servicios avanzados tendrás que autenticarte con las credenciales (Basic Auth) que previamente te hayan remitido.

¹_Para instalaciones privadas, podrás activarse el acceso a Swagger añadiendo la propiedad API_DOCS_ENABLED al fichero de configuración principal del servicio (Más información en https://doc.viafirma.com/documents/install/latest/es/configuration/configsecurity.html)