Nossa API segue os princípios REST, garantindo uma comunicação eficiente e padronizada.
Utilizamos verbos HTTP para definir operações nos recursos e códigos de status para indicar o resultado das requisições.
Todas as respostas são formatadas em JSON.
Verbos HTTP
A tabela abaixo descreve os principais verbos HTTP utilizados em nossa API.
| Verbo | Descrição | Exemplo de Uso |
|---|---|---|
GET | Recupera informações de um recurso | Buscar um usuário |
POST | Cria um novo recurso | Criar um pedido |
PUT | Atualiza um recurso existente | Atualizar um produto |
DELETE | Remove um recurso | Deletar um cliente |
Códigos de Status
As interações entre a aplicação do cliente e nossa API podem resultar em três cenários:
| Categoria | Descrição |
|---|---|
| 2xx - Tudo funcionou | A requisição foi bem-sucedida. |
| 4xx - Algo deu errado | A requisição continha informações inválidas ou estava incorreta. |
| 5xx - A API fez algo errado | Ocorreu um erro interno no servidor. |
A tabela a seguir apresenta os principais códigos de status retornados pela API, junto com suas mensagens de erro:
| Código | Mensagem | Descrição | Significado |
|---|---|---|---|
200 | OK | A requisição foi bem-sucedida. | - |
201 | Created | O recurso foi criado com sucesso. | - |
400 | Bad Request | A requisição está malformada ou incompleta. | Parâmetro obrigatório ausente ou inválido. |
401 | Unauthorized | Falha na autenticação. | Token de acesso inválido ou ausente. |
403 | Forbidden | O acesso ao recurso não é permitido. | Você não tem permissão para acessar este recurso. |
404 | Not Found | O recurso solicitado não foi encontrado. | O item solicitado não existe. |
500 | Internal Server Error | Erro interno no servidor da API. | Ocorreu um erro inesperado com o servidor, tente novamente mais tarde. |
Caso uma requisição falhe, a API retornará um código 4xx ou 5xx, acompanhado de uma resposta JSON.