API REST 40 – bienvenido

Firma digital - FULL REST API v40 - Bienvenido

El siguiente documento tiene como objetivo dar detalles de las configuraciones y parámetros básicos para poder integrar la funcionalidad de la firma digital en tus aplicaciones de negocio mediante API REST.

Aquí encontraras todos los métodos y esquemas de firmar.online para integrar en tus procesos de negocio diferentes flujos de firma:

  • Enviar a firmar: envía documentos a otras Personas para que el firmen sobre su propio dispositivo (Firma Remota)
  • Solicitar la firma presencial en tus dispositivos: solicita la firma digital manuscrita a tus propios dispositivos
  • Firma de documentos con certificado electrónico y aplicar en sello de tiempo con garantías probatorias en servidor
  • Validar la firma digital de documentos

¿Cómo puedo comenzar a solicitar la firma digital?

Paso 1: registrate y accede a tu API KEY

Lo primero, tienes que registrarte en nuestra aplicación web. Contamos con un entorno de producción, que ofrece los servicios de firma digital para tus documentos, y un entorno de pruebas (“sandbox”) que podrás utilizar para la fase de integración.

Sólo por registrarte, tendrás acceso a un paquete de 10 firmas para comenzar a funcionar!

entorno de producción

Aquí deberán estar los documentos reales
– Aplicación web: https://app.firmar.online
– endpoint API REST: https://app.firmar.online

entorno de pruebas - Sandbox

Puedes utilizarlo para pruebas de integración
– Aplicación web: https://app.firmar.info
– endpoint API REST: https://app.firmar.info

Paso 2: Integración

Aquí tienes algunos recursos que te ayudarán a integrar la firma digital en tus procesos de negocio:

Definiciones Swagger

Accede a las definiciones de los métodos en Swagger.
Recuerda que tienes una definición para cada tipo de flujo

Colección de POSTMAN

Descárgate la colección API REST para utilizarla en tus peticiones.

Esta colección contiene ejemplos de peticiones que comparten la misma estructura y parámetros de configuración.

La colección invoca distintas VARIABLES: Si estás utilizando POSTMAN, estas variables están pre-configuradas para usar como referencia, pero puedes cambiarlas segun te convenga.

Lo PRIMERO. Modificar la variable API-KEY que has generado en la WebApp en el paso anterior.

Tendrás 2 API – Key, una para Producción y otra para SandBox.

El endpoint contiene la variable: {{base_url}}/…/…

Dependiendo del ambiente en el que quieras firmar, debes modificar la variable {{base_url}}. Recuerda:

  • Sandbox: https://restapi.firmar.info
  • Producción: https://restapi.firmar.online

Paso 3: Pase a producción "estamos en el aire!!"

Si has realizado la integración en el entorno de pruebas, sólo tienes que cambiar el endpoint de producción.

Recuerda que también tienes que tomar el API KEY de la aplicación web de producción!!

Firma digital - Parámetros del API

En este apartado podrás ver los parámetros más relevantes para la automatización de tus procesos de firma digital

Visualización de la firma digital en el documento PDF

La firma digital aplica a todo el documento, independientemente de cómo se visualiza en el mismo. Es decir, aporta las mismas garantías si la firma digital se mantiene oculta, se visualiza en una sola página o en todas las páginas del documento electrónico. 

Llamamos Widget a la visualización de la firma digital en el documento PDF. Si abrimos el documento con Adobe Reader y pulsamos sobre el widget, el propio Adobe nos verifica la validez de la firma.

En este artículo te explicamos cómo se visualiza la firma digital en el PDF saber más

Estado de los documentos (enviar a firmar y firma presencial)

Estos son los posibles estados de los documentos en los procesos de firma presencial y firma remota*:

  • 00 – Sin estado (None)
  • 100- Documento Creado (Created)
  • 200 – en progreso (In Process)
  • 300 Flujo de documento Completado (Completed)
  • 400 Flujo cancelado (Canceled)
  • 500 El interesado ha rechazado firmar el documento (Rejected)
  • 600 Documento eliminado (Deleted)
  • 700 Vencido: ha pasado el plazo para firmar el documento (Expired)

*Nota: recuerda que la firma digital en servidor y la validación de la firma son métodos “sincronos”. La acción se realiza en el momento de la solicitud y el documento no se guarda en el servidor. Por eso, documentos no tienen estado.

Enviar a firmar - firma remota - Comportamiento de los participantes

Cuando enviamos un nuevo sobre, podemos escoger cómo queremos autenticar al participante y qué acciones deben realizar sobre el documento.

Para ello, disponemos de los parámetros

  • authType: forma de autenticación del participante en el flujo del documento. Esta acción se realiza de forma previa a la visualización del documento. (saber más)
  • actionType: firmar.online dispone de diferentes métodos que garantizan la aceptación expresa del firmante al contenido del documento. Esto se traduce en la acción requerida al participante tras visualizar el documento (saber más)

Webhook

El webhook te informará de los cambios de estado de los documentos, por lo que te permitirá realizar un seguimiento automatizado de cada uno de ellos.

Puedes definir tu URL en el área de ajustes de la aplicación web. Saber más

Articulos relacionados con FULL REST API