Documentação da API
A plataforma oferece dois caminhos de integração — escolha o que faz sentido para o seu cenário. Cada um tem uma documentação dedicada.
API Completa
Acesso amplo (pedidos, entregadores, financeiro) com token cedido por uma empresa de entregas específica que te contratou. Use ao construir um sistema dedicado a um cliente — ex.: ERP/painel interno integrado à operação dele.
- Modelo M — reproduz o contrato dessa plataforma e costuma exigir só a troca do endereço e da credencial
Qual escolher?
| Pergunte-se… | API Completa (Full) | OpenDelivery |
|---|---|---|
| Quem te deu o token? | A própria empresa de entregas (nosso cliente). | Cada estabelecimento gera o próprio client_id/secret no painel dele e te envia. |
| Você atende quantos clientes da plataforma? | Geralmente um (a empresa que te contratou). | Vários ao mesmo tempo — qualquer estabelecimento pode te ativar. |
| Padrão de integração? | API REST proprietária do Entregas Expressas. | Spec aberta Open Delivery (ABRASEL). |
| Escopo de dados? | Pedidos, clientes, entregadores, financeiro, settings. | Apenas pedidos e ciclo de entrega (criar, simular, cancelar, status). |
| Posso virar parceiro oficial? | Não — é um vínculo bilateral com a empresa de entregas. | Sim — peça review do seu app pra aparecer na lista de integrações do nosso painel. |
Ambiente sandbox
Os dois tipos de integração têm ambiente de teste isolado provisionado automaticamente quando você cria um aplicativo no portal:
- Full → ganha uma praça nova (sandbox) com um token de teste de admin e botão "Acessar plataforma sandbox do app" pra você testar tudo numa cópia da operação real.
- OpenDelivery → ganha
client_id+client_secretde teste e um painel pra simular o ciclo do pedido (aceitar, atribuir entregador, coletar, entregar).
Toda request entra na aba Inspeção do app, com headers, body, status e latência — para você debugar sem precisar instrumentar seu próprio servidor.