Décrire l'échange
Pour chaque opération, documentez la méthode, la ressource, les champs requis et la forme d'une réponse réussie. Incluez une erreur de validation. Distinguez un échec de transport d'une requête rejetée : une réponse manquante ne prouve pas qu'une opération modifiant l'état a échoué.
Traitez les identifiants comme une configuration
Gardez les identifiants serveur en dehors des bundles de navigateur et des dépôts sources. Demandez l'ensemble de permissions utile le plus petit et séparez l'accès au développement de l'accès à la production. Enregistrez qui possède chaque intégration et comment l'accès peut être révoqué. Suivez le flux d'autorisation documenté par le fournisseur.
Préparez-vous à des dépendances indisponibles
Définissez des délais d'attente, respectez les directives sur la limitation du débit et réessayez uniquement lorsqu'une opération peut être répétée en toute sécurité. Là où c'est supporté, une clé d'idempotence peut identifier les requêtes répétées. Enregistrez un identifiant de requête et une catégorie de défaillance concise ; évitez les en-têtes d'autorisation, les cookies de session et les données personnelles.