Documentación Mi Firma

1. APIs

En el modulo de API nos dirigimos a "Mi Firma" (pruebas o producción).

2. Método Authenticate

Este método nos permitirá autenticarnos en el servicio para poder hacer consumo de los demás métodos que componen el servicio de Mi Firma, este método nos solicitara los siguientes dos parámetros

3. Método Upload

Este método le permitirá cargar una plantilla o documento en base64 para usarlo en uno varios procesos de Firma en el servicio, los parámetros que le solicitara son los siguientes:

4. Método Settings

Por medio del método settings podrá realizar un proceso firma, agregar el documento y los firmantes necesarios para firmar, este método le solicitará los siguientes parámetros:

4. Video Consumo

Introduccion

Mi Firma es un servicio de firma de documentos el cual le permitirá firmar documentos, consultar y llevar la trazabilidad de sus documentos, Mi Firma genera los documentos tanto con firma electrónica como la firma digital, el servicio de Mi Firma le permitirá realizar la emisión de documentos para que sean firmados por las personas que se solicite, a su vez por medio del servicio de Mi Firma le permitirá crear las plantillas, usuarios y procesos de firmas para emitir hacia el firmante o firmantes que se requieran.

2. Proceso de Firma con Usuario Registrado

2.1 Método Authenticate

Para ello se tiene el siguiente Endpoint de Pruebas:

https://apim-aeu-test-apimanagement.azure-api.net/miFirma/authenticate

2.1.1 Parametros de Entrada

parametros Descripción Tipo Obligatorio
userName usuario con el que se va a consumir el API String si
password contraseña del usuario String si

2.2 Método Upload

Para ello se tiene el siguiente Endpoint de Pruebas:

https://apim-aeu-test-apimanagement.azure-api.net/miFirma/upload

2.2.1 Parametros de Entrada

Parametros Descripción Tipo Obligatorio
FileName Nombre del documento con su extensión .pdf String si
FileBase64 base64 del documento que queremos enviar String si

2.3 Método Settings

Para ello se tiene el siguiente Endpoint de Pruebas:

https://apim-aeu-test-apimanagement.azure-api.net/miFirma/settings

2.3.1 Parametros de Entrada

Parametros Descripción Tipo Obligatorio
DocumentId El cual es el id de la plantilla o documento que será enviado para firmar String si
Order Nos indicara el orden del firmante para que realice su firma, para aplicar este parámetro se debe tener la opción de “true” en el parámetro enableOrder Int si
GraphX Nos indica la ubicación en X de la firma en qué lugar va a caer Int si
GraphY Nos indica la ubicación en Y de la firma en qué lugar va a caer Int si
HighGraph Altura que se le dará a la firma en el documento Int si
WeightGraph anchor que se le dará a la firma en el documento Int si
NumberPageGraph número de página donde caerá el grafo de firma Int si
User usuario el cual ser el firmante del documento String si
Pages número de páginas del documento Int si
Subject Asunto de correo del proceso de firma String si
Message Mensaje de correo del proceso de firma String si
Recipientse Son los destinatarios que se pueden agregar para el proceso de firma String si
ExpirationDay Indica los días en que expira el documento String si
EnableOrder Este parámetro nos indica por medio de un “true” o “false” si se requiere dar un orden al momento de firmar, este orden es por usuarios. Boolean si
AutomaticReminderDays Este parámetro nos indica cada cuanto se enviará un recordatorio al usuario para que realice el proceso de firma este recordatorio que enviara al correo registrado en la petición Int si
IpAddress nos indica una IP desde la cual se envía el proceso de firma String si
IpAddress Zona horaria del proceso de firma String si

Si la ejecución de este método es exitosa nos proporcionará el processId con el cual se podrá consultar el estado del proceso de firma.

3. URL De Firma

Al correo registrado en la petición llegara una Url para que el usuario abra por medio del explorador, url que lo dirigirá al portal de mi firma para que el usuario pueda firmar el documento.:

4. ACEPTACION Y FIRMA DE DOCUMENTO

Al oprimir Firma al usuario llegara un código OTP para que lo ingrese como lo solicitara la plataforma, una vez lo ingrese el documento se firmara y quedara almacenado en la carpeta personal del usuario en el portal de Mi Firma