Questa API consente agli utenti di recuperare offerte in contanti, transazioni, informazioni sul portafoglio e di gestire efficacemente coupon, referral e informazioni sui livelli.
Autenticazione
Per accedere all'API, è necessario includere una chiave API nelle intestazioni della richiesta.
Intestazione:
Autorizzazione: Bearer YOUR_API_KEY
Accettazione: application/json
wpcb: sì
Come generare la chiave API del Portafoglio Webplanex?
1. Accedi all'area di amministrazione del tuo Portafoglio Webplanex.
2. Vai su Integrazioni > API del Portafoglio Webplanex.
3. Fai clic su "Ottieni token" pulsante per generare il token per il negozio.
URL di base
Tutti gli endpoint API sono accessibili tramite il seguente URL di base:
https://cashback.webplanex.com/
Endpoint
1. Ottieni offerte
Endpoint: /api/offers?shop={{shopify store url}}&customer={{shopify customer id}}
Metodo: GET
Descrizione: Recupera un elenco di tutte le offerte in contanti disponibili nel negozio.
Risposta:
200 OK
{
"valuta": "Rs.",
"stato": 200,
"messaggio": "Riuscito",
"dati": {
"0": {
"id": 1,
"nome": "Totale acquisto",
"applica_su": "",
"quantità": 0",
"descrizione": "Ottieni il 20% di sconto in negozio su un acquisto totale minimo di 1 rupia",
"tipo": 4",
"created_at": "2023-12-07T12:03:27.000000Z",
" "updated_at": "2024-06-20T06:07:49.000000Z",
" ... "show_description": "Ottieni il 20% di sconto in negozio su un acquisto totale minimo di 1 rupia.",
"getOfferTypeName": "Acquisto totale"
},
"1": {
"id": 2,
"nome": "Test offerta di raccolta",
"apply_on": "raccolta",
"quantità": 0,
"descrizione": "<a href=\"/collections/hydrogen\">Test offerta di raccolta Idrogeno</a>",
"type": 0,
"created_at": "2023-12-26T10:19:12.000000Z",
"updated_at": "2024-07-11T04:06:59.000000Z",
" "show_link_attr": ",
"show_description": "<a href=\"/collections/hydrogen\">Test offerta Collezione Idrogeno</a>",
" "getOfferTypeName": "Ricarica denaro su Prodotti O Collezioni"
},
"percorso": "https://cashback.webplanex.com/api/offers",
"per_pagina": 10,
"next_cursor": null,
"next_page_url": null,
"prev_cursor": null,
"prev_page_url": null
}
}
2. Ottieni coupon
Endpoint: /api/coupons?shop={{shopify store url}}
Metodo: GET
Descrizione: Recupera un elenco di tutticoupon disponibili.
Risposta:
200 OK
{
"stato": 200,
"messaggio": "Riuscito",
"dati": {
"123": {
"codice": "xcodecodetset",
"tipo_valore": "percentuale",
"valore": 1",
"coupon_starts_at": "07_ago_2024",
"coupon_ends_at": "14 ago 2024",
"append_type": "%",
"final_value": "1%",
"details": [
"Sconto dell'1% sugli accessori della collezione",
"Tutti i clienti",
"Attivo dal 7 agosto 2024"
]
},
"456": {
"value_type": "percentage",
"value": 1",
"coupon_starts_at": "07 ago 2024",
"coupon_ends_at": "14 ago 2024",
"append_type": "%",
"final_value": "1%",
"details": [
"Sconto dell'1% sugli accessori della collezione",
"Tutti i clienti",
"Attivo dal 7 agosto 2024"
]
}
}
}
3. Genera link di referral
Endpoint: /api/referrals?shop={{URL del negozio Shopify}}
Metodo: POST
Descrizione: Genera link di referral
Corpo della richiesta:
{
"customer_id": "{{shopify customer id}}"
}
Risposta:
200 OK
{
"stato": 200,
"messaggio": "Riuscito"
}
4. Ottieni link di referral
Endpoint: /api/referrals/{{shopify customer id}}?shop={{shopify store url}}
Metodo: GET
Descrizione: Recupera un link di referral
Risposta:
200 OK
{
"stato": 200,
"messaggio": "Riuscito",
"dati": {
"referral_url": "https://xyz.com/d296ef"
}
}
5. Ottieni il Portafoglio Cliente
Endpoint: /api/customerwallet/{{ID cliente Shopify}}?shop={{URL negozio Shopify}}
Metodo: GET
Descrizione: Recupera le informazioni del mio portafoglio
Risposta:
200 OK
{
"stato": 200,
"messaggio": "Riuscito",
"dati": {
"valuta": "Rs.",
"saldo": [
{
&