Notre système de Webhooks va vous permettre de recevoir en direct des données qui vous seront utiles dans vos solutions.
Vous réceptionnerez ces données au format JSON, sous forme de requêtes HTTP POST qui seront envoyées par nos serveurs à une URL spécifique de votre Système.
Nos serveurs envoient des requêtes HTTP POST vers des URL spécifiques de votre système. Ces requêtes contiennent des données au format JSON.
Voici une liste de ressources qui vont vous expliquer comment s’abonner à notre système de Webhooks et vous indiquer comment implémenter la réception de nos données envoyées par nos Webhooks à vos solutions.
Vous avez 2 moyens de vous abonner aux Webhooks.
Dans les 2 cas, au préalable, vous devez disposer d’un Espace Développeur et être connecté.
Par exemple, dans la page du Webhook « New IMA Direct account ».
Cliquez sur bouton « S’ABONNER« , vous verrez alors apparaître 2 formulaires.
Le premier vous permettra de créer une nouvelle App et de l’abonner à ce Webhook, le second vous permettra d’abonner une de vos App existante à ce Webhook.
Par exemple, dans la page de l’API Geotracking.
Lorsque vous souhaitez utiliser cette API, vous allez pouvoir faire une demande d’ajout à l’aide du bouton « AJOUTER L’API« .
Dans les formulaires qui vont apparaître, vous verrez la liste des Webhooks qui sont associés à cette API. Vous pourrez alors cocher ceux auxquels vous souhaitez vous abonner en plus de l’API.
Dans tous les formulaires d’abonnement ci-dessus, vous saisirez les informations de configuration dont nous avons besoin pour procéder à l’abonnement.
Enfin, sachez que notre process d’abonnement prend de 24h à quelques jours si vous n’avez encore jamais utilisé nos services.
Afin de pouvoir vous abonner, nous avons besoin que vous nous communiquiez l’URL de votre système à laquelle nous enverrons les données sous forme de requêtes HTTP.
Vous devrez saisir cette URL dans le champ « Votre URL » du formulaire d’abonnement :
Cette URL doit respecter le fonctionnement décrit ici.
Si vous souhaitez que lorsque nous vous envoyons ces requêtes, nous y ajoutions des headers particuliers (par exemple, un header API Key), vous devrez également nous communiquer le nom et la valeur attendue pour chacun de ces headers.
Le cas échéant, vous devrez saisir ces headers dans les champs « Nom du header » et « Valeur du header » du formulaire d’abonnement :
Nous devons pouvoir envoyer des requêtes HTTP POST à l’URL que vous nous aurez communiquée.
Nous vous enverrons les données au format JSON.
En réponse à cette requête HTTP POST, vous devez nous répondre avec un code HTTP 20x (200, 201, 204, etc.).
Pour des raisons de sécurité, votre URL doit être accessible en https.
Nous pouvons également ajouter des headers spécifiques dans les requêtes que nous envoyons à votre Système (API Key par exemple). Le cas échéant, il faudra nous les communiquer.
Si vous souhaitez modifier des informations que vous nous avez communiquées lors de votre abonnement, vous devez utiliser notre formulaire de Support pour en faire la demande.
Vous pourrez préciser les informations à modifier dans le champ « Votre demande« .
Si vous souhaitez vous désabonner d’un Webhook et ne plus recevoir les informations qui s’y rattachent, vous devez utiliser notre formulaire de Support pour en faire la demande.
Vous pourrez préciser le Webhook à désabonner dans le champ « Votre demande« .
Si vous souhaitez récupérer des informations que vous n’avez pas pu réceptionner, vous devez utiliser notre formulaire de Support pour en faire la demande.
Vous pourrez préciser les Webhooks et la plage horaire à récupérer dans le champ « Votre demande« .
Notre système de Webhook détecte les requêtes envoyées qui finiraient en erreur (dont le code HTTP de réponse est autre qu’un code 20x).
Les informations envoyées dans ces requêtes sont conservées dans notre système. Ce qui nous permet de les récupérer à la demande.
© 2024 Inter Mutuelles Assistance
