API et webhooks
API et webhooks pour que la base parle à vos systèmes
Avec l’API de DeepMiner, vos systèmes envoient des enregistrements JSON vers un index, authentifiés par le token de connexion, et l’import apparaît dans l’historique avec l’origine API. Chaque utilisateur génère aussi des clés d’API pour l’API d’intégration. Dans l’autre sens, chaque fournisseur configuré reçoit sa propre URL de webhook : les événements de statut arrivent par elle, retrouvent l’enregistrement correspondant et mettent à jour le statut, avec l’historique des derniers événements.
Ce que vous faites
Import par l’API, clé d’API par utilisateur pour l’intégration et webhook de retour par fournisseur.
-
Une clé d’API par utilisateur
Chaque utilisateur génère ses clés dans l’écran Clé d’API pour s’en servir sur l’API d’intégration. La clé porte le partenaire de l’utilisateur : l’intégration ne voit donc que les données de ce partenaire.
-
Import par API
Avec le token de connexion, envoyez une liste d’enregistrements JSON vers un index. Ils suivent le schéma, le champ clé évite les doublons et l’avancement s’affiche comme pour un fichier.
-
Une URL de webhook par fournisseur
L’URL est créée avec un token aléatoire et affichée une seule fois. DeepMiner ne garde qu’une signature du token, et la régénération invalide l’URL précédente.
-
Le retour dans le bon enregistrement
Chaque événement est rattaché à l’enregistrement d’origine. Le statut du canal, la date de mise à jour et les champs d’événement définis pour ce type de fournisseur entrent dans l’enregistrement, et l’événement part dans l’historique.
-
Un journal de chaque événement
Le journal des webhooks affiche chaque événement reçu comme traité, doublon, sans correspondance ou en échec, avec le payload pour vérification.
En entrée : des enregistrements par l’API
Quand la base naît dans un autre système, l’API évite l’export manuel. Le système s’authentifie avec le token de connexion d’un utilisateur, envoie les enregistrements JSON vers l’index et l’import suit le même chemin qu’un fichier : validation par le schéma, mise à jour par le champ clé et avancement suivi. Dans l’Historique d’import, l’origine apparaît comme API.
La clé d’API, générée par chaque utilisateur dans l’écran Clé d’API, est l’identifiant de l’API d’intégration et porte le partenaire de l’utilisateur. Les données d’un partenaire n’apparaissent jamais chez un autre, ni par l’API ni par l’interface.
En sortie : le retour de chaque envoi
Quand vous configurez un fournisseur, DeepMiner génère son URL de webhook et l’affiche une fois, pour que vous la copiiez dans le portail du fournisseur. Ensuite, le token n’apparaît plus. S’il faut en changer, Régénérer le token en crée un autre et l’URL précédente cesse de fonctionner.
Chaque événement reçu est placé dans une file et traité aussitôt après. DeepMiner vérifie que le fournisseur est toujours actif, retrouve l’enregistrement grâce à la référence de l’envoi ou à l’identifiant du message et met à jour le statut du canal. L’historique de l’enregistrement garde les derniers événements, et les événements répétés ne sont pas appliqués deux fois.
Ce que cela change dans l’exploitation
Avec le retour dans l’enregistrement, le statut de chaque envoi apparaît dans la liste des enregistrements de l’index et dans l’historique Événements des fournisseurs. Le fichier de retour exporté depuis le portail du fournisseur n’est plus nécessaire pour savoir qui a reçu.
Questions fréquentes
API et webhooks
Comment m’authentifier auprès de l’API ?
L’import par API utilise le token de connexion de l’utilisateur. La clé d’API, générée dans l’écran Clé d’API, sert à l’API d’intégration. Les deux appartiennent à un utilisateur et restent limitées à son partenaire.
Le webhook répond-il vite au fournisseur ?
Oui. La réception se contente de vérifier le token et de placer l’événement dans une file. Le traitement a lieu ensuite, en dehors de la requête du fournisseur.
Et si le fournisseur envoie deux fois le même événement ?
DeepMiner reconnaît l’événement répété et le consigne comme doublon, sans appliquer deux fois la même mise à jour.
Un partenaire peut-il voir les données d’un autre via l’API ?
Non. La plateforme est multi-tenant et chaque appel reste limité au partenaire de l’utilisateur.
Où voir les événements d’un enregistrement ?
Dans le détail de l’enregistrement, section Événements des fournisseurs, avec le statut et le payload de chaque événement.
Voyez DeepMiner travailler sur votre base.
Planifiez une démonstration et regardez une base être indexée, enrichie et interrogée.