Resposta e erros

—

Utilizámos os códigos de erros convencionais que indicam se o pedido foi feito ou não com sucesso, mas por norma apenas dois códigos são utilizados: 200 e 403, que indicam, respectivamente, se o pedido foi feito com sucesso ou se foi recusado (por não ter permissões de acesso, por exemplo).

Também podem ser retornados outros códigos de erro, como por exemplo 4xx e 5xx, mas estes são menos comuns por se tratarem de erros internos. Em caso de anomalia por favor contacte-nos.

Em todas as situações a resposta é sempre devolvida em formato JSON e pode variar consoante seja bem sucedido e mal sucedido.

Em caso de erro:
HTTP 403 { status: false, message: ... }
Em caso de sucesso:
HTTP 200 { status: true }
Em caso de sucesso e com devolução de informação:
HTTP 200 { status: true, data: [] }
HTTP 200 { status: true, id: .. }

Caso o plano se encontre expirado, não é possível utilizar a API, sendo sempre devolvido o código 403.

Tabela de possíveis códigos HTTP

200 - OK	Pedido executado com sucesso
400 - Bad Request	Pedido incorrecto, talvez por falta de parâmetros
401 - Unauthorized	A API key disponibilizada não é válida
403 - Forbidden	A API key não tem permissões para efectuar o pedido ou parâmetros mal preenchidos
404 - Not Found	O endpoint utilizado não se encontra disponível
429 - Too Many Requests	Ultrapassou o limite de pedidos que pode fazer
500, 502, 503, 504 - Server Errors	Erros internos da aplicação

Autenticação SDKs e plugins