Intégrate con VR Benefícios
Las APIs que mueven ventas, emisión de tarjetas, captura y la operación de los comercios — documentadas, con sandbox y un camino claro hasta producción.
Lo que ya está publicado en este portal
Los números de abajo vienen de lo que está publicado en este portal ahora.
- 292versiones de API registradasCada versión que publica el gateway, con su spec.
- 51APIs documentadasPágina con descripción, endpoints por ambiente y referencia.
- 60documentos publicadosGuías, estándares, códigos de retorno y ejemplos.
- 4familias de negocioVentas, Core-Emisión, Adquirencia y Comunes.
- 3ambientesMock · Homologación · Producción
Quién integra con VR Benefícios
Cuatro públicos, cuatro familias de API. El portal es el mismo; el camino de cada uno empieza en un lugar distinto.
Canal de venta
Vendedores externos, prospección de leads y simulación y compra online: las APIs de Ventas cubren el canal del primer contacto al pedido.
RR. HH. de la empresa-cliente
Pedidos, tarjetas y beneficiarios por la API de Core-Emisión, en el mismo flujo que RR. HH. ya conoce.
Establecimiento y AceitaVR
Captura de transacciones, reservas y devoluciones, la operación financiera del comercio y la wallet de tarjetas para pago online, por las APIs de Adquirencia.
De la cuenta a producción, en cinco pasos
Es el mismo camino que el dev portal de VR publica hoy. Dos aprobaciones y tres ambientes: saberlo antes acorta la integración.
- 01
Cree su cuenta
La documentación de las APIs exige cuenta de desarrollador. Aprobada la cuenta, recibe el enlace para definir la contraseña.
- 02
Cree su APP de desarrollo
En la APP están las credenciales de la llamada. También pasa por aprobación de VR.
- 03
Pruebe en sandbox
Datos fijos y ficticios, pero suficientes para desarrollar la integración y entender las respuestas.
La primera llamada, con el access token
Con la APP aprobada, cada llamada a las APIs de VR lleva dos valores en el header: el client_id de la APP y un access token de OAuth 2.0. El token sale de dos solicitudes a los endpoints de autenticación de VR.
- 01
Solicite el grant code
POST en /oauth/grant-code con el client_id de su APP y el redirect_uri. La respuesta devuelve el redirect_uri con el authorization code en el parámetro code.
- 02
Cambie el code por el access token
POST en /oauth/access-token con Authorization: Basic y el client_id:client_secret en Base64. Vuelven el access_token, el refresh_token y el expires_in (3600 segundos).
- 03
Llame a la API
Envíe client_id y access_token en el header de cada llamada; sin alguno de ellos, la respuesta es 401. Cuando el token expire, el refresh_token renueva el acceso en una sola solicitud.
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>"Rutas y artículos para integrar
El contenido de VR en formato de estudio: rutas con clases y quiz para quien prefiere ser guiado, y artículos breves para quien ya integra y solo necesita una respuesta.
Artículos
Las cuatro familias de API
Es la organización que el dev portal de VR ya usa. El número de cada card es cuántas APIs de esa familia están documentadas y visibles para usted ahora.
- Después del loginAPIs de Ventas
Las APIs de esta familia quedan disponibles después del login, como en el portal actual.
- Después del login
Ayuda y contacto
La guía que VR publica, para resolver dudas sin un formulario genérico.
Primeros Pasos
La guía de VR, del registro a la APP de producción, con el texto que el dev portal publica hoy.