Lors de l'ouverture d'un ticket de support pour un problème d'API, fournir les bons éléments techniques aide le support DQE à reproduire le comportement, identifier le service concerné et investiguer plus rapidement.
Contexte requis
- le nom de votre organisation ;
- le service ou l'API DQE concerné ;
- l'environnement utilisé, tel que production, staging, test ou sandbox ;
- l'endpoint et la méthode HTTP ;
- la date et l'heure de la requête, avec le fuseau horaire ;
- l'impact métier du problème.
Détails de la requête et de la réponse
Incluez un exemple complet chaque fois que possible. Supprimez ou masquez les informations sensibles telles que les identifiants, jetons, licences et données personnelles avant de les partager dans un ticket.
- paramètres ou corps de la requête ;
- en-têtes utilisés, avec les valeurs sensibles masquées ;
- corps de la réponse ;
- code de statut HTTP si disponible ;
- message d'erreur renvoyé par l'API ;
- identifiant de corrélation ou identifiant de requête si disponible.
Comportement attendu
Expliquez le résultat que vous attendiez et pourquoi. Si le problème concerne des résultats d'adresse, d'email, de téléphone ou de géocodage, incluez la validation ou le résultat de réponse attendu.
Changements récents
Mentionnez tout changement récent susceptible d'avoir affecté l'intégration, tel qu'un déploiement, une mise à jour réseau, un changement d'identifiants, un changement d'endpoint, un nouvel environnement ou une mise à jour de configuration.
Articles associés
- Comment résoudre les problèmes d'authentification de l'API
- Pourquoi ma requête API est-elle rejetée ?
- Pourquoi l'API ne renvoie-t-elle aucun résultat ?