|
El presente manual tiene por finalidad la capacitación de los usuarios que deseen utilizar el módulo de Vtex Integration Service del producto VTOL.
Brinda la información necesaria, con el nivel de detalle suficiente para que el usuario pueda configurar el módulo para operar con el E-commerce VTEX.
Se mencionan los documentos que acompañan a este manual:
VTOL-Vtex Integrator es un sistema que permite la conexión entre VTOL Server y el E-Commerce VTEX para realizar transacciones con tarjetas de crédito y débito.
A continuación se explica el funcionamiento de VTOL-Vtex Integrator:
A continuación se muestra un gráfico de la arquitectura de VTOL-VTEX Integrator.
Para el correcto funcionamiento de este módulo es necesario previamente realizar las configuraciones que se describen a continuación:
En el módulo de VTOL-Vtex Integrator se deben configurar las instancias de VTOL Server, por medio de las cuales se procesarán las transacciones.
Para configurar dichas instancias, se podrá realizar por medio de la base de datos (mongoDB), o por medio de webservices (API Rest)
Configuración por Base de datos:
Para modificar los parámetros de conexión a través de la base de datos, se puede utilizar una herramienta de administración de base de datos MongoDB, como ser Robo3T.
Para configurar los datos, es necesario editar la collection “VtolConfig” de la base de VTOL-VtexIS.
Los parámetros más importantes de conexión son:
Ejemplo:
Configuración por API Rest
El servicio /vtolConfig permite configurar los datos de las instancias de VTOL Server que estarán habilitadas en VTOL-Vtex Integrator.
El detalle completo del servicio de Configuración de instancias de VTOL Server se encuentra documentado en Swagger: |
Permite dar de alta una Instancia de VTOL Server dentro del módulo VTOL-VTEX Integrator.
| Método | POST |
|---|---|
| Url | https://{{baseUrl}}/vtolRest/vtolConfig |
Invocar al servicio
Para dar de alta una Instancia de VTOL Server, se puede utilizar la herramienta Swagger, de la siguiente manera:
Dirigirse a la sección:
Permite modificar una Instancia de VTOL Server dentro del módulo VTOL-VTEX Integrator.
| Método | PUT |
|---|---|
| Url | https://{{baseUrl}}/vtolRest/vtolConfig |
Invocar al servicio
Para modificar una Instancia de VTOL Server, se puede utilizar la herramienta Swagger, de la siguiente manera:
Dirigirse a la sección:
Permite realizar una consulta de las Instancias de VTOL Server que están configuradas dentro del módulo VTOL-VTEX Integrator.
| Método | GET |
|---|---|
| Url | https://{{baseUrl}}/vtolRest/vtolConfigs |
Invocar al servicio
Para consultar las Instancias de VTOL Server, se puede utilizar la herramienta Swagger, de la siguiente manera:
Dirigirse a la sección:
Repetir los mismos pasos del alta.
Permite eliminar una Instancia de VTOL Server dentro del módulo VTOL-VTEX Integrator.
| Método | DELETE |
|---|---|
| Url | https://{{baseUrl}}/vtolRest/vtolConfig |
Invocar al servicio
Para eliminar una Instancia de VTOL Server, se puede utilizar la herramienta Swagger, de la siguiente manera:
Dirigirse a la sección:
Repetir los mismos pasos del alta.
Configuración por API Rest
El servicio /merchant permite configurar los datos de la compañía en VTOL-Vtex Integrator.
El detalle completo del servicio de Alta de Merchant, se encuentra documentado en Swagger: |
Permite dar de alta un Merchant dentro del módulo VTOL-VTEX Integrator.
| Método | POST |
|---|---|
| Url | https://{{baseUrl}}/vtolRest/merchant |
Los datos necesarios para el alta son:
merchantCode | Código de la compañía en Vtol Server. | |
|---|---|---|
merchantName | Nombre de la compañía. | |
merchantStoreCode | Código del local en Vtol Server | |
token | appKey | Llave de token de validación. Dato provisto por Vtex. |
appToken | Token de validación. Dato provisto por Vtex. | |
vtolCode | Configuración de la instancia de VTOL Server por el cual se procesarán las transacciones. Este dato debe corresponderse con alguna instancia de VTOL Server configurada en el servicio /VtolServer. Por ejemplo si en el servicio /VtolServer se configura una instancia de VTOL Server con el siguiente code:
Entonces en este campo (vtolCode) se deberá cargar el valor: VTOLCDMX | |
Invocar al servicio
Para dar de alta un Merchant, se puede utilizar la herramienta Swagger, de la siguiente manera:
Dirigirse a la sección:
Permite modificar un Merchant dentro del módulo VTOL-VTEX Integrator.
| Método | PUT |
|---|---|
| Url | https://{{baseUrl}}/vtolRest/merchant |
Invocar al servicio
Para modificar un Merchant, se puede utilizar la herramienta Swagger, de la siguiente manera:
Dirigirse a la sección:
Permite realizar una consulta de los Merchant que están configurados dentro del módulo VTOL-VTEX Integrator.
| Método | GET |
|---|---|
| Url | https://{{baseUrl}}/vtolRest/merchants |
Invocar al servicio
Para consultar los Merchant, se puede utilizar la herramienta Swagger, de la siguiente manera:
Dirigirse a la sección:
Repetir los mismos pasos del alta.
Permite eliminar un Merchant dentro del módulo VTOL-VTEX Integrator.
| Método | DELETE |
|---|---|
| Url | https://{{baseUrl}}/vtolRest/merchant |
Invocar al servicio
Para eliminar un Merchant, se puede utilizar la herramienta Swagger, de la siguiente manera:
Dirigirse a la sección:
Repetir los mismos pasos del alta.
Configuración por API Rest
El servicio /paymentMethod permite configurar las tarjetas soportadas por el módulo VTOL-Vtex Integrator.
El detalle completo del servicio de Alta de Merchant, se encuentra documentado en Swagger: |
Permite el alta de un medio de pago dentro del módulo VTOL-Vtex Integrator.
| Método | POST |
|---|---|
| Url | https://{{baseUrl}}/vtolRest/v1/payment-method |
Los datos necesarios para el alta son:
name | Nombre de la tarjeta. |
|---|---|
country | País de la tarjeta. Valor por defecto: “Global” |
| X-VTEX-API-AppKey | Llave de token de validación. Dato provisto por Vtex. |
| X-VTEX-API-AppToken | Token de validación. Dato provisto por Vtex. |
Invocar al servicio
Para dar de alta una tarjeta, se puede utilizar la herramienta Swagger, de la siguiente manera:
Dirigirse a la sección:
Permite modificar un Medio de Pago dentro del módulo VTOL-VTEX Integrator.
| Método | PUT |
|---|---|
| Url | https://{{baseUrl}}/vtolRest/v1/payment-method |
Invocar al servicio
Para modificar un Medio de pago, se puede utilizar la herramienta Swagger, de la siguiente manera:
Dirigirse a la sección:
Permite realizar una consulta de los Medios de Pago que están configurados dentro del módulo VTOL-VTEX Integrator.
| Método | GET |
|---|---|
| Url | https://{{baseUrl}}/vtolRest/v1/payment-methods |
Invocar al servicio
Para consultar los Merchant, se puede utilizar la herramienta Swagger, de la siguiente manera:
Dirigirse a la sección:
Repetir los mismos pasos del alta.
Permite eliminar un Medio de Pago dentro del módulo VTOL-VTEX Integrator.
| Método | DELETE |
|---|---|
| Url | https://{{baseUrl}}/vtolRest/v1/payment-method |
Invocar al servicio
Para eliminar un Medio de Pago, se puede utilizar la herramienta Swagger, de la siguiente manera:
Dirigirse a la sección:
Repetir los mismos pasos del alta.
VTOL-Vtex Integrator expone los servicios requeridos por el E-commerce Vtex para realizar transacciones de crédito-débio. Todos los servicios de transacciones reciben en el header los parámetros: “X-VTEX-API-AppKey” y “X-VTEX-API-AppToken”. Estos datos se utilizan para autenticar el requerimiento, y se contrastan contra los parámetros “appKey” y “appToken” respectivamente, de la entidad Merchant de la base de datos del módulo VTOL-Vtex Integrator.
Recibe un requerimiento de preautorizacion del Ecommerce Vtex y la reenvía a Vtol Server. Si expira el tiempo de procesamiento de la transacción, el servicio retorna el código “V01” con status: “Undefinied”, esto indica al E-Commerce Vtex que debe consultar el status de la preautorización.
URL del Servicio:
https://{{baseUrl}}/v1/payments/v1/payments
Recibe un requerimiento de cancelación preautorizacion, previamente aprobada, desde el E-Commerce Vtex y la reenvía a Vtol Server. Si expira el tiempo de procesamiento de la transacción, el servicio retorna el código “V01” con status: “Undefinied”, esto indica al E-Commerce Vtex que debe consultar el status de la preautorización.
URL del Servicio:
https://{{baseUrl}}/v1/payments/:paymentId/cancellations
Recibe un requerimiento de captura de una preautorizacion, previamente aprobada, desde el E-commerce Vtex y la reenvía a Vtol Server. Si expira el tiempo de procesamiento de la transacción, el servicio retorna el código “V01” con status: “Undefinied”, esto indica al E-Commerce Vtex que debe consultar el status de la preautorización.
URL del Servicio: https://{{baseUrl}}/v1/payments/:paymentId/settlements
Recibe un requerimiento de una devolución de una captura, previamente aprobada, desde el E-commerce Vtex y la reenvía a Vtol Server. Si expira el tiempo de procesamiento de la transacción, el servicio retorna el código “V01” con status: “Undefinied”, esto indica al E-Commerce Vtex que debe consultar el status de la preautorización.
URL del Servicio:
https://{{baseUrl}}/v1/payments/:paymentId/refunds
Nota:
Para más detalle de los servicios de transacciones que expone el modulo VtexIS, ingrese en la definición de Swagger: https://{{baseUrl}}/ /vtolRest/swagger-ui.html#/
El proceso de contingencia del módulo VtexIS, se ejecuta en background cada 15 minutos y su objetivo es sincronizar las transacciones con Vtol Server. Obtiene las transacciones que están pendientes en Vtol y decide si debe enviar un Commit o un Rollback.
Funcionamiento: Cada vez que se ejecuta el proceso, obtiene para cada Merchant todas las transacciones pendientes en Vtol Server.
El E-Commerce Vtex provee un sitio para realizar una prueba de los servicios de integración que expone el módulo VtexIS de Vtol.
La url de la suite de test es: https://napsemx.myvtex.com/admin/test-suite/payment-provider Es necesario previamente estar registrado en el sitio de Vtex.
Los datos de prueba son:
Además, es necesario tener el emulador de CA corriendo y con la configuración de canal BanamexEG (BanamexEG.properties)
response.0100.class=iso.message.BanamexEGResponses.BanamexEGResponse110OKVTEX