Diese API ermöglicht Nutzern den Zugriff auf Shop-Bargeldangebote, Transaktionen und Wallet-Informationen sowie die effiziente Verwaltung von Gutscheinen, Empfehlungen und Stufeninformationen.
Authentifizierung
Um auf die API zuzugreifen, müssen Sie einen API-Schlüssel in Ihren Anfrage-Headern angeben.
Header:
Autorisierung: Inhaber IHR_API_SCHLÜSSEL
Akzeptieren: application/json
wpcb: ja
Wie generiert man den Webplanex Wallet API-Schlüssel?
1. Melden Sie sich im WebplanexWallet-Administrationsbereich an.
2. Gehen Sie zu Integrationen > Webplanex Wallet APIs.
3. Klicken Sie auf „Token abrufen“. Schaltfläche zum Generieren eines Tokens für den Shop.
Basis-URL
Alle API-Endpunkte sind über die folgende Basis-URL erreichbar:
https://cashback.webplanex.com/
Endpunkte
1. Angebote abrufen
Endpunkt: /api/offers?shop={{shopify store url}}&customer={{shopify customer id}}
Methode: GET
Beschreibung: Liste aller verfügbaren Cashback-Angebote abrufen.
Antwort:
200 OK
{
Währung: Rs.
Status: 200
Nachricht: Erfolgreich
Daten: {
0: {
ID: 1
"Name": "Gesamtkauf",
"Anwendungsdatum": "",
"Menge": 0,
"Beschreibung": "Erhalten Sie 20 % Rabatt auf Ihren Einkauf ab einem Gesamtkaufwert von 1 Rupien",
"Typ": 4,
... "show_description": "Sie erhalten 20 % Rabatt auf Ihren Einkauf ab einem Gesamtwert von 1 Rupien.",
"getOfferTypeName": "Gesamtkauf"
},
"1": {
"id": 2,
... "Typ": 0,
"Erstellt am: "26.12.2023, 10:19:12.000000Z",
"Aktualisiert am: "11.07.2024, 04:06:59.000000Z",
"Link-Attr anzeigen": ",
"show_description": "<a href=\"/collections/hydrogen\>Sammlungsangebotstest Wasserstoff</a>",
"getOfferTypeName": "Bargeld für Produkte ODER Sammlungen speichern"
"Pfad": "https://cashback.webplanex.com/api/offers",
"pro_Seite": 10,
"nächster_Cursor": null,
"vorheriger_Cursor": null,
"vorherige_Seite_URL": null
}
}
2. Gutscheine abrufen
Endpunkt: /api/coupons?shop={{shopify store url}}
Methode: GET
Beschreibung: Liste allerVerfügbare Gutscheine.
Antwort:
200 OK
{
"Status": 200,
"Nachricht": "Erfolgreich",
"Daten": {
"123": {
"Code": "xcodecodetset",
& ... Gutschein endet am: 14. August 2024.
Anhängetyp: %.
Endwert: 1 %.
Details: [
„1 % Rabatt auf Kollektionsaccessoires“,
„Alle Kunden“,
„Gültig ab 07.08.2024“
]
},
„456“: {
... Gutschein endet am: 14. August 2024.
Anhängetyp: %.
Endwert: 1 %.
Details: [
„1 % Rabatt auf Kollektionsaccessoires“
„Alle Kunden“
„Gültig ab 07.08.2024“
]
}
}
}
3. Empfehlungslink generieren
Endpunkt: /api/referrals?shop={{shopify store url}}
Methode: POST
Beschreibung: Empfehlungslink generieren
Anfragetext:
{
"Kunden-ID": "{{shopify-Kunden-ID}}"
}
Antwort:
200 OK
{
"Status": 200,
"Nachricht": "Erfolgreich"
}
4. Empfehlungslink abrufen
Endpunkt: /api/referrals/{{shopify-Kunden-ID}}?shop={{shopify-Shop-URL}}
Methode: GET
Beschreibung: Empfehlungslink abrufen
Antwort:
200 OK
{
"Status": 200,
"Nachricht": "Erfolgreich",
"Daten": {
"Referral-URL": "https://xyz.com/d296ef"
}
}
5. Kunden-Wallet abrufen
Endpunkt: /api/customerwallet/{{shopify-Kunden-ID}}?shop={{shopify-Shop-URL}}
Methode: GET
Beschreibung: Meine Wallet-Informationen abrufen
Antwort:
200 OK
{
„Status“: 200,
"Nachricht": "Erfolgreich",
"Daten": {
"Währung": "Rs.",
"Guthaben": [
{
&