Nombre de la Categoría: > General

API REST – Firma Digital de documentos

El API REST de Firma Digital de documentos es un servicio web que está integrado con el Document Manager de DANAConnect que se utiliza para incorporar una Firma Digital a los documentos PDF que se encuentran almacenados en el repositorio de documentos de DANAConnect.

Funcionalidades del API REST Firma Digital de documentos:

  • Integración con el API REST Document Manager. Ver más
  • Reconocimiento del tipo de archivo, ya que sólo se tomará en cuenta la firma de los PDF.
  • Agrega el código hash en el documento indicado.
  • Valida el código hash en una página de verificación de ciertos contenidos.
  • Opciones de poder colocar el hash en varios espacios del documento, inclusive posicionando o en la primera página, la última o en todas.
  • Opción de agregar un código QR, para facilitar la lectura del código hash.

Pre-requisitos para utilizar el API REST Firma digital de documentos:

  • Cuenta en DANAConnect con usuario que posea acceso al Document Manager y Repositorio de documentos digitales
  • Los documentos a agregarle la firma digital deben estar ya almacenados como PDF en el repositorio de documentos digitales

Autenticación al API

EL API utiliza el mismo sistema de credenciales de usuarios DANAConnect.

Se utiliza el método de autenticación HTTP BASIC AUTH, el cual está basado en un login y password.

Login: El login consiste en el nombre de usuario concatenado con un @ y seguido del código de la compañía.

Ejemplo:

Nombre de usuario: apiuser

Código de compañía: formaciondana

Login para el API: apiuser@formaciondana

 

El método HTTP Basic Auth es el más común para autenticarse desde clientes REST:


Obtener el documento – Servicio GetDocumentSign

Servicio para solicitud de generación del documento en PDF.

 

URI https://api.danaconnect.com/document/1.0/getdocumentsign
METODO POST

 

Parámetros de entrada Descripción Tipo
Authorization Basic Username String
Password String
RequestDocumentSignJSON Request Json json
 

 

Parámetros Salida Descripción Tipo
ResponseDocumentSignJSON Response Json json

Descripción de Parámetros de Entrada del servicio RequestDocumentSignJSON

Propiedad Descripción Tipo
url Dirección del documento en el Storage de DANAConnect. String
isQR Indicar con true o false , si requiere que se agregue el código QR. Boolean
idTypeHashAlignW Alineación horizontal del hash Width (1 Left , 2 Center, o 3 Right) Integer
idTypeHashAlignH Alineación vertical del hash Height (1 Up , 2 Center, o 3 Down) Integer
idTypeQRAlignW Alineación horizontal del QR Width (1 Left , 2 Center, o 3 Rigth) Integer
idTypeQRAlignH Alineación vertical del QR Height (1 Up , 2 Center, o 3 Down) Integer
idTypePage Tipos de inserción en las páginas. (1 First ,2 Last o 3 All ) Integer
info Texto de 255 caracteres que se mostrará en la validación del hash, aquí podrán escribir palabras que permitan validar el documento. String

 


Guía de las propiedades de alienación del código hash y el código QR


Descripción de Parámetros de Salida del servicio ResponseDocumentSignJSON

 

Propiedad Descripción Tipo
responseCode Código del mensaje Integer
responseDescription Descripción del código del mensaje String
url Ubicación del documento firmado en el Storage de DANAConnect String

 

 

Ejemplo de Request

{

"url": "s3://demos/ArchivoFactura1.pdf",

"isQR": true,

"idTypeHashAlignW": 2, "idTypeHashAlignH": 3, "idTypeQRAlignW": 1, "idTypeQRAlignH": 3,

"idTypePage": 3,

"info" : "Documento enviado a DEMO , número de Factura Demo No: F00055555, monto de pago: 1.000"

}

 


Ejemplo de Response

{

"responseCode": "00",

"responseDescription": "OK",

"url": "s3://sign/2020/8/ArchivoFactura1.pdf"

}

 


Códigos de errores

Código Descripción
00 OK
01 Unauthorized user. Access denied
02 Bad parameter
04 Document not found
16 Error: Wrong document type
17 Error: Alignment required (alignment_W 1(Left) – 2(Center) – 3(Right) | alignment_H  1(Up) – 2(Center) – 3(Down) )
18 Error: id page type required ( 1 (First) – 2 (Last) – 3 (All))
19 Error: File Security
20 Error:  Max number of characters in info field exceeded (less than 255)

Ver Tambien:
« | »