Integraciones con la API firmar.online

 
La API de firmar.online consta de tres partes:
  • Prestador de Servicios de Confianza – PSC
  • Firma avanzada desde dispositivo – SignFromApp
  • Servicios avanzados de firma, firma con certificado y timeStamp: eSign

PSC

Es el servicio que permite embeber el proceso de firma dentro de una aplicación y de esa forma independizarse del dispositivo de firma.
Consta de varias operaciones para gestionar la firma del documento, las enumeramos para ofrecer una visión general del producto:

  • DocumentSet. desde una aplicación se puede subir un documento a la plataforma y ésta envía un correo electrónico al firmante para acceder a la firma del documento.
  • Url: sube el documento: después de haber subido el documento a la plataforma, se devuelve el enlace para acceder al documento. De esa forma se puede embeber el proceso de firma dentro de una aplicación o bien insertar el enlace en un correo u otro medio al que se necesite dar acceso a la firma.

A partir de que el documento queda en custodia por la plataforma, ésta se encarga de gestionar la firma del documento: registra todos los eventos que se producen sobre el documento, permitiendo consultar en tiempo real el estado de la petición, descargar el documento una vez firmado, descargar su certificado de evidencias de firma…etc. La lista completa de operaciones, estructura…etc, se puede consultar en el swagger que tenemos publicado en esta dirección. https://restapi.firmar.online/index.html

Por ejemplo, el ciclo de vida de un envío podría ser el siguiente:

  1. Subida de la petición a la plataforma y devolución del enlace para embeberlo en una aplicación => método URL
  2. Cuando el documento queda firmado,
    • recuperar el documento firmado para su archivo:DocumentSet/Document/{documentSetId}/{documentId}
    • descarga del certificado de evidencias en formato PDF /DocumentSet/Evidences/{documentSetId}
 

En la petición de firma se pueden configurar distintos tipos de firma:

  • 10: Notification 
  • 20: Acceptance 
  • 21: AcceptanceSignature 
  • 30: BioSignature 
  • 40: OTPSignature
  • 60: CryptoAPISignature.

Firma avanzada desde dispositivo

Para firmar en tabletas Android mediante la app SIGNply, que está disponible en Google Play.
Con SIGNply se puede recibir una lista de documentos a firmar en la tableta en lugar de recibir uno cada vez.

Capa de servicios

Se pueden consultar los métodos aquí, a continuación se describen las funcionalidades de cada uno de ellos:

  • /SignFromApp/v40/Devices, recupera la lista de terminales asociados a una cuenta. Es el equivalente al getDevices
  • /SignFromApp/v40/Document, envía un documento a firmar a un dispositivo. En la petición se puede configurar con el parámetro autoOpen si queremos que el documento se abra inmediatamente al momento que la tableta tenga conexión, o bien simplemente lo puedo dejar enviado. En este caso en la tableta habrá una lista de documentos como si fuera una lista de impresión, en la que se puede seleccionar qué documento es el que se quiere firmar.
  • /SignFromApp/v40/Document/Cancel/{documentId}, cancela la firma de un documento en el dispositivo en el que se encuentre pendiente de firma.
  • /SignFromApp/v40/Document/Status/{documentId}, consultar el estado de un documento. Como podemos enviar muchos documentos a una tableta, desconectarla (o perder la conexión) y aún así poder firmar los documentos, puedo consultar el estado. Las tabletas cuando recuperan la conexión, se sincronizan de nuevo con el servidor para enviar los documentos que estén firmados, recibir nuevos….etc.
  • /SignFromApp/v40/Document/{documentId}, recuperar un documento firmado. 
  • /SignFromApp/v40/History, recuperar información de la lista de envíos de una cuenta.

Tenemos una colección documentada en POSTMAN desde la cual se puede ejecutar una lista de ejemplos. Se puede consultar desde aquí.

Autenticación y licenciamiento de los puestos de firma

Para autenticar el acceso a la capa de servicios y configurar los dispositivos de firma, es necesario registrarse en app.firmar.online.
Una vez registrados, en el apartado de configuración se puede recuperar la API-KEY de autenticación para las peticiones REST, y por otra parte en la opción “Dispositivos” asociar a la cuenta registrada todos los terminales que se necesiten. La asociación es muy sencilla: dar un nombre y escanear el código QR que se muestra en pantalla, de esta forma facilitamos el mantenimiento al no tener que cargar en cada dispositivo el archivo de licencia.
En los terminales Android hay que descargar la última versión de SIGNply

En la propia aplicación app.firmar.online se pueden realizar pruebas de firma en los dispositivos Android, es un caso de uso de la API para firma presencial (SIGNFROMAPP). 

Servicios avanzados de firma y validación

Servicios avanzados de firma: métodos de firma con certificado electrónico y sellado de tiempo de archivos pdf
Validación: Métodos para validar las evidencias probatorias de los documentos firmados a través de firma remota. La validación de los documentos firmados en tableta se realiza con otras aplicaciones.