Pero ¿qué es Mifiel? Es la principal plataforma de firma electrónica de contratos en México, la cual simplifica el proceso de firma electrónica sin sacrificar solidez jurídica. Mifiel cuenta con una API REST, por lo que funciona con cualquier lenguaje de programación con el que quieras integrarla. Para eficientar tu proceso de integración, contamos con librerías de los principales lenguajes de programación, incluyendo PHP, la cual puedes añadir mediante Composer usando este comando: php composer.phar require mifiel/api-client

Este artículo se enfoca en resolver las dudas más comunes sobre la implementación de la firma electrónica mediante una API en sistemas que utilizan PHP, guiándote paso a paso.

Proceso de Integración de la API: un Vistazo

Integrar la API implica la necesidad de crear documentos y gestionar firmas. Los pasos principales para integrarla son:

1. Genera tu documento. Primero tienes que generar una versión del documento que será firmado en formato PDF. Puedes apoyarte de alguna librería PHP para crear o convertir documentos a PDF, como FPDF o TCPDF.
2. Envía el documento al servidor de Mifiel mediante la API. Esto se hace mediante una solicitud POST. Deberás incluir detalles como los correos electrónicos de los firmantes y una URL de callback para notificaciones de firma.
3. Presenta el flujo de firma a tu firmante. Para hacerlo dentro de tu sitio web, debes utilizar el widget de firma de Mifiel, el cual es la interfaz visual integrada en tu sitio web donde los firmantes pueden revisar el contenido del documento y firmarlo.
4. Obtén el documento firmado. Tendrás que realizar llamadas autenticadas a los endpoints del documento para poder descargarlo.

Cómo Enviar el Documento al Servidor

La solicitud POST en PHP para enviar el documento debe verse similar a esta:

require 'vendor/autoload.php';
use Mifiel\Document;

$document = new Document([
  'file_path' => 'path/to/my-file.pdf',
  'signatories' => [[
    'name' => 'Nombre de Firmante',
    'email' => 'firmante@email.com',
    'tax_id' =>  'RFC de firmante'
  ]]
]);
$document->save();

Y la respuesta del servidor debe verse así:

{
  "id": "c914e1ed-a84d-465e-bee8-f3fadf7b7280",
  "original_hash": "f40243ee412ec8f297245feea8a489e7599c5e1b77bc4bf0e92bd3ed48d86b43",
  "created_at": "2022-01-17T16:34:15.065Z",
  "state": "pending",
  "file_file_name": "contrato-ejemplo.pdf",
  "callback_url": "https://my-site.com/mifiel-webhook",
  "file": "/api/v1/documents/c914e1ed-a84d-465e-bee8-f3fadf7b7280/file",
  "signers": [{
    "id": "dc9d63f6-11af-4840-af14-0e51e6da5da4",
    "email": "firmante@email.com",
    "name": "Nombre de Firmante",
    "tax_id": "RFC de firmante",
    "signed": false,
    "widget_id": "5suH28S3f2"
  }]
}

Cómo Integrar el Widget de Firma en tu Sitio Web

El widget es la parte visible de la integración de Mifiel en un sitio web, el cual se muestra como una interfaz donde los firmantes pueden revisar el contenido del documento y firmarlo. Para integrar el widget de firma en tu sitio web, debes insertar un script en tu página web el cual carga un iframe. 
Aquí puedes ver un ejemplo del código HTML para implementar el widget en tu página y cómo lo vería el firmante. Al cargarlo, pone disponible a través de `window.mifiel` una función para cargar el widget dinámicamente. El código de este ejemplo apunta a sandbox.mifiel.com, nuestro servidor de pruebas. Para producción tienes que modificarlo para que apunte a mifiel.com.

Manejo de Callbacks y Respuestas del Servidor

Gestión de Callbacks de Firma

La integración efectiva con la API de Mifiel también implica manejar adecuadamente los callbacks. Cuando un documento se firma en el widget, Mifiel enviará una solicitud POST a tu servidor con información relevante. Esto requiere que configures un endpoint que pueda procesar estas solicitudes. Por ejemplo, cuando todos los firmantes hayan firmado un documento, recibirás un callback con detalles para descargar el documento firmado que se verá así:

Obtención de Documentos Firmados

Una vez que recibas la notificación de que un documento ha sido firmado, puedes proceder a descargarlo. Esto se hace mediante solicitudes a los endpoints proporcionados en el callback.

Actualización del Estado del Documento

Finalmente, es importante que actualices el estado del documento en tu sistema para reflejar que ha sido firmado. Esto asegura que tu flujo de trabajo y tus registros estén siempre actualizados.

Ahora, seguramente quieres comenzar a realizar tu implementación de la API de firma electrónica de Mifiel usando PHP. A continuación te presentamos los pasos a seguir para lograrlo.

Cómo Comenzar a Usar la API de Mifiel en PHP

Para iniciar con la API de Mifiel en tu proyecto PHP, sigue estos pasos:

1. Crea una cuenta en el ambiente de pruebas (sandbox) de Mifiel. Esto te permitirá experimentar tanto como requieras.
2. Cuando tengas una cuenta creada y confirmada, se te acreditarán 5 documentos. Si los agotas, puedes solicitarnos más a través del chat de Mifiel o al correo ayuda@mifiel.com indicando tu correo de usuario y los acreditaremos en tu cuenta de ambiente sandbox.
3. Obtén tus Access Tokens. Necesitarás estos tokens para autenticar tus llamadas a la API.
4. Revisa la documentación de la API. Encuentra ejemplos y detalles técnicos en nuestra documentación.
5. Instala la librería PHP de Mifiel. Disponible en nuestro repositorio de GitHub, esta librería te facilitará el trabajo.
6. Requerirás una e.firma para firmar los documentos en sandbox. Si no cuentas con una, puedes generar una de prueba.
7. Desarrolla y prueba tu implementación. Utiliza el entorno de sandbox para probar tu integración.
8. Pasa a producción. Una vez que estés listo, cambia tus endpoints y tokens para utilizar la versión de producción de la API. Para ello, no olvides crear tu cuenta en ambiente de producción y obtener tus access tokens para dicho ambiente.

Preguntas Frecuentes

¿Cuánto tiempo lleva integrar la API de firma electrónica en PHP?

El tiempo de integración puede variar. Para algunos, puede ser cuestión de semanas; para otros, puede tomar más tiempo, dependiendo de la complejidad de tu sistema. La clave es tener un diseño claro de tu implementación antes de comenzar a escribir código.

¿Mifiel ofrece librerías específicas para PHP?

Sí, Mifiel ofrece una librería específica para PHP, facilitando la integración. Esta librería está disponible en nuestro repositorio de GitHub y proporciona una base sólida para empezar tu implementación. Puedes instalar rápidamente esta librería mediante Composer con el siguiente comando:

php composer.phar require mifiel/api-client

Ahora que tienes tu archivo composer.json actualizado, requerirá el archivo vendor/autoload.php para usar PSR-4 y así poder cargar automáticamente la librería.

¿Puedo personalizar el widget de firma para que se integre mejor en mi sitio web PHP?

Sí, puedes personalizar aspectos del widget como sus colores y su ubicación en tu página para que se alinee con el diseño de tu sitio web y tu marca.

En Conclusión: Maximizando Tus Procesos con la API de Mifiel Usando PHP

A lo largo de este artículo, hemos explorado detalladamente cómo integrar la API de firma digital de Mifiel en sistemas que utilizan PHP. Desde la generación de documentos en formato PDF, hasta la obtención de documentos firmados, ahora conoces a detalle el proceso para realizarlo.

Con la información y ejemplos proporcionados, tienes una base sólida para comenzar tu propia implementación. Si tienes preguntas adicionales o necesitas asistencia específica para tu caso, no dudes en contactarnos a través de nuestro chat.

The post Cómo Implementar la Firma Electrónica en PHP con la API de Mifiel appeared first on Mifiel Blog.

La parte no visible para el usuario es la API REST, la cual se usa para implementar la comunicación entre tu servidor y el nuestro.. Pero la parte visible en esta integración es el widget de Mifiel, código que se ejecuta en el navegador.

Este widget es necesario para integrar Mifiel en tu sitio. ¿Por qué?

Funcionamiento del widget de Mifiel

Primero es necesario entender un fundamento legal clave para la firma electrónica avanzada. El Artículo 97 del Código de Comercio en su fracción segunda establece que los datos sensibles de la e.firma (llave privada y su contraseña) del usuario deben estar en todo momento bajo el control exclusivo del firmante.

Cuando el usuario interactúa con un sitio web, esto implica que el proceso de firma debe ejecutarse directamente en su propio navegador.

Por ello, una mala práctica que puede llevar a la invalidación de la firma, es pedirle al usuario los archivos de su e.firma, subirlos al servidor y ejecutar el proceso de firma en el servidor. Nuestro widget no hace eso. Entonces, ¿cómo asegura que el firmante mantenga su llave privada y contraseña bajo su control?

El widget de Mifiel contiene las librerías criptográficas para ejecutar la firma en el navegador respetando los lineamientos establecidos en el Código de Comercio.

Además, el widget incluye un visualizador de PDF para que tus usuarios puedan leer el documento que van a firmar y una rutina para eliminar los datos sensibles del navegador una vez terminado el proceso de firma.

Por lo tanto, si una persona ingresa a tu sitio web que tiene el widget de Mifiel integrado, puede tener por seguro que sus datos sensibles siempre se mantienen en su computadora y que el documento que ve en pantalla es el que firmará.

Este widget tiene detrás más de cinco años de trabajo continuo y mejoras. En ese tiempo hemos logrado optimizarlo para minimizar el dropoff o abandono de los firmantes.

¿Tienes dudas sobre la integración del widget de Mifiel? Comunícate a ayuda@mifiel.com, será un gusto apoyarte.

The post Widget de Mifiel: por qué es indispensable al integrar la API de firma digital en tu sitio web appeared first on Mifiel Blog.

El cambio será automático. No tendrás que ajustar tu código ni realizar programaciones adicionales.

¿En qué consisten estos cambios?

Más personalizaciones de colores

Refleja la identidad de tu empresa con mayor control sobre las personalizaciones de colores. El widget combinará a la perfección con el aspecto y sensación de tu sitio.

Mayor contexto en mensajes de error para resolver problemas

Ahora con mensajes más informativos (que incluyen enlaces a artículos con explicaciones más detalladas) guiamos a los firmantes para que puedan resolver ellos mismos los problemas que tengan durante el proceso de firma. Reduce la carga de trabajo para tu equipo de operaciones, cierra tus contratos más rápido y mantén contentos a tus clientes.

Usabilidad puesta a prueba

9 de cada 10 firmantes* en nuestras pruebas de usabilidad firmaron exitosamente en el nuevo widget sin experimentar un solo error (en promedio les tomó 3.2 minutos completar el proceso).
*Los firmantes no tenían experiencia previa utilizando una e.firma (FIEL) ni Mifiel.

Mejor experiencia en pantallas pequeñas

¿Tu usuario utiliza un navegador de smartphone? ¿El widget no ocupa el ancho total de tu página? No sacrifiques la usabilidad.

Ahora hay una composición vertical y botones de navegación fijados en la parte superior para encontrarlos fácilmente.

Además:

• Los botones de navegación entre pasos (visualización y firma) hacen más claro el proceso.
• El nombre y características del documento se muestran a firmantes para darles mayor contexto.
• El usuario puede arrastrar y soltar los archivos de su e.firma.

Al simplificar el proceso de firma, queremos ayudar a tu organización a cerrar sus contratos con celeridad.

Ve el nuevo widget en acción:

Si tienes alguna pregunta, no dudes en contactarnos mediante el chat oprimiendo el siguiente botón.

Chatea con Mifiel

The post El nuevo widget de firmas está por llegar a nuestros usuarios API appeared first on Mifiel Blog.

En Mifiel tenemos una API REST que permite:

• Automatizar la preparación y envío de documentos a firma.
• Recibir notificaciones de eventos de firma mediante webhooks.
• Realizar búsquedas avanzadas sobre tus documentos pendientes de firma.
• Eliminar documentos.
• Integrar un widget de firma en tu sitio web.

Para resolver las dudas principales de quienes buscan una solución de firma digital con API, más allá de los conocimientos técnicos y requisitos, te mostraremos cómo se ve una implementación de API con ejemplos de código y cómo se muestra visualmente a tus firmantes al interactuar con la plataforma.

Pasos esenciales para integrar una API de firma digital

Integrar la API implica la necesidad de crear documentos y gestionar firmas. Los pasos principales para integrarla son:

1. Registra tus webhooks. Los webhooks son la forma en que tu sistema se entera de lo que pasa con tus documentos. Es una configuración que haces una sola vez por cuenta, no por documento: con una solicitud POST indicas la URL de tu servidor y el evento al que te quieres suscribir.
2. Genera tu documento. Primero tienes que generar una versión del documento que será firmado en formato PDF. Puedes ayudarte de alguna librería en tu lenguaje de programación para crear o convertir documentos a PDF. Es posible hacer uso de templates (plantillas) HTML con la API, pero esta funcionalidad no se cubrirá en este artículo (contáctanos para platicar sobre esto, puedes usar el botón en la parte inferior derecha de la página para abrir nuestro chat).
3. Envía el documento al servidor de Mifiel mediante la API. Esto se hace mediante una solicitud POST. Deberás incluir detalles como los correos electrónicos de los firmantes.
4. Presenta el flujo de firma a tu firmante. Para hacerlo dentro de tu sitio web, debes utilizar el widget de firma de Mifiel, es la parte visible de la integración de Mifiel en un sitio web, el cual se muestra como una interfaz donde los firmantes pueden revisar el contenido del documento y firmarlo. Para integrar el widget de firma en tu sitio web, debes insertar un script en tu página web el cual carga un iframe.
5. Obtén el documento firmado. Cuando recibas la notificación de que el documento se cerró, haz una llamada autenticada a GET /api/v1/documents/{id}/zip para descargar el paquete completo (XML, PDF y metadatos cuando aplique).

Creación de un documento desde la API

Vamos a suponer que quieres crear un documento con un solo firmante. Por medio de un POST le pasas al servidor de Mifiel un documento en formato PDF junto con varios parámetros. Entre estos parámetros vas a incluir el correo de cada uno de los firmantes. En este ejemplo solo será un correo.

{
  "file": "File",
  "signatories": [{
      "email": "firmante@ejemplo.com",
      "name": "Nombre de Firmante",
      "tax_id": "RFC de firmante"
  }],
  "external_id": "tu-identificador-interno"
}

La respuesta del servidor de Mifiel a tu POST va a contar con varios parámetros entre los cuales vas a ver dos números llamados widget_ids, uno para cada firmante. Si tuvieras tres firmantes obtendrías tres widget_ids, cuatro firmantes, cuatro widget_ids, etc.

{
  "id": "c914e1ed-a84d-465e-bee8-f3fadf7b7280",
  "external_id": "tu-identificador-interno",
  "original_hash": "f40243ee412ec8f297245feea8a489e7599c5e1b77bc4bf0e92bd3ed48d86b43",
  "created_at": "2022-01-17T16:34:15.065Z",
  "state": "pending",
  "file_file_name": "contrato-ejemplo.pdf",
  "file": "/api/v1/documents/c914e1ed-a84d-465e-bee8-f3fadf7b7280/file",
  "signers": [{
    "id": "dc9d63f6-11af-4840-af14-0e51e6da5da4",
    "email": "firmante@ejemplo.com",
    "name": "Nombre de Firmante",
    "tax_id": "RFC de firmante",
    "signed": false,
    "widget_id": "5suH28S3f2"
  }]
}

Debes guardar estos widget_ids ya que los vas a necesitar al implementar el widget de firma para tus firmantes de manera eficiente, de lo contrario estarías creando un nuevo documento de manera indiscriminada cada que un firmante recargue la página.

También te sugerimos enviar un external_id con tu propio identificador: lo recibirás de vuelta en las notificaciones de webhook, lo que te permite correlacionar el documento con tus registros sin necesidad de guardar el id de Mifiel.

Veamos el ejemplo en Ruby:

require 'mifiel'

document = Mifiel::Document.create(
  file: 'path/to/my-file.pdf',
  signatories: [{
    name: 'Signer 1',
    email: 'firmante@ejemplo.com',
    tax_id: 'AAA010101AAA'
  }],
  external_id: 'tu-identificador-interno'
)

Consulta el ejemplo en otros lenguajes de programación dando clic aquí.

Firma de un documento creado mediante API

Puedes implementar Mifiel de dos maneras distintas para tus firmantes: mediante mifiel.com, para que firmen ingresando directamente a nuestra plataforma, o integrando el widget de Mifiel en tu sitio web mediante la API.

Las ventajas de la firma en mifiel.com son:

• Adecuado cuando requieres que tus clientes firmen sus contratos y no puedes desarrollar una implementación propia.
• La experiencia de firma está personalizada con los colores y logo de tu marca sin necesidad de escribir ni una sola línea de código.
• La implementación de la API será más simple y ligera de realizar, pues no tendrás que preocuparte de integrar el proceso de firma en tu sitio web, solo te ocuparás de las automatizaciones.

Las ventajas del widget de Mifiel son:

• Adecuado para integrar si tu sitio web es una plataforma que tus clientes utilizan para realizar procesos con tu organización —más allá de ser un sitio informativo— y tienes un equipo de desarrollo que puede implementar y mantener integraciones de API.
• Personalización de colores, textos, tamaño del widget e información del documento.
• Integración en cualquier parte de tu página ya que el widget se implementa mediante un iframe con diseño responsive.

Firmando con el widget de Mifiel

Una vez que tu servidor creó el documento y recibiste los widget_ids, es momento de mostrar el widget a tus usuarios. Para esto tienes que incluir el snippet del widget en la página en donde quieres que se lleve a cabo la firma y pasarle el widget_id de cada usuario. Si le estás presentando el documento al usuario 1, debes pasarle el widget_id correspondiente al usuario 1. Al usuario 2 le vas a pasar el 2 y así sucesivamente.

El widget mostrará a tus usuarios el documento a firmar y les permitirá hacerlo ejecutando la criptografía de firma “browser side”. Así, sin importar que tus usuarios utilicen su e.firma o la firma con verificación biométrica de Mifiel, garantizamos la validez legal de la firma electrónica.

Durante el proceso de firma, el widget genera eventos de JavaScript que tu página puede usar para disparar acciones. Por ejemplo, si el usuario ingresa una contraseña errónea de su e.firma se generará un evento de error.

Puedes ignorar los eventos de error ya que Mifiel se encarga de mostrarle al usuario los errores, pero hay un evento que no debes ignorar: el de firma exitosa. Cuando el usuario firme exitosamente, el widget generará este evento, debes usarlo para llevar al usuario al siguiente paso dentro de tu página.

Aquí puedes ver un ejemplo del código y del widget. El código de este ejemplo apunta a sandbox.mifiel.com, nuestro servidor de pruebas. Para producción tienes que modificarlo para que apunte a mifiel.com.

Webhooks

Los webhooks de Mifiel te permiten recibir notificaciones sobre eventos relacionados con tus documentos sin necesidad de consultar la API continuamente.

La alternativa es consultar mediante la API el estado del documento cada cierto tiempo de manera manual o automática. Sin embargo, esto rápidamente se puede convertir en un problema cuando escalas: nuestro sistema limita las llamadas para consultar el estado de los documentos y bloquea la IP que excede ese límite, lo cual retrasaría tus procesos.

Registrar un webhook

Los webhooks se configuran a nivel cuenta con POST /api/v1/webhooks. Indicas la URL de tu servidor y el tipo de evento al que te suscribes:

{
  "url": "https://my-site.com/api/webhooks/mifiel",
  "callback_type": "document_closed"
}

La respuesta incluye el id del webhook, que vas a necesitar para consultarlo o eliminarlo después:

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "url": "https://my-site.com/api/webhooks/mifiel",
  "callback_type": "document_closed",
  "created_at": "2019-08-24T14:15:22Z"
}

Puedes revisar todos tus webhooks activos con GET /api/v1/webhooks y darlos de baja con DELETE /api/v1/webhooks/{id}.

Eventos disponibles

• document_closed: el documento fue firmado por todas las partes y se generó la constancia de conservación (NOM-151).
• signer_completed: cualquier participante firmó o aprobó el documento.
• signer_rejected: un participante rechazó la firma o aprobación del documento.
• document_deleted: un documento fue eliminado.

Descargar el documento firmado

document_closed es el evento que tu sistema debe usar para descargar el documento. El POST que recibes en tu servidor se ve así:

{
  "event": "document_closed",
  "data": {
    "id": "c914e1ed-a84d-465e-bee8-f3fadf7b7280",
    "external_id": "tu-identificador-interno",
    "file_file_name": "contrato-ejemplo.pdf",
    "signed_at": "2022-01-17T17:34:15.065Z"
  }
}

Con el id del documento haces una llamada autenticada a GET /api/v1/documents/{id}/zip, que te devuelve un paquete con todo lo que necesitas conservar.

Mifiel espera que tu servidor responda con un código de respuesta exitoso (2xx). En caso de que no conteste, o conteste algo diferente, se reintentará la entrega hasta 10 veces, una vez cada 10 minutos, y se detiene al recibir un 2xx.

Cuando recibes el webhook, descargas el zip y tu servidor contesta con un 200, se da por terminado el ciclo de firma de un documento.

Probar tu integración

Puedes disparar un webhook manualmente contra un recurso específico con POST /api/v1/webhooks/{id}/trigger, enviando el id del documento en resource:

{
  "resource": "02e85ee9-336f-4a83-851b-9b444359861e",
  "instant": true
}

Con instant: true el envío se hace una sola vez de forma inmediata, en lugar de encolar los 10 intentos. La respuesta incluye el status, los headers y el body que devolvió tu servidor, lo cual es útil para depurar tu endpoint:

{
  "status": "success",
  "request": {
    "url": "https://my-site.com/api/webhooks/mifiel",
    "body": { }
  },
  "response": {
    "status_code": 200,
    "headers": { },
    "body": "OK"
  }
}

Recomendaciones para una integración exitosa de API para firma electrónica

Cómo hacer búsquedas avanzadas en la API

Una API para firma digital debe permitirte realizar búsquedas avanzadas para optimizar tu implementación. En la API de Mifiel los atributos y relaciones están definidas, así que puedes hacer uso de cada uno dependiendo de tus necesidades.

Por ejemplo, puedes buscar documentos por una parte de su nombre, identificar todos los documentos que un firmante en específico necesita firmar, o identificar todos los documentos sin firmar para eliminarlos si ya no los requieres.

Elimina los documentos que se hayan quedado sin firmar

Es común que algunos documentos se queden sin firmar y ya no sea necesario firmar el documento, o que algún documento se suba con errores y necesites reemplazarlo por el documento correcto. Para tener una mejor organización, debes eliminar esos documentos en bloque mediante la API.

En este ejemplo hacemos la petición para que la API nos muestre todos los documentos pendientes creados entre el 1 de enero de 2021 y el 31 de julio de 2021, los cuales queremos eliminar. Estos documentos incluirán entre otros parámetros el id, que permitirá realizar llamadas en el endpoint correspondiente para eliminar estos documentos de manera más rápida.

{
  "version": "1.0.0",
  "resource": "document",
  "page": 1,
  "per_page": 20,
  "q": {
    "created_at": {
      "gteq": "2021-01-01",
      "lteq": "2021-07-31"
    },
    "state": {
      "eq": "pending"
    }
  },
  "sort": "created_at-desc",
  "fields": "file_file_name,created_at,state,id"
}

La respuesta de la API en nuestro ejemplo es esta:

{
  "_metadata": {
    "page": 1,
    "per_page": 20,
    "page_count": 1,
    "total_count": 10
  },
  "records": [
    {
      "id": "32214f64-f695-4691-8f6c-073681b05543",
      "file_file_name": "demo.pdf",
      "created_at": "2021-07-21T17:05:36.821Z",
      "state": "pending"
    }
  ]
}

Por lo tanto, tu request en Ruby debería verse así (da clic aquí para ver el ejemplo en otros lenguajes de programación):

require 'mifiel'

Mifiel::Document.delete('32214f64-f695-4691-8f6c-073681b05543')
Mifiel::Document.delete('1180ecb4-7478-4eaf-9267-e4349a238a7a')
# …

Preguntas frecuentes sobre la integración de API de firma electrónica de Mifiel

Antes de decidir implementar una API de firma electrónica como la de Mifiel, seguramente tienes dudas. Estas son algunas de las preguntas más frecuentes sobre nuestra API.

¿Cuánto tiempo toma integrar la API de firma electrónica?

No hay un tiempo promedio de integración, bien puede llevar unas pocas semanas o demorar varios meses. Esto se debe a que todo depende de la complejidad de tu sistema y al diseño e implementación entre tu sistema y el nuestro.

Si en el diseño de tu implementación no hay una idea clara de cómo quieres que sea la integración pero comienzas a escribir código de inmediato, tendrás que modificarlo o reescribirlo constantemente, retrasando tu implementación final.

¿Tienen librerías para la API?

Sí, contamos con librerías para PHP, Ruby, Java, Python, Node.js, y C#. Puedes obtenerlas en el repositorio de Github de Mifiel.

¿Tienen ejemplos de código?

Sí, a lo largo de toda la documentación de la API de Mifiel tenemos ejemplos de request y response en diferentes lenguajes de programación.

¿Puedo hacer modificaciones al widget para que sea congruente con mi página?

En general no puedes hacer modificaciones al widget de Mifiel ya que esto podría generar problemas que invaliden la firma electrónica o que impacten negativamente en la experiencia de los firmantes.

Pero hay algunas modificaciones que sí puedes realizar para asegurar la congruencia con el diseño de tu sitio web, como los colores de los botones, o el tamaño y ubicación del widget.

¿Puedo obtener mediante la API una copia del documento firmado?

Sí. Cuando recibas el webhook de document_closed, usa el id del documento para hacer una llamada autenticada a GET /api/v1/documents/{id}/zip.

¿Cómo comenzar a usar la API de firma electrónica de Mifiel?

Probablemente después de leer la teoría de implementación de la API de Mifiel, como buena persona dedicada a la programación ya te están entrando las ganas de pegarle al código. Para iniciar:

1. Crea una cuenta en el ambiente de pruebas (Sandbox) de Mifiel.
2. Cuando tengas una cuenta creada y confirmada, se te acreditarán 5 documentos. Contáctanos a través del chat de Mifiel o al correo ayuda@mifiel.com indicándonos tu correo de usuario para acreditarte más documentos en ambiente sandbox.
3. Genera tus Access tokens para poder autenticar tus llamadas por la API.
4. Revisa la documentación de la API en https://docs.mifiel.com/.
5. Registra tus webhooks en sandbox y pruébalos con el endpoint de disparo manual antes de escribir el resto de tu integración.
6. Opcional: Si no tienes una FIEL/e.firma a la mano puedes generar una de prueba aquí. Tienes que ingresar tus datos correctos (Nombre, RFC y CURP) ya que se valida que las estructuras del RFC y la CURP sean correctas.
7. Opcional: Instala alguna de las librerías que tenemos en https://github.com/Mifiel, actualmente tenemos librerías para PHP, Ruby, Java, Python, Javascript (Node), y C# (.NET).
8. Cuando tu código esté listo, pasar a producción es simple (requieres contar con la funcionalidad de API contratada y activa). Crea una cuenta en mifiel.com, obtén tus Access tokens, registra de nuevo tus webhooks apuntando a tu servidor de producción y asegúrate de que todos tus endpoints —incluyendo el del widget— apunten a producción en vez de a Sandbox.

Conclusión

Utilizando la API de Mifiel puedes fácilmente automatizar tu creación, búsqueda y eliminación de documentos, así como integrar la funcionalidad de firma electrónica avanzada en tu página en cuestión de días.

Además, debido a la implementación por medio de widget no es necesario que te preocupes por el manejo de las llaves privadas y contraseñas de tus usuarios.

¿Quieres preguntar sobre nuestra API?

Chatea con nosotros

The post API para firma electrónica: implementación en tu organización appeared first on Mifiel Blog.

Ante estas dos opciones, probablemente estés confundido sobre cuál elegir. Mientras usar Mifiel.com no requiere conocimientos técnicos, la API ofrece más funciones. Sin embargo, las razones para usar una u otra van más allá. Por ello, a continuación encontrarás en qué casos deberías integrar la API y en cuáles el sitio Mifiel.com es más conveniente, de acuerdo a las características de cada una y las necesidades de tu organización.

En qué casos es mejor usar la API de Mifiel

La API es una solución flexible que puedes integrar en ciertas partes del proceso (generación, flujo de firma) o todas ellas. Si tu caso es alguno de los siguientes, muy probablemente sea adecuada para ti.

Manejas un alto volumen mensual de documentos

En el sitio web de Mifiel, para subir un documento y solicitar firmas basta con arrastrarlo a la interfaz e indicar firmantes y espectadores, habiéndote registrado previamente. Hacer este proceso ocasionalmente no es muy complicado. Pero ¿si firmas cientos de documentos semanalmente?

Agrega la necesidad de borrar documentos sin firmar y otras que surgen cuando firmas diversos documentos con frecuencia, hacerlo uno por uno no es buena opción. En cambio, la API te permite hacerlo de manera automatizada.

Además, si estos documentos son muy similares entre sí y solo cambian algunos datos entre firmante y firmante —contratos, por ejemplo—, la API de Mifiel cuenta con una función para usar plantillas. Tu nos envías el documento base e indicas los campos que cambian, y cada vez que necesites firmas, nos envías esta información y el correo de firmantes y espectadores mediante la API. Cuando llega a nuestro servidor, este genera automáticamente el documento y solicita las firmas, evitándote crear y subir cada PDF.

Necesitas integrar un flujo para firmar en tu sitio web

Si tienes un sitio web como centro de interacciones con tus clientes (o planeas que así sea pronto), probablemente quieras que tus usuarios firmen documentos en un flujo que ya tengas integrado—por ejemplo, tras llenar un formulario. Esto puede lograrse mediante la API.

Un ejemplo de uso es el de financieras que otorgan crédito PyME. Imagina que tu cliente ingresa sus datos como representante de su organización y en la misma página firma la autorización de consulta de buró generada a partir de dicha información. Sin la API, tendría que llenar el formulario en una página e ir al sitio de Mifiel o esperar un correo que solicite su firma para hacerlo, lo que incluso puede retrasar las firmas.

No puedes o no quieres compartir el contenido de tus documentos con un servicio de terceros

Algunos documentos por su naturaleza legal o regulatoria, o incluso por una necesidad específica de tu organización, no deben compartirse con terceras partes. Esto se traduce en que la privacidad es tan importante que ni siquiera proveedores de servicio como Mifiel deben tener acceso al contenido de los documentos.

Integrando la API puedes firmar documentos en Mifiel sin compartirnos el documento. ¿Cómo podemos gestionar la firma de un documento sin tener acceso a este? Fácil, mediante un hash. Pero, ¿qué es un hash? Es un identificador único del documento. Se obtiene mediante un algoritmo irreversible de cifrado, convirtiendo el documento en una serie de caracteres ilegibles de longitud fija. Entonces, sin importar que los datos de entrada sean unas líneas o todo un contrato, se obtiene una huella digital irrepetible.

Además, recordemos que una firma electrónica avanzada consiste en cifrar el hash de un documento utilizando una llave privada (archivo .key de la FIEL/e.firma) ligada a un certificado (archivo .cer) emitido por un prestador de servicios de certificación. Estrictamente hablando, lo único que se necesita para firmar un documento es el hash.

Usando la API de Mifiel, al tener todo el flujo de firma integrado en tu propio sitio web, podrás mostrar el documento a tus firmantes sin que nos lo envíes. Tu servidor solo nos comparte el hash y nosotros te regresamos el XML con las firmas listo para que tú le agregues el documento.

Tus usuarios necesitan firmar un alto número de documentos a la vez

En ocasiones, el volumen de documentos a firmar es factor para integrar la API no solo desde la perspectiva de los solicitantes de las firmas, sino también de los firmantes como tus clientes o tus empleados. En situaciones que requieren firmar varios documentos en una sola sesión, utilizar la API es la única opción que lo facilita.

De esta manera, en lugar de solicitar que el usuario ingrese su FIEL (.cer y .key) y la contraseña de la misma por cada documento, solo debe hacerlo una vez, revisar los documentos y firmar con un solo clic siempre que se trate de la misma sesión. Destacamos dos situaciones en las que esto es de gran utilidad.

La primera es con los representantes legales. Es común que con documentos en papel, en lugar de firmar cada uno conforme esté listo, se junten varios y tu representante tenga una sesión periódica para firmarlos todos antes de integrarlos a los expedientes. Con la solución desde el sitio web Mifiel esto sería sumamente engorroso, por lo que es recomendable integrar la API.

Otra situación es cuando tus clientes deben firmar varios documentos como parte de un proceso. Permitirles hacerlo en una sesión ingresando la e.firma una sola vez, se traducirá en un ahorro de tiempo y reducirá confusiones.

Para quién no es adecuada la API de Mifiel

Aunque la API de firma electrónica de Mifiel tiene grandes ventajas al permitir automatizar los flujos de creación, firma y solicitud de firmantes —parcial o totalmente—, no es ideal para todos. Si tu negocio no tiene un sitio web —o el que tiene no es una plataforma para clientes sino informativo—, integrar la API no es recomendable, ya que hacerlo requeriría desarrollar un sitio web con las funciones para ello.

La excepción serían startups que planean ofrecer sus servicios digitalmente, o empresas que tienen contemplado un proyecto de digitalización en el corto plazo. De lo contrario, la inversión de contratar a un equipo técnico (o los servicios de terceros para el desarrollo y mantenimiento) no estaría justificada y la relación costo-beneficio sería poco favorecedora.

Por lo tanto, si reconoces el valor que agregaría a tu empresa firmar documentos electrónicamente con la FIEL pero no entras en ninguno de los casos en que recomendamos integrar la API, lo mejor es no considerarla y comenzar a usar la solución de Mifiel.com lo cual puedes hacer inmediatamente.

Con nuestro sitio web y la función de white-label, tus usuarios tendrán una experiencia de firma con el look and feel de tu marca, tanto en nuestro sitio como en los correos electrónicos de notificación, así que no notarán que interactúan con un servicio de terceros. De cualquier forma, podrás migrar al uso de la API cuando lo requieras.

¿Quieres conocer más sobre la API y la solución de Mifiel.com? Comunícate con nosotros.

Contacta a Mifiel

The post Integración API de Mifiel, ¿es adecuada para mi organización? appeared first on Mifiel Blog.