Suivre les bonnes pratiques d'intégration permet d'améliorer la fiabilité, de réduire les erreurs évitables et d'accélérer les investigations du support lors de l'utilisation des API DQE.
Utiliser le bon environnement
Assurez-vous que chaque intégration utilise le bon endpoint, les bons identifiants, la bonne licence et le bon environnement. Évitez de mélanger des identifiants de production avec des environnements de test ou de staging.
Valider les données en entrée avant d'envoyer les requêtes
Nettoyez et formatez les données en entrée avant d'appeler les API DQE. Supprimez les espaces inutiles, les caractères cachés, les valeurs incomplètes et les commentaires internes qui ne font pas partie des données à valider.
Gérer explicitement les réponses de l'API
Concevez votre intégration pour gérer séparément les réponses réussies, les requêtes rejetées, les cas sans résultat, les timeouts et les erreurs inattendues. Évitez de traiter toutes les réponses non réussies comme un seul et même problème.
Mettre en place un comportement de nouvelle tentative sécurisé
Utilisez des tentatives contrôlées pour les échecs temporaires. Évitez les boucles de nouvelle tentative agressives, en particulier dans les workflows de production, car elles peuvent augmenter le trafic et rendre les incidents plus difficiles à investiguer.
Journaliser un contexte technique utile
Conservez des journaux incluant les horodatages des requêtes, les noms des endpoints, le statut de la réponse, les messages d'erreur et les identifiants de corrélation si disponibles. Ne journalisez pas les identifiants, jetons ou données personnelles sensibles en clair.
Surveiller le comportement en production
Suivez les taux d'erreur, les temps de réponse, la fréquence des timeouts et les changements inhabituels dans les taux d'absence de résultat. La surveillance permet d'identifier les problèmes d'intégration ou de qualité des données avant qu'ils n'affectent un grand nombre d'utilisateurs.
Quand contacter le support DQE
Si vous avez besoin d'aide pour investiguer un comportement de l'API, indiquez le service appelé, l'environnement, l'endpoint, l'horodatage de la requête, les détails de la réponse, les changements récents et des exemples de requêtes dont les données sensibles ont été supprimées.