Colección Postman para integradores

En el siguiente enlace tienes una colección postman con los casos de uso básicos con los que podrás comenzar a usar el API de Viafirma Documents. Para su uso necesitarás credenciales sobre nuestro entorno de Sandbox.

• nuevo SET
  • estado de un SET
  • resumen de un SET
  • info de un firmante
  • rechazar un SET
• documentos del SET
  • estado del documento
  • detalle del documento
  • lista de documentos por grupo y estado
  • link del documento firmado
  • link del audit trail

Postman Collection Basic Kit

Para implementar un caso de uso específico cosulta los siguiente ejemplos o bien usa nuestra UI para construir una solicitud desde cero acorde a tu caso de negocio y luego exportas el detalle para revisar qué tipo de políticas y configuraciones debes usar para replicarla desde tu llamada al API.

Casos de Uso de Ejemplo

Firma Desatendida con certificado digital

Política de firma desatendida con certificado digital, lo que denominamos como SERVER en la definición de la política de firmas.

"signatures" : [ {
    "type" : "SERVER"
}

Cuando una política de firma solo incluye una firma desatendida no es necesario registrar a ningún firmante (recipient) en el SET. La solicitud de firma pasará automáticamente a un proceso asíncrono encargado de procesar la firma.

El certificado digital configurado para la firma desatendida podrá estar instalado en algunas de las siguientes ubicaciones:

• Viafirma Fortress
• Viafirma Documents (backend)

Colección Postman de Ejemplo: Documents API - Test Firma Desatendida

Firma Cliente con certificado digital

Política de firma con certificado digital instalado en dispositivo del usuario, lo que denominamos como CLIENT en la definición de la política de firmas.

"signatures" : [ {
    "type" : "CLIENT",
    "recipientKey" : "string"
}

El firmante podrá hacer uso de su certificado digital en alguna de estas modalidades:

• Viafirma Desktop (Windows y Mac OS)
• Viafirma Fortress
• Viafirma Fortress Desktop
• Viafirma Documents App (iOS y Android)

A diferencia de la firma desatendida, la FIRMA CLIENTE debe especificar el recipientKey relacionado con la acción. En la siguiente colección encontrarás ejemplos de uso tanto de la firma cliente como de la firma servidor.

Colección Postman de Ejemplo: Documents API - Basic Kit Certificate Signature

Uso de sellos en política de firma con certificado digital

La firma con certificado digital permite el uso en sus políticas del objeto stampers con el que podrás ajustar el aspecto del sello a tus necesidades.

Colección Postman de Ejemplo: Documents API - Test Stampers