Como lidar com erros de API

A API Classroom retorna dois níveis de informações de erro:

  • Códigos de erro HTTP e mensagens no cabeçalho
  • Um objeto JSON no corpo da resposta com mais detalhes

É possível usar o objeto de resposta para depuração. Em alguns casos, a resposta pode conter mais detalhes do erro. Use esses detalhes para remover a ambiguidade da causa do erro e fornecer informações aos usuários ou orientá-los a tomar as medidas apropriadas.

Estrutura da mensagem de erro

Quando disponíveis, outros detalhes são incluídos no campo message do erro formatado como @ seguido por um código.

Por exemplo, se uma solicitação falhou com um erro ClassroomApiDisabled, a resposta JSON é:

{
  "error": {
    "code": 403,
      "message": "@ClassroomApiDisabled The user is not permitted to access the Classroom API.",
      "errors": [
        {
          "message": "@ClassroomApiDisabled The user is not permitted to access the Classroom API.",
          "domain": "global",
          "reason": "forbidden"
        }
      ],
      "status": "PERMISSION_DENIED"
  }
}

Confira se o campo de mensagem começa com "@ClassroomApiDisabled " e apresenta uma solicitação adequada aos usuários. Inclua um espaço à direita ao verificar um código de erro para evitar a correspondência de outros valores que começam com a mesma string.