Webview HA
by integracionesvendemas

Webview HA

API Rest Webview

El proyecto webview es una colección de API REST que disponibiliza operaciones para generación y acceso a webviews de la red Vendemás. Es necesario autenticarse para obtener un token de acceso a las operaciones del API, este token debe viajar en el header de cada operación.

Autenticación:

https://auth2.vmas.com.pe/vm-api-autorizacion/oauth/token

Generación de token para el uso de los servicios del api webview

  • Generacion Token

Webview:

Operaciones propias del api de Webview

  • Proveedores Token
  • Autogestión Token
  • Depositos Token
Generación Url Carga Webview
Autogestión - Mis Depósitos
POST /v1/depositos/generaUrlToken
Pago a Proveedores
POST /v1/proveedores/generaUrlToken
Carga de cuenta Cupo
POST /v1/abonos/generaUrlToken
Marketplace
POST /v1/marketplace/generaUrlToken
Comisiones
POST /v1/comision/generaUrlToken
Autogestión - Mis Depósitos
POST /v1/depositos/generaUrlToken

Request body

Object
fecha
string required

Fecha de la transacción

Example:
2020-11-06
hora
string required

Hora de la transacción

Example:
15:47:42
cliente
string required

Código de cliente, a cada proveedor se le dará un código respectivo

Example:
GEOPAGOS
programa
string required

Programa de cliente, a cada proveedor se le dará un código respectivo

Example:
GEOPAGOS
datos
Object required
comercio
Object required
codigoComercio
string required

Código NBO del cliente

Example:
843634989
emailUsuario
string required

E-mail del usuario en sesión dentro del aplicativo móvil

Example:
jcamacho@vendemas.niubiz.com.pe
Examples
{
    "fecha": "2020-11-06",
    "hora": "15:47:42",
    "cliente": "GEOPAGOS",
    "programa": "GEOPAGOS",
    "datos": {
        "comercio": {
            "codigoComercio": "843634989",
            "emailUsuario": "jcamacho@vendemas.niubiz.com.pe"
        }
    }
}

Responses

200 OK

Estructura cuando es todo correcto

Body
Object
fecha
string required

Fecha de la transacción

Example:
2020-11-19
hora
string required

Hora de la transacción

Example:
09:24:30
cliente
string required

Código de cliente

Example:
GEOPAGOS
programa
string required

Programa de cliente

Example:
GEOPAGOS
codigoRespuesta
string required

Código respuesta de endpoint

Enumeration:
00

Éxito

mensajeRespuesta
string required

Mensaje respuesta Endpoint

Example:
EXITO
operacion
string required

Nombre de operación

Example:
generarUrlToken
datos
Object nullable
url
string

URL para renderizar

Example:
{host}/proveedor/prestamos/U2FsdGVkX196xBEWPT4k1I1zWPQ4DPjer9XO0XeZQ+d29+MpFlnLBNS0Wn0AXLGS
Examples
{
    "fecha": "2020-11-19",
    "hora": "09:24:30",
    "cliente": "GEOPAGOS",
    "programa": "GEOPAGOS",
    "codigoRespuesta": "00",
    "mensajeRespuesta": "EXITO",
    "operacion": "generarUrlToken",
    "datos": {
        "url": "{host}/proveedor/prestamos/U2FsdGVkX196xBEWPT4k1I1zWPQ4DPjer9XO0XeZQ+d29+MpFlnLBNS0Wn0AXLGS"
    }
}
500 Error Response

Estructura cuando sean errores

Body
Object
fecha
string required

Fecha de transacción

Example:
2020-11-19
hora
string required

Hora de transacción

Example:
10:41:01
codigoRespuesta
string required

Código de respuesta error

Example:
15
mensajeRespuesta
string required

Mensaje de error

Example:
ERROR INTERNO
operacion
string required

Operación realizada

Example:
webview/depositos/generaUrlToken
Examples
{
    "fecha": "2020-11-19",
    "hora": "10:41:01",
    "codigoRespuesta": "15",
    "mensajeRespuesta": "ERROR INTERNO",
    "operacion": "webview/depositos/generaUrlToken"
}
401 Unauthorized

Token invalido o expirado

Body
Object
fecha
string required

Fecha de transacción

Example:
12
hora
string required

Hora de transacción

Example:
2020-12-15
codigoRespuesta
string required

Código de respuesta error

Example:
12:29:58
operacion
string required

Operación realizada

Example:
webview/proveedores/generaUrlToken
mensajeRespuesta
string required

Mensaje de error

Example:
TOKEN INVÁLIDO O EXPIRADO
Examples
{
    "codigoRespuesta": "12",
    "fecha": "2020-12-15",
    "hora": "12:29:58",
    "operacion": "webview/proveedores/generaUrlToken",
    "mensajeRespuesta": "TOKEN INVÁLIDO O EXPIRADO"
}
Pago a Proveedores
POST /v1/proveedores/generaUrlToken

Request body

Object
fecha
string required

Fecha de la transacción

Example:
2020-11-06
hora
string required

Hora de la transacción

Example:
15:47:42
cliente
string required

Código de cliente, a cada proveedor se le dará un código respectivo

Example:
GEOPAGOS
programa
string required

Programa de cliente, a cada proveedor se le dará un código respectivo

Example:
GEOPAGOS
datos
Object
comercio
Object required
codigoComercio
string required

Código NBO del cliente

Example:
843634989
emailUsuario
string required

E-mail del usuario en sesión dentro del aplicativo móvil

Example:
"jcamacho@vendemas.niubiz.com.pe
Examples
{
    "fecha": "2020-11-06",
    "hora": "15:47:42",
    "cliente": "GEOPAGOS",
    "programa": "GEOPAGOS",
    "datos": {
        "comercio": {
            "codigoComercio": "843634989",
            "emailUsuario": "jcamacho@vendemas.niubiz.com.pe"
        }
    }
}

Responses

200 OK

Estructura cuando es todo correcto

Body
Object
fecha
string required

Fecha de la transacción

Example:
2020-11-19
hora
string required

Hora de la transacción

Example:
09:24:30
cliente
string required

Código de cliente

Example:
GEOPAGOS
programa
string required

Programa de cliente

Example:
GEOPAGOS
codigoRespuesta
string required

Código respuesta de endpoint

Example:
00
mensajeRespuesta
string required

Mensaje respuesta Endpoint

Example:
EXITO
operacion
string required

Nombre de operación

Example:
generarUrlToken
datos
Object nullable
url
string

URL para renderizar

Example:
{host}/proveedor/prestamos/U2FsdGVkX196xBEWPT4k1I1zWPQ4DPjer9XO0XeZQ+d29+MpFlnLBNS0Wn0AXLGS
Examples
{
    "fecha": "2020-11-19",
    "hora": "09:24:30",
    "cliente": "GEOPAGOS",
    "programa": "GEOPAGOS",
    "codigoRespuesta": "00",
    "mensajeRespuesta": "EXITO",
    "operacion": "generarUrlToken",
    "datos": {
        "url": "{host}/proveedor/prestamos/U2FsdGVkX196xBEWPT4k1I1zWPQ4DPjer9XO0XeZQ+d29+MpFlnLBNS0Wn0AXLGS"
    }
}
500 Error Response

Estructura cuando sean errores

Body
Object
fecha
string required

Fecha de transacción

Example:
2020-11-19
hora
string required

Hora de transacción

Example:
10:41:01
codigoRespuesta
string required

Código de respuesta error

Example:
15
mensajeRespuesta
string required

Mensaje de error

Example:
ERROR INTERNO
operacion
string required

Operacion realizada

Example:
webview/depositos/generaUrlToken
Examples
{
    "fecha": "2020-11-19",
    "hora": "10:41:01",
    "codigoRespuesta": "15",
    "mensajeRespuesta": "ERROR INTERNO",
    "operacion": "webview/depositos/generaUrlToken"
}
401 Unauthorized

Token invalido o expirado

Body
Object
codigoRespuesta
string required

Código de respuesta de error

Example:
12
fecha
string required

Fecha de transacción

Example:
2020-12-15
hora
string required

Hora de transacción

Example:
12:29:58
operacion
string required

Operación realizada

Example:
webview/proveedores/generaUrlToken
mensajeRespuesta
string required

Mensaje de error

Example:
TOKEN INVÁLIDO O EXPIRADO
Examples
{
    "codigoRespuesta": "12",
    "fecha": "2020-12-15",
    "hora": "12:29:58",
    "operacion": "webview/proveedores/generaUrlToken",
    "mensajeRespuesta": "TOKEN INVÁLIDO O EXPIRADO"
}
Carga de cuenta Cupo
POST /v1/abonos/generaUrlToken

Request body

Object
fecha
string required

Fecha de la transacción

Example:
2020-11-06
hora
string required

Hora de la transacción

Example:
15:47:42
cliente
string required

Código de cliente, a cada proveedor se le dará un código respectivo

Example:
GEOPAGOS
programa
string required

Programa de cliente, a cada proveedor se le dará un código respectivo

Example:
GEOPAGOS
datos
Object
comercio
Object
codigoComercio
string required

Código único Niuibiz del cliente

Example:
843634989
emailUsuario
string required

E-mail del usuario en sesión dentro del aplicativo móvil

Example:
"jcamacho@vendemas.niubiz.com.pe
Examples
{
    "fecha": "2020-11-06",
    "hora": "15:47:42",
    "cliente": "GEOPAGOS",
    "programa": "GEOPAGOS",
    "datos": {
        "comercio": {
            "codigoComercio": "843634989",
            "emailUsuario": "jcamacho@vendemas.niubiz.com.pe"
        }
    }
}

Responses

200 OK

Estructura cuando es todo correcto

Body
Object
fecha
string required

Fecha de la transacción

Example:
2020-11-19
hora
string required

Hora de la transacción

Example:
09:24:30
cliente
string required

Código de cliente

Example:
GEOPAGOS
programa
string required

Programa de cliente

Example:
GEOPAGOS
codigoRespuesta
string required

Código respuesta de endpoint

Example:
00
mensajeRespuesta
string required

Mensaje respuesta Endpoint

Example:
EXITO
operacion
string required

Nombre de operación

Example:
generarUrlToken
datos
Object nullable
url
string

URL para renderizar

Example:
{host}/abonos/gateway/U2FsdGVkX196xBEWPT4k1I1zWPQ4DPjer9XO0XeZQ+d29+MpFlnLBNS0Wn0AXLGS
Examples
{
    "fecha": "2020-11-19",
    "hora": "09:24:30",
    "cliente": "GEOPAGOS",
    "programa": "GEOPAGOS",
    "codigoRespuesta": "00",
    "mensajeRespuesta": "EXITO",
    "operacion": "generarUrlToken",
    "datos": {
        "url": "{host}/abonos/gateway/U2FsdGVkX196xBEWPT4k1I1zWPQ4DPjer9XO0XeZQ+d29+MpFlnLBNS0Wn0AXLGS"
    }
}
500 Error Response

Estructura cuando sean errores

Body
Object
fecha
string required

Fecha de transacción

Example:
2020-11-19
hora
string required

Hora de transacción

Example:
10:41:01
codigoRespuesta
string required

Código de respuesta error

Example:
15
mensajeRespuesta
string required

Mensaje de error

Example:
ERROR INTERNO
operacion
string required

Operacion realizada

Example:
webview/abonos/generaUrlToken
Examples
{
    "fecha": "2020-11-19",
    "hora": "10:41:01",
    "codigoRespuesta": "15",
    "mensajeRespuesta": "ERROR INTERNO",
    "operacion": "webview/abonos/generaUrlToken"
}
401 Unauthorized
Body
Object
codigoRespuesta
string required
Example:
12
fecha
string required
Example:
2020-12-15
hora
string required
Example:
12:29:58
operacion
string required
Example:
webview/abonos/generaUrlToken
mensajeRespuesta
string required
Example:
TOKEN INVÁLIDO O EXPIRADO
Marketplace
POST /v1/marketplace/generaUrlToken

Request body

Object
fecha
string required

Fecha de la transacción

Example:
2020-11-06
hora
string required

Hora de la transacción

Example:
15:47:42
cliente
string required

Código de cliente, a cada proveedor se le dará un código respectivo

Example:
GEOPAGOS
programa
string required

Programa de cliente, a cada proveedor se le dará un código respectivo

Example:
GEOPAGOS
datos
Object required
comercio
Object required
codigoComercio
string required

Código NBO del cliente

Example:
843634989
emailUsuario
string required

E-mail del usuario en sesión dentro del aplicativo móvil

Example:
jcamacho@vendemas.niubiz.com.pe
Examples
{
    "fecha": "2020-11-06",
    "hora": "15:47:42",
    "cliente": "GEOPAGOS",
    "programa": "GEOPAGOS",
    "datos": {
        "comercio": {
            "codigoComercio": "843634989",
            "emailUsuario": "jcamacho@vendemas.niubiz.com.pe"
        }
    }
}

Responses

200 OK

Estructura cuando es todo correcto

Body
Object
fecha
string required

Fecha de la transacción

Example:
2020-11-19
hora
string required

Hora de la transacción

Example:
09:24:30
cliente
string required

Código de cliente

Example:
GEOPAGOS
programa
string required

Programa de cliente

Example:
GEOPAGOS
codigoRespuesta
string required

Código respuesta de endpoint

Enumeration:
00

Éxito

mensajeRespuesta
string required

Mensaje respuesta Endpoint

Example:
EXITO
operacion
string required

Nombre de operación

Example:
generarUrlToken
datos
Object nullable
url
string

URL para renderizar

Example:
{host}/prestamos/gateway/U2FsdGVkX196xBEWPT4k1I1zWPQ4DPjer9XO0XeZQ+d29+MpFlnLBNS0Wn0AXLGS
Examples
{
    "fecha": "2020-11-19",
    "hora": "09:24:30",
    "cliente": "GEOPAGOS",
    "programa": "GEOPAGOS",
    "codigoRespuesta": "00",
    "mensajeRespuesta": "EXITO",
    "operacion": "generarUrlToken",
    "datos": {
        "url": "{host}/proveedor/prestamos/U2FsdGVkX196xBEWPT4k1I1zWPQ4DPjer9XO0XeZQ+d29+MpFlnLBNS0Wn0AXLGS"
    }
}
500 Error Response

Estructura cuando sean errores

Body
Object
fecha
string required

Fecha de transacción

Example:
2020-11-19
hora
string required

Hora de transacción

Example:
10:41:01
codigoRespuesta
string required

Código de respuesta error

Example:
15
mensajeRespuesta
string required

Mensaje de error

Example:
ERROR INTERNO
operacion
string required

Operación realizada

Example:
webview/depositos/generaUrlToken
Examples
{
    "fecha": "2020-11-19",
    "hora": "10:41:01",
    "codigoRespuesta": "15",
    "mensajeRespuesta": "ERROR INTERNO",
    "operacion": "webview/depositos/generaUrlToken"
}
401 Unauthorized

Token invalido o expirado

Body
Object
fecha
string required

Fecha de transacción

Example:
12
hora
string required

Hora de transacción

Example:
2020-12-15
codigoRespuesta
string required

Código de respuesta error

Example:
12:29:58
operacion
string required

Operación realizada

Example:
webview/proveedores/generaUrlToken
mensajeRespuesta
string required

Mensaje de error

Example:
TOKEN INVÁLIDO O EXPIRADO
Examples
{
    "codigoRespuesta": "12",
    "fecha": "2020-12-15",
    "hora": "12:29:58",
    "operacion": "webview/proveedores/generaUrlToken",
    "mensajeRespuesta": "TOKEN INVÁLIDO O EXPIRADO"
}
Comisiones
POST /v1/comision/generaUrlToken

Request body

Object
fecha
string required

Fecha de la transacción

Example:
2020-11-06
hora
string required

Hora de la transacción

Example:
15:47:42
cliente
string required

Código de cliente, a cada proveedor se le dará un código respectivo

Example:
GEOPAGOS
programa
string required

Programa de cliente, a cada proveedor se le dará un código respectivo

Example:
GEOPAGOS
datos
Object required
comercio
Object required
codigoComercio
string required

Código NBO del cliente

Example:
843634989
emailUsuario
string required

E-mail del usuario en sesión dentro del aplicativo móvil

Example:
jcamacho@vendemas.niubiz.com.pe
userId
string

Usuario de la sesion de analitics, este dato debe llegar desde el dispositivo movil. NO es la sesion propia del sistema de Geopagos

Example:
546uy424==
Examples
{
    "fecha": "2020-11-06",
    "hora": "15:47:42",
    "cliente": "GEOPAGOS",
    "programa": "GEOPAGOS",
    "datos": {
        "comercio": {
            "codigoComercio": "843634989",
            "emailUsuario": "jcamacho@vendemas.niubiz.com.pe",
            "userId":"546uy424=="
        }
    }
}

Responses

200 OK

Estructura cuando es todo correcto

Body
Object
fecha
string required

Fecha de la transacción

Example:
2020-11-19
hora
string required

Hora de la transacción

Example:
09:24:30
cliente
string required

Código de cliente

Example:
GEOPAGOS
programa
string required

Programa de cliente

Example:
GEOPAGOS
codigoRespuesta
string required

Código respuesta de endpoint

Enumeration:
00

Éxito

mensajeRespuesta
string required

Mensaje respuesta Endpoint

Example:
EXITO
operacion
string required

Nombre de operación

Example:
generarUrlToken
datos
Object nullable
url
string

URL para renderizar

Example:
{host}/prestamos/gateway/U2FsdGVkX196xBEWPT4k1I1zWPQ4DPjer9XO0XeZQ+d29+MpFlnLBNS0Wn0AXLGS
Examples
{
    "fecha": "2020-11-19",
    "hora": "09:24:30",
    "cliente": "GEOPAGOS",
    "programa": "GEOPAGOS",
    "codigoRespuesta": "00",
    "mensajeRespuesta": "EXITO",
    "operacion": "generarUrlToken",
    "datos": {
        "url": "{host}/proveedor/prestamos/U2FsdGVkX196xBEWPT4k1I1zWPQ4DPjer9XO0XeZQ+d29+MpFlnLBNS0Wn0AXLGS"
    }
}
500 Error Response

Estructura cuando sean errores

Body
Object
fecha
string required

Fecha de transacción

Example:
2020-11-19
hora
string required

Hora de transacción

Example:
10:41:01
codigoRespuesta
string required

Código de respuesta error

Example:
15
mensajeRespuesta
string required

Mensaje de error

Example:
ERROR INTERNO
operacion
string required

Operación realizada

Example:
webview/depositos/generaUrlToken
Examples
{
    "fecha": "2020-11-19",
    "hora": "10:41:01",
    "codigoRespuesta": "15",
    "mensajeRespuesta": "ERROR INTERNO",
    "operacion": "webview/depositos/generaUrlToken"
}
401 Unauthorized

Token invalido o expirado

Body
Object
fecha
string required

Fecha de transacción

Example:
12
hora
string required

Hora de transacción

Example:
2020-12-15
codigoRespuesta
string required

Código de respuesta error

Example:
12:29:58
operacion
string required

Operación realizada

Example:
webview/proveedores/generaUrlToken
mensajeRespuesta
string required

Mensaje de error

Example:
TOKEN INVÁLIDO O EXPIRADO
Examples
{
    "codigoRespuesta": "12",
    "fecha": "2020-12-15",
    "hora": "12:29:58",
    "operacion": "webview/proveedores/generaUrlToken",
    "mensajeRespuesta": "TOKEN INVÁLIDO O EXPIRADO"
}
Seguridad
Generacion Token de Seguridad
POST /vm-api-autorizacion/oauth/token
Generacion Token de Seguridad
POST /vm-api-autorizacion/oauth/token

La dirección base es https://auth2.vmas.com.pe. Este endpoint permite generacion de tokens de seguridad para el uso de los servicios

Request parameters

usuario
string required

Usuario para generación de token

clave
string required

Contraseña para generacion de token

Request headers

Authorization
string required

Autenticatión tipo Basic. Se genera con usuario y contraseña de header

Example:
Basic d14x51ow2cm32X5dzM1ByZDpzYTIxM2dkcw==

Request body

Responses

200 OK
Body
Object
token
string required

Token

Example:
eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJodHRwczovL3d3dy52ZW5kZW1hcy5jb20ucGUiLCJleHAiOjE2MDgwMTExMzEsInVzZXJuYW1lIjoidm1hc19wcm92X2FwcF9wcmQiLCJ0b2tlbl90eXBlIjoiQmVhcmVyICJ9.KONKzIdfI6rTAqDtU9LiRxyetRKbFWoieZMzBOILS4I
token_type
string required

Tipo de token

Example:
Bearer
exp
string required

Tiempo de expiración

Example:
1440