Integraciones
Conectar la plataforma con tus sistemas
API, webhooks y almacenamiento externo: qué elegir según lo que quieras automatizar.
Hay tres formas de conectar la plataforma con lo que ya tienes, y se eligen según la dirección en la que quieras que vayan los datos. Confundirlas es el motivo habitual de que una integración acabe consultando cada cinco minutos algo que podría haberle llegado solo.
Cuál usar
| Quieres | Usa | Ejemplo |
|---|---|---|
| Crear algo desde tu sistema | API | El ERP da de alta un proveedor y lanza el proceso de documentación |
| Enterarte de que algo pasó | Webhook | Avisar a tu sistema cuando un contrato queda firmado |
| Tener los archivos también en tu repositorio | Almacenamiento externo | Que todo lo certificado aparezca en vuestra carpeta corporativa |
| Consultar de vez en cuando | API | Un informe mensual que lee el estado de los expedientes |
Claves de API
Se crean desde los ajustes de la organización, con los permisos que necesite esa integración y no más. Una clave que solo tiene que certificar documentos no debería poder borrar contactos. Y conviene una clave por integración, para poder revocar una sin romper las demás.
Importante
Una clave de API da acceso a los datos de tu organización. No debe acabar en un repositorio de código, en un correo ni en un mensaje. Si sospechas que una se ha expuesto, revócala: crear otra cuesta un minuto.
Webhooks
Tú das una URL y la plataforma te avisa cuando ocurre lo que hayas suscrito. Lo importante al montarlo es que tu extremo responda rápido y aguante recibir el mismo aviso dos veces: en cualquier sistema de entrega puede haber un reintento, y procesarlo dos veces no debería duplicar nada de tu lado.
Preguntas frecuentes
›¿Dónde está la documentación de la API?
En la página pública de documentación de API, con los endpoints y sus parámetros. Este artículo es la vista de conjunto; allí está el detalle.
›¿Puedo certificar automáticamente desde mi ERP?
Sí, y es uno de los usos más frecuentes: cada factura o cada registro se certifica en el momento de generarse, sin que nadie tenga que acordarse.
›¿Qué pasa si mi endpoint está caído cuando salta un webhook?
Se reintenta. Por eso conviene que tu extremo tolere recibir el mismo aviso más de una vez.
›¿La integración con almacenamiento externo mueve o copia?
Replica: los documentos siguen en la plataforma con su trazabilidad y además aparecen en vuestro repositorio.
Un caso real
La situación
Una empresa quiere que cada factura emitida por su ERP quede certificada sin intervención humana.
Qué haces
- Crea una clave de API con permiso solo de certificar
- El ERP llama a la API en el momento de emitir la factura
- Suscribe un webhook para registrar en el ERP el identificador de la evidencia
Qué consigues
Cada factura queda con fecha demostrable desde el segundo en que existe, y nadie tiene que acordarse de nada.
La situación
Una constructora da de alta ochenta subcontratas al año en su ERP y alguien vuelve a teclear los mismos datos aquí.
Qué haces
- El ERP llama a la API en cuanto se crea la subcontrata
- El proceso de documentación se lanza solo con esos datos
- El ERP recibe un aviso cuando el expediente se completa
Qué consigues
Se elimina el doble tecleo de ochenta altas y el ERP sabe quién puede entrar a obra sin que nadie se lo diga.
La situación
El equipo de compras consulta dos pantallas para saber si un proveedor está al día.
Qué haces
- Lleva el estado del expediente al sistema donde se aprueba el pedido
- Actualiza ese estado cada vez que cambia aquí
Qué consigues
La aprobación del pedido se decide en la pantalla donde ya se estaba trabajando.
La situación
Se integra todo de golpe y a los dos meses nadie sabe qué hace cada conexión.
Qué haces
- Integra primero el flujo que más se repite
- Documenta qué dispara qué antes de añadir el segundo
Qué consigues
La segunda integración se monta sobre algo entendido en lugar de sobre una caja negra.
La situación
El ERP manda datos incompletos y se crean expedientes a medias.
Qué haces
- Valida los campos obligatorios antes de crear nada
- Devuelve el error a quien lo generó en lugar de crear el expediente
Qué consigues
Los expedientes que existen están completos, y el error se corrige en el sistema donde nació.
La situación
Nadie sabe si la integración sigue funcionando hasta que falta un expediente.
Qué haces
- Revisa el registro de llamadas cada semana
- Configura un aviso si deja de llegar actividad
Qué consigues
El corte se detecta en horas y no cuando alguien echa algo en falta.
Este artículo responde a
- api de code contract
- integrar con mi erp
- webhooks para recibir avisos de la plataforma
- sincronizar documentos con sharepoint
- crear una clave de api