Integre-se à VR Benefícios
As APIs que movem vendas, emissão de cartões, captura e a operação dos estabelecimentos — documentadas, com sandbox e um caminho claro até produção.
O que já está publicado neste portal
Os números abaixo vêm do que está publicado no portal agora.
- 292versões de API registradasCada versão que o gateway publica, com o seu spec.
- 51APIs documentadasPágina com descrição, endpoints por ambiente e referência.
- 60documentos publicadosGuias, padrões, códigos de retorno e exemplos.
- 4famílias de negócioVendas, Core-Emissão, Adquirência e Comuns.
- 3ambientesMock · Homologação · Produção
Quem integra com a VR Benefícios
Quatro públicos, quatro famílias de API. O portal é o mesmo; o caminho de cada um começa em um lugar diferente.
Canal de venda
Vendedores externos, prospecção de leads e simulação e compra online: as APIs de Vendas cobrem o canal do primeiro contato ao pedido.
RH da empresa-cliente
Pedidos, cartões e beneficiários pela API de Core-Emissão, no mesmo fluxo que o RH já conhece.
Estabelecimento e AceitaVR
Captura de transações, reservas e estornos, a operação financeira do EC e a wallet de cartões para pagamento online, pelas APIs de Adquirência.
Da conta à produção, em cinco passos
É o mesmo caminho que o dev portal da VR publica hoje. Duas aprovações e três ambientes: saber disso antes encurta a integração.
- 01
Crie sua conta
A documentação das APIs exige conta de desenvolvedor. Aprovada a conta, você recebe o link para definir a senha.
- 02
Crie sua APP de desenvolvimento
É na APP que ficam as credenciais da chamada. Ela também passa por aprovação da VR.
- 03
Teste em sandbox
Dados fixos e fictícios, mas suficientes para desenvolver a integração e entender os retornos.
A primeira chamada, com o access token
Com a APP aprovada, toda chamada às APIs da VR leva dois valores no header: o client_id da APP e um access token do OAuth 2.0. O token sai de duas requisições aos endpoints de autenticação da VR.
- 01
Peça o grant code
POST em /oauth/grant-code com o client_id da sua APP e o redirect_uri. A resposta devolve o redirect_uri com o authorization code no parâmetro code.
- 02
Troque o code pelo access token
POST em /oauth/access-token com Authorization: Basic e o client_id:client_secret em Base64. Volta o access_token, o refresh_token e o expires_in (3600 segundos).
- 03
Chame a API
Envie client_id e access_token no header de cada chamada; sem um deles, a resposta é 401. Quando o token expirar, o refresh_token renova o acesso em uma requisição só.
curl -X POST https://api.vr.com.br/oauth/grant-code \
-H "Content-Type: application/json" \
-d '{"client_id": "<client_id>", "redirect_uri": "http://localhost/"}'
curl -X POST https://api.vr.com.br/oauth/access-token \
-H "Content-Type: application/json" \
-H "Authorization: Basic <base64(client_id:client_secret)>" \
-d '{"grant_type": "authorization_code", "code": "<code>"}'
# toda chamada às APIs da VR
-H "client_id: <client_id>" -H "access_token: <access_token>"Trilhas e artigos para integrar
O conteúdo da VR em formato de estudo: trilhas com aulas e quiz para quem prefere ser conduzido, e artigos curtos para quem já integra e só precisa de uma resposta.
Artigos
As quatro famílias de API
É a organização que o dev portal da VR já usa. O número em cada card é quantas APIs daquela família estão documentadas e visíveis para você agora.
- Depois do loginAPIs Vendas
As APIs desta família ficam disponíveis depois do login, como no portal atual.
- Depois do login
Ajuda e contato
O guia que a VR publica, para tirar dúvidas sem formulário genérico.
Primeiros Passos
O guia da VR, do cadastro à APP de produção, com o texto que o dev portal publica hoje.