Skip to main content
Ao final desta página você tem um app operador de fidelidade instalado em uma loja e um token capaz de ativar o programa e ler os pedidos. São quatro passos, metade no painel e metade na API.
1

Crie o app com os scopes dv.loyalty e od.all

Crie sua aplicação no painel do desenvolvedor normalmente. Um app operador de fidelidade precisa de dois scopes:Guarde o client_id e o client_secret. O secret também é a chave que a DeliveryVip usa para assinar as chamadas do contrato.
2

Declare a extensão de fidelidade

Na seção Extensões do app, declare a extensão loyalty informando a api_base_url: a base HTTPS onde o seu sistema implementa o contrato do operador. A URL pode incluir um prefixo de caminho (ex.: https://operador.example.com/dv); a DeliveryVip acrescenta /v1/loyalty/... a ela.
A api_base_url deve ser HTTPS. http:// é aceito apenas em loopback (localhost, 127.x.x.x, ::1), para desenvolvimento local.
Remover a extensão do app cascateia: apaga as configurações de programa de todas as lojas, os vínculos de clientes e o histórico de resgates. Isso é diferente do DELETE da configuração de uma loja, que desativa o programa naquela loja sem tocar em vínculos nem histórico.
3

O lojista instala o app

O lojista instala o seu app pela Delivery Store, como qualquer outro app. Veja Instalando o app na loja. O grant é derivado no servidor (interseção dos scopes do app com os que o dono da loja pode conceder), e a página de consentimento destaca o item de fidelidade/LGPD para o lojista.
4

Obtenha o token com os dois scopes

Use o fluxo client credentials pedindo os dois scopes no mesmo token. O token vale 24 horas e atende todas as lojas que instalaram o app.
O parâmetro é scope (singular), com os valores separados por espaço. Um token só com dv.loyalty consegue configurar o programa, mas recebe 403 ao ler pedidos; um token só com od.all recebe 403 nos endpoints de configuração.
Veja mais detalhes do fluxo OAuth em Autenticação.
Com o app instalado e o token em mãos, você já pode ativar o programa da loja. Antes, deixe a rota GET /v1/loyalty/ping do seu servidor respondendo 204 com a assinatura validada: o config push depende dela.

Duas credenciais, dois sentidos

Não assine o config push com HMAC nem espere um Bearer token nas rotas do contrato. Cada sentido usa só a sua autenticação.