¿Cómo puedo probar los servicios?

Te facilitamos una interfaz de usuario, basada en Swagger, que te simplifica y facilita el consumo de los servicios expuestos por viafirma documents en tus pruebas.

Para acceder esta interfaz necesitarás además un usuario autorizado para acceder al backend de viafirma documents, con rol “developer”.

En tres sencillos pasos podrás revisar los servicios y consumirlos directamente desde la interfaz de usuario:

1. Accede al backend, por ejemplo https://sandbox.viafirma.com/documents-web/
2. Usa tus credenciales de usuario (debes tener rol developer)
3. Accedes a la interfaz de swagger, por ejemplo: https://sandbox.viafirma.com/documents-web/api-docs/

Uso de la interfaz de usuario para testing

En esta interfaz te ayudaremos a probar los servicios expuestos por vafirma documents a sus integradores, diferenciando entre servicios públicos y servicios securizados para integradores.

Servicio público

Dispones de un método isAlive que podrás usar en tus monitorizaciones del servicio. No requiere el uso de credenciales.

Curl:

curl -X GET --header "Accept: application/json" "https://sandbox.viafirma.com/documents/api/v3/system/alive"

URL de la Solicitud:

https://sandbox.viafirma.com/documents/api/v3/system/alive

Ejemplo cuerpo de la Respuesta:

{
  "isAlive": "true",
  "pid": "29779"
}

Ejemplo código de la Respuesta:

200

Ejemplo encabezados de la Respuesta:

{
  "date": "Tue, 05 Apr 2016 11:13:30 GMT",
  "content-type": "application/json",
  "connection": "Keep-Alive",
  "keep-alive": "timeout=5, max=100",
  "transfer-encoding": "Identity"
}

Servicios securizados para integradores

Para acceder al resto de servicios disponibles a integradores, necesitarás introducir una clave pública:

Una vez dentro, podrás consumir para cada entidad los distintos métodos implementados POST, GET y PUT