Gérer les erreurs de l'API Classroom

L'API Classroom renvoie des informations d'erreur qui peuvent aider les développeurs à déboguer les problèmes et à fournir des informations utiles aux utilisateurs finaux. Ce guide explique comment analyser les informations d'erreur renvoyées par l'API.

L'API Classroom renvoie deux niveaux d'informations d'erreur:

  • Code d'erreur HTTP dans l'en-tête.
  • Objet dans le corps de la réponse avec des informations supplémentaires.

Structure des messages d'erreur

Les erreurs renvoyées dans le corps de la réponse incluent les champs suivants:

  • code: code d'erreur HTTP numérique. Exemple :403
  • message: informations supplémentaires sur l'erreur. Le message d'erreur est précédé de @ et d'un type d'erreur spécifique, le cas échéant. Exemple : @ClassroomApiDisabled.
  • status: état de la requête HTTP. Par exemple, PERMISSION_DENIED ou NOT_FOUND.

Si une requête échoue avec une erreur ClassroomApiDisabled, la réponse est la suivante:

{
  "error": {
    "code": 403,
    "message": "@ClassroomApiDisabled The user is not permitted to access the Classroom API.",
    "status": "PERMISSION_DENIED"
  }
}

Vous pouvez utiliser le corps de la réponse pour vous aider à déboguer la cause de l'erreur et à fournir des informations utiles aux utilisateurs. Incluez un espace à la fin lorsque vous recherchez un message d'erreur spécifique pour éviter de faire correspondre d'autres valeurs commençant par la même chaîne. Dans l'exemple d'erreur fourni, vous pouvez vérifier si le champ de message commence par "@ClassroomApiDisabled " pour présenter les informations appropriées aux utilisateurs.

Consultez les pages sur les erreurs d'accès, les erreurs de requête et les erreurs des modules complémentaires pour en savoir plus sur certaines erreurs pouvant être renvoyées par l'API Classroom.

Suivant
Dépannage