VTOL Integration Services - Integración
Introducción
VTOL Integration Service (VIS) es un servicio (API REST) que expone VTOL para ser utilizado en diferentes circunstancias. Por ejemplo, para administrar los link de pago, bajar la configuración o consultar el estado de conciliación de las transacciones procesadas por VTOL.
Según las necesidades del integrador, será requerido usar uno u otro servicio.
En éste documento se explica brevemente para que sirve cada uno de ellos y cuando será necesario utilizarlo.
La API está publicada en la siguiente URL:
Un ejemplo de la vista del API
Integraciones
A continuación se detallan los servicios para integrarse.
Conciliaciones (API "Transactions")
A través de éste servicio un integrador podrá listar las transacciones realizadas en VTOL y obtener para cada una de ellas el estado de conciliación actual.
Dicho estado surge de un proceso de conciliación interno que VTOL hace con los bancos y/o tarjetas.
Para conocer si ésta funcionalidad está activa para su comercio, por favor ponerse en contacto con su comercial de referencia.
Configuración (API "configuration")
VTOL posee el catálogo de información de medios de pagos disponibles. Esta configuración está disponible para aquél integrador que requiere consultar los medios de pagos que maneja VTOL, como por ejemplo, para hacerse de las tarjetas y sus bines (forma de identificar una marca). en ocasiones esto es requerido para calcular promociones bancarias o por medio de pagos.
Además se podrán obtener las opciones de pago, es decir, para cada tarjetas, si se permiten cuotas, tasa de interés, etc
La información de medios de pago que se obtiene de VTOL es la siguiente:
- Marcas de tarjetas
- Tarjetas
- Prefijos de tarjetas
- Opciones de pago
- Bancos
- Monedas
Link de pago (API "paymentLink")
El link de pago es una facilidad que permite realizar ventas no presenciales en establecimientos comerciales mediante el envío de un enlace de pago (por correo electrónico, por ejemplo) para que el cliente abone con tarjeta de crédito. VTOL permitirá generar un hipervínculo con una solicitud de pago para que el comerciante comparta o envíe dicho link a sus clientes así los mismos logren abonar los servicios o un pago específico por una compra mediante la plataforma online de pago de VTOL.
En el siguiente link se detallan los servicios para integrar un comercio con la API de Link de pago donde se podrá:
- crear links de pago para realizar cobros a través de links
- consultar el estado de las solicitudes de pago generadas para conocer si fueron pagadas por el cliente
- devolver un pago realizado a través de un link de pagos
- listar los link de pagos generados
- o eliminar los links de pago para que no se puedan utilizar.
Seguridad
Autenticación (HTTP Basic Authentication)
La aplicación de seguridad HTTP Basic es a partir de la versión 1.0.2
Para la integración a través de la API REST, a partir de la versión 1.0.2, se requiere autenticación HTTP Basic. El comercio necesitará las siguientes credenciales:
- Usuario
- Contraseña.
Se deben enviar estos datos en el "Header" de cada invocación a los servicios de VIS.
Las credenciales se utilizan en el backend del comercio y debe ser secreta. Las mismas serán provistas por el equipo de Soporte de NAPSE.
Servicios de VIS que requieren Basic Authentication
Los siguientes servicios utilizan autenticación HTTP Basic
- Conciliaciones
- Configuración
- Link de pago