Bonnes pratiques : gestion des erreurs

La plateforme Workflows peut afficher toute erreur émise par une API à l'utilisateur d'un connecteur.

La fonction Si erreur (Essayer/Collecter) peut être limitée à des circonstances particulières, comme la gestion des messages dans le flux _authping d'un connecteur. Toutefois, il existe quelques bonnes pratiques en matière de gestion des erreurs lors de la conception de cartes pour un connecteur.

Gestion des entrées obligatoires

Lorsque vous créez des entrées pour un connecteur, la boîte de dialogue Entrées vous permet de marquer des champs comme étant obligatoires. La définition d'un champ comme obligatoire signifie que les utilisateurs d'une carte de connecteur doivent soit saisir une valeur dans ce champ, soit faire glisser un résultat depuis une autre carte.

Étant donné que les utilisateurs peuvent glisser-déposer des champs de sortie pour satisfaire la validation frontale de la carte, rien ne garantit que le champ de sortie contienne une valeur réelle lors de l'exécution du flux. Par conséquent, il est recommandé aux développeurs de connecteurs de vérifier que les valeurs requises existent avant d'appeler une API. Cela empêche la plateforme d'envoyer des requêtes incorrectes connues à l'API et protège également les limites d'API de l'utilisateur.

Valider les champs obligatoires

La façon la plus simple de valider les champs obligatoires est d'utiliser la carte Renvoyer une erreur si avec un message d'erreur de la forme suivante : No <Input Name> input provided. Enter a valid <Input Name>.

Veillez à inclure un code de statut 400 avec le message. Un code de statut de réponse 400 Bad Request indique que le serveur ne peut pas traiter la requête en raison d'un élément qu'il perçoit comme une erreur du client. Par exemple, en cas de syntaxe de requête mal formée, d'encadrement de message de requête non valide ou de routage de requête trompeur.

Exemple

  1. Ajoutez une carte de fonction Renvoyer une erreur siaprès votre carte (d'événement) Action de connecteur.

  2. Faites glisser l'entrée requise dans le champ valeur a de la carte Renvoyer une erreur si et définissez la comparaison sur is empty.

  3. Dans le champ message, saisissez No <Input Name> input provided. Enter a valid <Input Name>., <Input Name> étant le nom d'affichage du champ.

  4. Saisissez 400 dans le champ statusCode.

  5. Répétez l'opération pour chaque champ que vous souhaitez gérer et qui doit renvoyer un message d'erreur.