> ## 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": "<eventId>"}] (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.

# Primeiros passos

> Crie sua conta, a conta de desenvolvedor e o primeiro app para consumir as APIs da DeliveryVip.

Para chamar qualquer API da DeliveryVip você precisa de um **app** no painel de developers. É ele que tem as credenciais (`client_id` e `client_secret`) e as permissões que as lojas, parceiros e marketplaces vão autorizar.

**1. Crie seu usuário**

Cadastre-se na [plataforma](https://developer.deliveryvip.com.br/users/sign_up).

> [!NOTE]
>
> Já tem um usuário na DeliveryVip? Use o mesmo e pule este passo.

**2. Crie a conta de desenvolvedor**

Acesse o [painel de developers](https://developer.deliveryvip.com.br), entre com o seu usuário e, se ainda não tiver uma conta de desenvolvedor, clique em **Criar nova conta de Desenvolvedor**.

**3. Crie um aplicativo**

No painel, clique em **Novo Aplicativo** e escolha o tipo de distribuição.

![Tela de novo aplicativo com as opções de distribuição direta e interativa](https://mintcdn.com/deliveryvip-a4256422/ELxpcniK2_BP8zxT/images/painel-novo-aplicativo.png?fit=max\&auto=format\&n=ELxpcniK2_BP8zxT\&q=85\&s=d16d20724b8d3d742032cb1ba12370f4)

Escolha do tipo de distribuição ao criar o app

## Direta ou interativa?

Nos dois tipos a instalação começa igual: o lojista (ou parceiro) cola na Delivery Store o **token de autorização** que você enviou. A diferença está no que acontece depois e no fluxo OAuth que o seu sistema usa para obter o token.

| | Distribuição direta | Distribuição interativa |
| - | - | - |
| **Fluxo OAuth** | `client_credentials` | `authorization_code` |
| **Como a loja instala** | Cola o **token de autorização** na Delivery Store e clica em **Instalar** | Cola o **token de autorização** na Delivery Store, é levada para o seu app e autoriza o acesso |
| **Interface do app** | Não tem: o app conversa só com a API | Abre a **URL do app**, dentro do painel da loja (incorporado) ou fora dele |
| **Como você obtém o token** | `client_id` + `client_secret` | Troca o `code` recebido na sua **Redirect URI** |
| **Um token atende** | Todas as lojas que instalaram o app | O dono que autorizou (renovável com `refresh_token`) |
| **Ideal para** | PDVs, ERPs e integrações de servidor | Apps com tela própria, que a loja usa no dia a dia |

> [card] [Distribuição direta](/docs/inicio/primeiros-passos/distribuicao-direta.md)
>
> Formulário do app, token de autorização e token via `client_credentials`.

> [card] [Distribuição interativa](/docs/inicio/primeiros-passos/distribuicao-interativa.md)
>
> URL do app, incorporação ao painel, Redirect URI e token via `authorization_code`.

## Próximos passos

> [card] [Jornada do Developer](/docs/inicio/primeiros-passos/jornada-do-developer.md)
>
> O caminho completo, da conta até a primeira chamada à API.

> [card] [Instalando o app na loja](/docs/inicio/primeiros-passos/instalando-app-na-loja.md)
>
> O passo a passo que o lojista segue para autorizar o seu app.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.