VTOL-VTEX
...
...
Integrator - Manual de usuario
| Painel | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
|
...
...
| Painel | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
1. Acerca del manual
1.1 Propósito y alcance
...
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:
...
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:
...
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:
...
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:
...
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:
...
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:
...
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:
...
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:
- Abrir la url: https://{Ip}:{Port}/vtolRest/swagger-ui.html#/Merchant
Dirigirse a la sección:
Repetir los mismos pasos del alta.
3.3 PaymentMethod
Configuración por API Rest
...
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:
...
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:
...
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:
...
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:
...
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#/
5. Proceso de contingencia
...
- Connector Name: NAPSEVTOL
- X-VTEX-API-AppKey: vtexappkey-napsemx-XELDAN
- X-VTEX-API-AppToken: LTHDQKBHNZRCYDWYBEQJVZMLYSOMIUOQUATUQFNKKNOQIQSTTRSQJUTLGVFXWPYSKBIXJBHVRFYHLWDHAVSRCYHAGHNUAQOVPWFHIUJRKWZDVMAKSXWBWHPMTHQCOMVA
- Service URL: https://demodev.napse.global:55559/vtolRest/v1
...
Además, es necesario tener el emulador de CA corriendo y con la configuración de canal BanamexEG (BanamexEG.properties)
...