Endpoints

Nossa API segue o padrão REST e usa JSON para troca de dados. Isso significa que cada recurso (como clientes ou pedidos) tem uma URL própria, e você o manipula com os métodos HTTP padrão.

Métodos HTTP

MétodoOperaçãoUso
GETConsultarBusca um recurso ou uma lista de recursos.
POSTCriarCria um novo recurso.
PUT / PATCHAtualizarAltera um recurso existente.
DELETERemoverExclui um recurso.

Formato das requisições

Enviamos e recebemos dados em JSON. Nas requisições que possuem corpo (POST, PUT e PATCH), inclua o cabeçalho:

Content-Type: application/json
⚠️

Não esqueça o cabeçalho

Sem o Content-Type: application/json, a API pode não conseguir interpretar o corpo da requisição.

Próximos passos

As próximas páginas detalham cada recurso disponível, com descrição, parâmetros e exemplos de uso.

ℹ️

Precisa de mais detalhes técnicos?

A seção Referência traz a especificação completa de cada endpoint, com schemas de requisição e resposta, e permite testar as chamadas direto pelo navegador.


Did this page help you?