Autenticación
Para acceder a la API, debe incluir una clave de API en los encabezados de su solicitud.
Encabezado:
Autorización: Portador YOUR_API_KEY
Aceptar: application/json
wpcb: sí
¿Cómo generar la clave de API de Webplanex Wallet?
1. Inicie sesión en su área de administración de Webplanex Wallet. 2. Vaya a Integraciones > API de Webplanex Wallet. 3. Haga clic en "Obtener token". Botón para generar tokens para la tienda.
URL base
Se puede acceder a todos los puntos finales de la API a través de la siguiente URL base:
https://cashback.webplanex.com/
Puntos finales
1. Obtener ofertas
Punto final: /api/offers?shop={{url de la tienda Shopify}}&customer={{id del cliente Shopify}} Método: GET Descripción: Obtener una lista de todas las ofertas de efectivo disponibles en la tienda. Respuesta: 200 OK { 2. Obtener cupones Punto final: /api/coupons?shop={{url de la tienda Shopify}} Método: GET Descripción: Obtener una lista de todos los cuponesCupones disponibles. Respuesta: 200 OK { 3. Generar enlace de referencia
Punto final: /api/referrals?shop={{url de la tienda Shopify}} Método: POST Descripción: Generar enlace de referencia
Cuerpo de la solicitud: { Respuesta: 200 OK { 4. Obtener enlace de referencia
Punto final: /api/referrals/{{ID de cliente de Shopify}}?shop={{URL de la tienda Shopify}} Método: GET Descripción: Obtener un enlace de referencia
Respuesta: 200 OK { 5. Obtener la billetera del cliente
Punto final: /api/customerwallet/{{ID de cliente de Shopify}}?shop={{URL de la tienda Shopify}} Método: GET Descripción: Obtener información de mi billetera
Respuesta: 200 OK {
Moneda: Rs.
Estado: 200
Mensaje: Éxito
Datos: {
0: {
ID: 1 "Nombre": "Compra total",
"Aplicar en": "",
"Cantidad": 0,
"Descripción": "Obtén un 20% de descuento en efectivo en compras mínimas de 1 rupia".
"Tipo": 4,
"creado_en": "2023-12-07T12:03:27.000000Z",
"actualizado_en": "2024-06-20T06:07:49.000000Z",
" "show_link_attr": "style=\"text-decoration: none;\"",
"show_description": "Obtén un 20% de descuento en efectivo en compras mínimas de 1 rupia.",
"getOfferTypeName": "Compra total"
},
"1": {
"id": 2,
"nombre": "Prueba de oferta de colección",
"aplicar_en": "colección",
"cantidad": 0,
"descripción": "<a href=\"/collections/hydrogen\">Prueba de oferta de colección Hydrogen</a>",
"tipo": 0,
"creado_en": "2023-12-26T10:19:12.000000Z",
"actualizado_en": "2024-07-11T04:06:59.000000Z",
""""atributo_del_enlace": "",
" "show_description": "<a href=\"/collections/hydrogen\">Prueba de oferta de colección Hydrogen</a>",
" "getOfferTypeName": "Ahorra dinero en productos o colecciones"
Ruta: https://cashback.webplanex.com/api/offers
Por página: 10
Siguiente cursor: nulo
URL siguiente página: nulo
Cursor anterior: nulo
URL página anterior: nulo }
}
"estado": 200,
"mensaje": "Éxito",
datos": {
"123": {
"código": "xcodecodetset",
"tipo_valor": "porcentaje",
"valor": 1,
""cupón_inicia_en": "07 ago. 2024",
Fecha de finalización del cupón: 14 de agosto de 2024
Tipo de anexo: %
Valor final: 1%
Detalles: [ "1% de descuento en accesorios de colección",
"Todos los clientes",
"Válido desde el 7 de agosto de 2024"
]
},
"456": {
... Fecha de finalización del cupón: 14 de agosto de 2024
Tipo de anexo: %
Valor final: 1%
Detalles: [ 1% de descuento en accesorios de colección.
Todos los clientes.
Válido desde el 7 de agosto de 2024.
Válido desde el 7 de agosto de 2024.
}
}
}
"customer_id": "{{ID de cliente de Shopify}}"
}
Estado: 200,
Mensaje: "Éxito"
}
Estado: 200,
Mensaje: "Éxito",
Datos: {
URL de referencia: "https://xyz.com/d296ef"
}
}
Estado: 200,
"Mensaje": "Éxito",
"Moneda": "Rs.",
"Saldo": [
{
&