A API usa um formato para descrever seus erros.
Erro Padrão
Além dos códigos HTTP de erro, as respostas mal-sucedidas retornam informações sobre o erro como um objeto JSON de erro contendo as seguintes informações:
| Chave | Tipo | Descrição |
|---|---|---|
| code | string | Código do erro ocorrido, no formato (000). |
| message | string | Uma breve descrição da causa do erro. |
Exemplo de retorno:
HTTP/1.1 400 Bad Request
{
"code": "010",
"message": "Senha incorreta, você tem 3 tentativas."
}
Autenticação
Todas as requisições para a API requerem autenticação, com ou sem usuário vinculado. Para obter mais informações sobre os métodos de autenticação, consulte o Guia de Autorização da Web API. Observe que, para acessar as informações pessoais de um usuário, é necessário um access token gerado ao solicitar permissão do usuário para acessar os dados (com excessão do fluxo de autenticação Password).