Esign-Widget
Al ser la firma uno de los componentes personales que permiten la identificación de personas y la aceptación de condiciones en procesos de negocio, es importante para Tu Identidad fortalecer el proceso de KYC con un servicio que permita recabar y dar certeza legal, así como minimizar la fricción en el proceso de aceptación de las partes sobre diferentes documentos (contratos, pagarés, etc) en un entorno de negocio digital.
Es por esta razón surge la necesidad de crear está librería que te ayuda en el proceso de la recaudación de firmas de manera automatizada.
Instalación
Utilizando npm:
npm i esign-widget
Dependencias
Al momento de instalar Esign-Widget
es necesario instalar las siguiente dependencias para el optimo funcionamiento de la librería.
npm i signature_pad
Implementación
Después de instalar la librería es necesario importar el modulo EsignWidgetModule
en el archivo de app.module.ts
de la siguiente manera:
import { EsignWidgetModule } from 'esign-widget';
Agregar el modulo en la sección de imports
imports: [
EsignWidgetModule,
...
]
Configuración
Una vez realizada la instalación de Esign-Widget es necesario configurar el componente con los datos del documento a firmar. Los datos requeridos son los siguientes:
- token: token de autorización.
- identifier: identificador del archivo firmado.
- name: nombre de la persona que firma el archivo.
- firstName: primer apellido de la persona que firma el archivo.
- lastName: segundo apellido de la persona que firma el archivo.
- rfc: RFC de la persona que firma el archivo, limitado a 12 caracteres.
- email: Correo electrónico de la persona que firma el archivo.
- showSignature: Bandera para identificar si se mostrará o no la firma.
- document: URL del documento a ser firmado.
Ademas de estos estos datos es requerido indicar las funciones que se ejecutarían en caso de éxito o error al momento de la firma del documento, estos campos son:
- onSuccess: Función a ser ejecutada en caso de éxito al firmar el documento.
- onError: Función a ser ejecutada en caso de error al firmar el documento.
Ejemplo
<lib-esign-widget
[onSuccess]="onSuccessFunction"
[onError]="onErrorFunction"
[esignWidgetData]="esignWidgetData"
></lib-esign-widget>
Una vez realizada la instalación de Esign-Widget es necesario configurar el componente con los datos del documento a firmar. Los datos requeridos son los siguientes:
- onSuccess (Function): Función a ser ejecutada en caso de éxito al firmar el documento.
- La función en caso de éxito regresa un objeto con las propiedades:
- status (string)
- message (string)
- onError (Function): Función a ser ejecutada en caso de error al firmar el documento.
- La función en caso de error regresa un objeto con las propiedades:
- code (string)
- message (string)
- esignWidgetData (object): Objeto con la url del documento a firmar, así como la información de la persona. Este objeto cuenta con las siguientes propiedades:
- identifier (string): identificador para obtener archivo una vez firmado.
- name (string): nombre de la persona que firma el archivo.
- firstName (string): primer apellido de la persona que firma el archivo.
- lastName (string): segundo apellido de la persona que firma el archivo.
- rfc (string): RFC de la persona que firma el archivo.
- email (string): Correo electrónico de la persona que firma el archivo.
- showSignature (string): Bandera para identificar si se mostrará o no la firma.
- document (string): URL del documento a ser firmado.
- Es importante considerar que la URL del documento a ser firmado debe ser publica y poder acceder a esta desde cualquier sitio.
- token (string): token de autorización, obtenido con el método de
Obtener token
Ejemplo del objeto de configuración:
{
token: "<token de autenticación>"
identifier: "1000000",
name: "Juan",
firstName: "Perez",
lastName: "Lopez",
rfc: this.makeRandom(12),
email: "xxxxxx@yyyyyyy.com",
showSignature: "true",
document: "http://tuidentidad.com/documento.pdf"
}
Autenticación
Se enuncian a continuación las características del endpoint de autenticación para el consumo del servicio de consulta de firma electrónica, con el cual se obtiene el token requerido en la configuración del componente.
Obtener token
Endpoint de autenticación: https://esign-proxy.tuidentidad.com
~/v1/token
Headers
'apiKey': [Api key de la compañía]
Respuestas:
Correcto
{
"success": boolean,
"token": string
}
Error
{
code: string,
message: string
}