> ## Documentation Index > Fetch the complete documentation index at: /docs/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > Documentação das APIs da DeliveryVip, em português. Regras que mais quebram integrações: (1) Merchant API: faça polling em GET /merchant/v3/events:polling no máximo a cada 30 s por token; confirme todo evento recebido com POST /merchant/v3/events/acknowledgment e corpo [{"id": ""}] (o campo lido é id, não eventId), inclusive eventos repetidos ou que o sistema não trata; deduplique por eventId; o evento é só um aviso, busque o pedido na orderURL. (2) Tokens client_credentials valem 24 h e não têm refresh_token: peça outro ao receber 401. (3) Webhooks: valide a assinatura HMAC sobre o corpo bruto e responda 2xx rápido; o polling é a reconciliação. (4) Open Delivery: host od.deliveryvip.com.br, um client_secret por loja, datas em UTC. (5) Fidelidade: o operador implementa 5 rotas assinadas com HMAC e chama o config push; o estorno precisa ser idempotente. (6) Partner API: scope dv.partner. Não invente endpoints: use a referência gerada das specs OpenAPI. # Postman > Baixe as coleções prontas da DeliveryVip, ou importe as specs OpenAPI, e chame a API pelo Postman sem escrever código. Há duas formas de começar: baixar as **coleções prontas**, com pastas em português e o OAuth2 já configurado, ou importar as **specs OpenAPI** e configurar a autenticação você mesmo. ## Antes de começar * Uma conta no [Postman](https://www.postman.com) (a gratuita basta). * Um app no [painel de developers](/docs/inicio/primeiros-passos.md) com `client_id` e `client_secret`. * Uma loja com o app instalado. Não há sandbox: as chamadas vão para produção, então use a **loja de teste** pedida no [Discord](https://discord.gg/AJF8Yha4). ## Coleções prontas | Arquivo | Conteúdo | | - | - | | [Merchant API V3](https://github.com/DeliveryVip/DeveloperDocs/blob/main/postman/deliveryvip-merchant-api.postman_collection.json) | Autenticação, eventos, pedidos, catálogo, descontos, comandas, mesas e fidelidade. | | [Partner API V2](https://github.com/DeliveryVip/DeveloperDocs/blob/main/postman/deliveryvip-partner-api.postman_collection.json) | Autenticação, cadastro, planos, faturas, lojas e revendas. | | [Open Delivery](https://github.com/DeliveryVip/DeveloperDocs/blob/main/postman/deliveryvip-open-delivery.postman_collection.json) | Token, versões, eventos, pedidos e merchant. | | [Ambiente DeliveryVip](https://github.com/DeliveryVip/DeveloperDocs/blob/main/postman/deliveryvip.postman_environment.json) | Variáveis `clientId`, `clientSecret` (secreta), `merchantId`, `partnerId` e `orderId`. | **1. Importe a coleção e o ambiente** Baixe os arquivos e arraste-os para o Postman, ou use **Import**. **2. Preencha o ambiente** Selecione o ambiente **DeliveryVip** e preencha `clientId`, `clientSecret` e o `merchantId` (ou `partnerId`). No Open Delivery, o `clientSecret` é o da loja. **3. Gere o token** Abra a coleção, vá em **Authorization** e clique em **Get New Access Token** e depois em **Use Token**. O scope já vem preenchido nas variáveis da coleção (`od.all` ou `dv.partner`). **4. Faça uma chamada** Os IDs das rotas usam as variáveis do ambiente (`{{merchantId}}`, `{{orderId}}`). Comece por **Consultar token atual**, na pasta Autenticação. ## Specs disponíveis | Spec | Conteúdo | | - | - | | [authentication.yaml](https://app.deliveryvip.com.br/swaggers/authentication.yaml) | Token, revoke, introspect e token info. | | [merchant.yaml](https://app.deliveryvip.com.br/swaggers/merchant.yaml) | Merchant API V3: eventos, pedidos, catálogo, indoor, descontos, fidelidade. | | [partner.yaml](https://app.deliveryvip.com.br/swaggers/partner.yaml) | Partner API V2. | | [opendelivery.yaml](https://app.deliveryvip.com.br/swaggers/opendelivery.yaml) | Rotas Open Delivery em `od.deliveryvip.com.br`. | | [loyalty\_operator.yaml](https://app.deliveryvip.com.br/swaggers/loyalty_operator.yaml) | Contrato que o **operador de fidelidade** implementa. Útil para gerar um mock do seu lado. | ## Importando a partir das specs **1. Copie a URL da spec** Escolha a spec da tabela acima e copie a URL. **2. Importe no Postman** No Postman, clique em **Import**, cole a URL e confirme. Escolha gerar uma **coleção** (Postman Collection). **3. Configure a autenticação** Na coleção, abra **Authorization**, escolha **OAuth 2.0** e preencha: | Campo | Valor | | - | - | | Grant type | `Client Credentials` | | Access Token URL | `https://api.deliveryvip.com.br/authentication/v1/oauth/token` | | Client ID | o `client_id` do app | | Client Secret | o `client_secret` do app | | Scope | `od.all` (ou os scopes da API que você vai chamar) | | Client Authentication | **Send client credentials in body** | Clique em **Get New Access Token** e depois em **Use Token**. Todas as requisições da coleção herdam o token. **4. Faça uma chamada** Comece por `GET /authentication/v1/oauth/token/info` para confirmar o token e depois chame uma rota da loja de teste. > [!WARNING] > > Guarde `client_id` e `client_secret` como variáveis **secretas** de um ambiente do Postman, nunca direto na coleção. Coleções exportadas ou compartilhadas levam junto o que está salvo nelas. > [!TIP] > > Para o **Open Delivery**, use `https://od.deliveryvip.com.br/oauth/token` como Access Token URL e o `client_secret` da loja. Veja [Primeiros passos do Open Delivery](/docs/guides/open-delivery/primeiros-passos.md). This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.