Erros

Os erros podem ser retornados em qualquer um dos endpoints, então aconselha-se que sejam tratados em todas interações com clientes.

Os erros em geral são retornados dentro de uma chave chamada error e possuem três campos em geral que são do tipo string (a não ser que seja especificado o contrário).

Na tabela abaixo, são apresentados os códigos de erro HTTP:

Código(HTTP)

Mensagem

Descrição

400

Bad Request

Requisição inválida. Geralmente causada por algum dado enviado (argumentos faltantes, valores de argumentos inválidos, etc.). A causa do erro é descrita na requisição.

401

Unauthorized

Autenticação falhou.

403

Forbidden

Você não tem permissão para acessar o recurso solicitado.

500

Internal Server Error

Erro interno do serviço. Pedimos desculpa pelo transtorno. Você pode abrir um chamado descrevendo o erro.

503

Temporary Unavailable

Geralmente retornado enquanto o sistema estão em manutenção. A razão da manutenção e o intervalo médio também são descritos na requisição.