Introdução
Migrar da v1
Autenticação
Resposta e erros
SDKs e plugins
Países
Isenções IVA
Changelog
Vendas
Recibos
Clientes
Artigos
Administração - Armazéns
Administração - Categorias
Administração - Colaboradores
Administração - Condições de pagamento
Administração - Formas de pagamento
Administração - Locais
Administração - Modos de expedição
Administração - Moedas
Administração - Tabela de preços
Administração - Séries
Administração - Taxas de IVA
Administração - Veículos
Administração - Unidades
Resposta e erros
—
A nossa API segue os códigos de estado convencionais do RESTful API para indicar o resultado dos pedidos que, por norma,
são 200 e 201.
Em todas as situações, a resposta será sempre devolvida em formato JSON e poderá variar dependendo do sucesso ou falha do pedido. Para validar se o pedido foi bem-sucedido ou não, deve sempre verificar o status code devolvido.
Tabela de possíveis códigos HTTP
| 200 - OK | Pedido executado com sucesso |
| 201 - Created | Pedido criado com sucesso |
| 204 - No Content | 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 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 |