API y webhooks
API y webhooks para que la base hable con tus sistemas
Con la API de DeepMiner, tus sistemas envían registros en JSON a un índice, autenticados con el token de inicio de sesión, y la importación aparece en el historial con el origen API. Cada usuario también genera claves de API para la API de integración. En sentido contrario, cada proveedor configurado recibe su propia URL de webhook: los eventos de estado llegan por ella, encuentran el registro correspondiente y actualizan el estado, con el historial de los últimos eventos en cada registro.
Lo que puedes hacer
Importación por API, clave de API por usuario para la integración y webhook de retorno por proveedor.
-
Clave de API por usuario
Cada usuario genera sus propias claves en la pantalla Clave de API para usarlas en la API de integración. La clave lleva el partner del usuario, de modo que la integración solo ve los datos de ese partner.
-
Importación por API
Con el token de inicio de sesión, envía una lista de registros en JSON a un índice. Siguen el esquema, el campo clave evita duplicados y el progreso aparece igual que el de un archivo.
-
Una URL de webhook por proveedor
La URL se crea con un token aleatorio y se muestra una sola vez. DeepMiner guarda solo una firma del token, y regenerarlo invalida la URL anterior.
-
Retorno en el registro correcto
Cada evento se asocia con el registro de origen. El estado del canal, la fecha de la actualización y los campos del evento definidos para ese tipo de proveedor entran en el registro, y el evento pasa al historial.
-
Registro de cada evento
El log de webhooks muestra cada evento recibido como procesado, duplicado, sin correspondencia o con fallo, con el payload para poder revisarlo.
Entrada: registros por API
Cuando la base nace en otro sistema, la API evita la exportación manual. El sistema se autentica con el token de inicio de sesión de un usuario, envía los registros en JSON al índice y la importación sigue el mismo camino que un archivo: validación por esquema, actualización por campo clave y progreso visible. En el Historial de importación, el origen aparece como API.
La clave de API, que genera cada usuario en la pantalla Clave de API, es la credencial de la API de integración y lleva el partner del usuario. Los datos de un partner nunca aparecen en otro, ni por la API ni por la interfaz.
Salida: el retorno de cada envío
Cuando configuras un proveedor, DeepMiner genera su URL de webhook y te la muestra una vez para que la copies y la pegues en el panel del proveedor. Después, el token ya no se muestra. Si necesitas cambiarlo, Regenerar token crea otro y la URL anterior deja de funcionar.
Cada evento que llega se deja en una cola y se procesa a continuación. DeepMiner comprueba que el proveedor sigue activo, encuentra el registro por la referencia del envío o por el identificador del mensaje y actualiza el estado del canal. El historial del registro guarda los últimos eventos, y los eventos repetidos no se aplican dos veces.
Qué cambia en la operación
Con el retorno dentro del registro, el estado de cada envío aparece en la lista de registros del índice y en el historial Eventos de los proveedores. Ya no hace falta la hoja de retorno exportada del panel del proveedor para comprobar quién ha recibido el mensaje.
Preguntas frecuentes
API y webhooks
¿Cómo me autentico en la API?
La importación por API usa el token de inicio de sesión del usuario. La clave de API, generada en la pantalla Clave de API, sirve para la API de integración. Ambas pertenecen a un usuario y quedan limitadas a su partner.
¿El webhook responde rápido al proveedor?
Sí. La recepción solo comprueba el token y deja el evento en una cola. El procesamiento ocurre a continuación, fuera de la petición del proveedor.
¿Y si el proveedor envía el mismo evento dos veces?
DeepMiner reconoce el evento repetido y lo registra como duplicado, sin aplicar de nuevo la misma actualización.
¿Un partner puede ver los datos de otro por la API?
No. La plataforma es multi-tenant y cada llamada queda limitada al partner del usuario.
¿Dónde veo los eventos de un registro?
En el detalle del registro, en la sección Eventos de los proveedores, con el estado y el payload de cada evento.
Mira DeepMiner trabajando sobre tu base.
Solicita una demostración y sigue cómo una base se indexa, se enriquece y se consulta.