Módulo OpenDelivery
Visão Geral
O módulo OpenDelivery implementa o padrão Open Delivery para integração entre estabelecimentos comerciais, softwares de gestão e plataformas de delivery. Este módulo fornece endpoints para autenticação e gerenciamento completo do ciclo de vida de pedidos.
A API segue a arquitetura REST, utilizando o formato JSON para todas as requisições e respostas. Os endpoints são versionados via prefixos específicos para cada funcionalidade.
Autenticação e Segurança
A autenticação é baseada no padrão OAuth 2.0 com o fluxo de credenciais de cliente (client_credentials), apropriado para comunicações entre servidores. Para utilizar qualquer endpoint da API, é necessário primeiro obter um token de acesso.
Gerenciamento de Pedidos
O módulo permite o acompanhamento completo do ciclo de vida de pedidos, desde sua criação até a entrega, seguindo o padrão OpenDelivery.
Informações do Merchant
O módulo de merchant permite obter informações completas sobre o estabelecimento, incluindo dados básicos, cardápios, categorias e itens disponíveis.
Endpoints Principais
| Método | Endpoint | Descrição | Limite de Uso |
|---|---|---|---|
| POST | /opendelivery/oauth/token | Gera um token de acesso OAuth 2.0 | 10 req/hora |
| GET | /opendelivery/v1/merchant | Obtém informações do estabelecimento | 10 req/minuto |
| GET | /opendelivery/v1/orders/{orderId} | Obtém detalhes de um pedido específico | 100 req/minuto |
| POST | /opendelivery/v1/orders/{orderId}/{status} | Atualiza o status de um pedido | 100 req/minuto |
| GET | /opendelivery/v1/events:polling | Consulta novos eventos de pedidos | 2 req/minuto |
| POST | /opendelivery/v1/events/acknowledgment | Confirma o processamento de eventos | 100 req/minuto |
Documentação Técnica Completa
Para informações detalhadas sobre os endpoints, parâmetros e respostas, consulte a documentação Swagger.