Préambule
Cette évolution enrichit les projets API en diffusion. Activer le Temps Réel se fait facilement et sans surcoût sur votre abonnement Apidae, mais peut engendrer des frais annexes de la part de vos prestataires de services pour adapter leurs process d'utilisations.
Le principe
Pour les projets exploitant les API, Apidae a mis en place un nouveau paramétrage : le « Temps Réel ».
Il permet :
- D’être alerté tout de suite de la modification d’un objet touristique faisant partie des sélections du projet.
- De mieux solliciter nos APIs pour des appels pertinents.
Fonctionnement
L'objectif du temps réel est de communiquer instantanément les dernières mises à jour vers vos sites de diffusion. Il est toutefois important de noter les 2 cas de figure suivants :
- la modification d'une fiche déjà présente dans mon projet : la communication est immédiate vers les sites configurés en Temps Réel,
- la modification d'une fiche la faisant rentrer ou sortir du périmètre de mon projet : la communication est faite immédiatement après le calcul nocturne des sélections.
Modification d’une fiche
Le Temps Réel a besoin d’un webhook sur lequel il pourra notifier de la modification d’une fiche ou d’une modification d’une sélection. Le process est simple :
- Une fiche est modifiée par le propriétaire de la donnée dans le SIT,
- Un calcul a lieu pour identifier les projets concernés par cette fiche,
- Une notification est envoyée sur le webhook renseigné dans ces projets, avec l’ID de la fiche concernée par la modification ainsi que le type de mise à jour (modification / création / suppression),
- Les systèmes notifiés appellent alors nos APIs en ciblant la fiche modifiée et récupèrent les informations souhaitées.
NB : dans le cas d’une suppression de fiche ou de sélection, il n’est pas nécessaire d’appeler la fiche en question.
Modification des sélections d'un projet ou de leur périmètre :
Dans le cas d’une modification des sélections du projet (ajout ou suppression de sélection), le fonctionnement est quasi identique :
- La modification est faite via l’interface de gestion de projet SIT,
- Pour une suppression, un message est immédiatement envoyé au webhook du projet concerné. Pour un ajout de sélection, au moment du recalcul nocturne, un message est envoyé au webhook du projet concerné. Dans les deux cas, sont communiqués l’ID de la sélection, le type de modification ainsi que celui du projet.
- Le système notifié peut alors mettre à jour ses informations : supprimer les sélections
Pour l’ajout ou le retrait de fiches d’une sélection déjà présente dans le projet, le principe est le même :
- Les sélections sont recalculées chaque nuit,
- Si l’on détecte des ajouts/retraits de fiches, un message est envoyé au webhook dès la fin des recalculs. Il contient alors l’ensemble des IDs des fiches ajoutées/retirées pour chaque sélection, ainsi que le type d’opération.
NB : Pour les gros ajouts/retraits de fiches, une limite de 200 IDs par notification au webhook a été mise en place afin de garder des messages de taille raisonnable.
Si 750 fiches sont ajoutées à une sélection, 3 messages de 200 IDs + 1 message de 150 IDs seront alors envoyés sur le webhook. - Le système notifié peut alors récupérer les nouvelles fiches, ou retirer les IDs de son référentiel.
Contactez votre agence Web pour bénéficier, vous aussi, de ce nouvel outil sur vos projets !
Paramétrage
Lors du paramétrage d’un projet en API, il est désormais possible d’activer le temps réel dans « configuration technique » :
Cocher la case « Temps réel » permet d’afficher le champ « Webhook ». Dans ce champ, indiquer l’URL à notifier pour les modifications.
Pour plus de précisions techniques, nous vous invitons à lire l'article sur notre site d'aide aux développeurs : Page technique "Temps réel"
Commentaires
0 commentaire
Vous devez vous connecter pour laisser un commentaire.