Skip to main content

​
Formato das respostas

As respostas costumam a seguir um formato padronizado de resposta para facilitar o tratamento dos dados. Normalmente, todas as respostas são retornadas em JSON.

​
Exemplo de sucesso

{
  "response": true,
  ...
}
​
response
boolean
required
Indica se a requisição foi bem-sucedida. Onde quando o response for true, indica que a requisição executou o que se espera.
Campos adicionais (representados por ...) representam todos os outros dados retornados pelas requisições.

​
Exemplo de erro

{
  "response": false,
  "message": "nome_ou_tipo_do_erro",
  "error": "mensagem_detalhada_do_erro"
}
​
response
boolean
required
Indica se a requisição foi bem-sucedida. Onde quando o response for false, indica que houve um erro na requisição.
​
message
string
required
Descrição do tipo de erro. Retorna o nome do erro, exemplo: invalid_request, unauthorized, not_found, etc.
​
error
string
required
Descrição detalhada do erro.