Primeiros Passos

Crie sua conta

Para ter acesso à documentação das APIs é necessário ter uma conta de desenvolvedor no Dev Portal VR Benefícios. Após aprovação da sua conta, você receberá um link para definição da sua senha e a partir daí estará pronto para começar.

Crie sua APP de Desenvolvimento

Para chamar as APIs da VR Benefícios é necessário criar uma APP no Portal. Na APP você encontrará as credenciais que deverá utilizar na chamada das APIs. A APP também precisa ser aprovada pela VR Benefícios. Uma vez aprovada, você estará apto a fazer testes em sandbox.

Faça testes em sandbox

No ambiente de sandbox você poderá testar o funcionamento da API. Você poderá fazer chamadas e entender quais são os retornos. Os dados retornados neste ambiente são fixos e fictícios, porém, você já conseguirá desenvolver sua integração com base neste ambiente.

Solicite acesso à homologação

Após desenvolver e testar sua integração, você poderá fazer testes em um ambiente com dados mais próximos aos reais. Para isso, peça acesso para o ambiente de Homologação.

Crie sua APP de produção

Após homologar a sua integração, você deverá criar uma nova APP específica para produção. Desta forma, você terá credenciais distintas para cada ambiente. Após aprovação desta APP, sua integração estará finalizada.