Séparer la configuration du code
Conservez l'adresse et les informations d'identification de l'API en dehors du code source. Utilisez des variables d'environnement de serveur et ne publiez jamais de vraie clé dans un bundle de navigateur. Cette intégration de démonstration utilise uniquement des exemples de données.
Définir le contrat avant de vous connecter
Convenez avec l'équipe API des champs de tâches, des états possibles et des formats d'erreur. Un contrat partagé réduit les retouches et évite les comportements implicites entre le tableau de bord et le service.
Planifier le cycle de vie de la demande
Définissez des délais d'attente pour la création de tâches et la récupération des résultats. Pour le traitement asynchrone, interrogez à des intervalles définis avec une limite de nouvelles tentatives. La candidature doit explicitement cesser d’attendre à l’expiration du délai.
Traitez les erreurs comme faisant partie du produit
Des identifiants invalides, un solde insuffisant et des pannes nécessitent des réponses spécifiques. Affichez les messages utiles et enregistrez uniquement les informations requises pour le diagnostic, sans informations d'identification ni jetons de solution.
Vérifier avant la sortie
Testez les erreurs d’authentification, les limites d’utilisation et les réponses inattendues lors de la préparation. Cette documentation propose une organisation des points finaux ; le service réel sera connecté une fois ce contrat défini.
Explorez votre prochain flux de travail.
Découvrez l’expérience du tableau de bord de démonstration.
Ouvrir le tableau de bord
