Suivi synchrone et asynchrone
Safecube propose deux façons d'obtenir les données de suivi de conteneurs : la Container Tracking API, une API synchrone où votre application demande les données, et la Webhooks API, une API asynchrone où Safecube envoie les données à votre application. Le bon choix dépend de votre cas d'usage, de votre volume de trafic et de vos exigences de temps de réponse.
Container Tracking API : pull synchrone
Avec une API synchrone, le client envoie une requête et attend que le serveur la traite et réponde avant de continuer. C'est un mécanisme pull : le client tire l'information du serveur à la demande.
Fonctionnement de la Container Tracking API
- Votre application demande à la Container Tracking API les données d'une expédition précise.
- Le serveur traite la requête et renvoie les données au plus vite.
- Votre application attend la réponse avant son action suivante.
Quand la Container Tracking API convient
- Testeurs et petits utilisateurs : trafic faible, ou vérification occasionnelle du statut des conteneurs.
- Requêtes simples : des données précises et à jour, nécessaires à la demande.
Atouts et limites de la Container Tracking API
Atouts :
- Réponse immédiate : les données reviennent dès que la requête est traitée.
- Simple à mettre en œuvre : adaptée aux applications peu complexes.
- Adaptée aux faibles charges : fonctionne bien tant que le nombre de requêtes reste raisonnable et que des temps de réponse plus longs sont acceptables.
Limites :
- Temps de réponse longs : avec beaucoup de requêtes ou de gros volumes de données, les temps de réponse s'allongent et ralentissent tout le processus.
- Le polling est à la charge du client : pour obtenir les mises à jour, votre application doit envoyer des requêtes en continu pour vérifier si de nouvelles données existent.
Webhooks API : push asynchrone
Avec une API asynchrone, le serveur envoie l'information au client quand un événement se produit. C'est un modèle push : le client n'interroge pas le serveur ; le serveur pousse les nouvelles données vers le client dès qu'elles sont disponibles.
Fonctionnement de la Webhooks API
- Votre application expose un endpoint qui reçoit les mises à jour de la Webhooks API.
- Quand un événement précis se produit, comme un changement de statut d'un conteneur ou un retard d'expédition, Safecube pousse les données correspondantes vers cet endpoint.
- Votre application traite les données de façon asynchrone, sans les demander.
Quand la Webhooks API convient
- Fortes charges : gros utilisateurs ou systèmes à fort trafic, qu'un polling constant d'une API synchrone ralentirait.
- Temps de réponse longs : quand la Container Tracking API répond lentement pour votre application, la Webhooks API supprime l'attente.
- Indisponibilité des compagnies maritimes : quand les compagnies que vous suivez connaissent souvent des perturbations, la Webhooks API envoie des données à jour dès que la connexion revient à la normale.
- Fonctionnalités avancées : la Webhooks API détecte et notifie aussi les retards des expéditions de conteneurs, sans polling manuel.
Atouts et limites de la Webhooks API
Atouts :
- Moins de charge côté client et côté serveur : les mises à jour ne sont poussées que quand c'est nécessaire, ce qui supprime le coût d'un polling continu.
- Gros volumes traités efficacement : adaptée aux applications à fort trafic et aux utilisateurs qui ont besoin de mises à jour fréquentes.
- Notifications automatiques d'events : votre application est prévenue des événements importants, comme les retards.
Limites :
- Configuration plus complexe : plus de mise en place qu'un simple modèle requête-réponse.
- Piloté par les événements : les données ne sont envoyées que quand des événements se produisent, ce qui ne convient pas aux cas qui demandent un accès immédiat à des données sans lien avec un événement.
Quelle API choisir
Choisissez la Container Tracking API (synchrone) quand :
- vous êtes un testeur ou un petit utilisateur, avec relativement peu de requêtes à l'API ;
- vous avez besoin des données à la demande et pouvez attendre la réponse ;
- votre trafic est faible et vous n'attendez aucun problème de performance lié à la charge.
Choisissez la Webhooks API (asynchrone) quand :
- la Container Tracking API répond lentement pour votre application ;
- vous traitez de gros volumes de données ou des requêtes fréquentes qui pourraient saturer une API synchrone ;
- vous avez besoin de notifications automatiques d'events, comme les retards d'expédition ;
- votre application a besoin de plus d'efficacité et d'une charge serveur plus faible.
Pour les applications plus importantes, soucieuses de performance, Safecube recommande de passer à la Webhooks API pour réduire le coût et améliorer la réactivité. La page Premiers pas avec les webhooks montre comment la configurer.