top of page

Stand: 15.02.2024 - 08:39 Uhr

CWX API

Auf dieser Seite sind die Endpunkte beschrieben, welche durch unsere API ansprechbar sind.

Vor Nutzung der API-Funktionen muss im Backoffice unter dev.cwx.one (Sandbox) oder my.cwxc.one ein API-Key erstellt werden. Die Funktion ist unter "Meine Daten" im Backoffice zu finden. Dort kann der API-Key generiert werden. Bei Nutzung der API müssen sich Nutzer mit Ihrer CWX-ID und diesem API-Key über Basic Authentification einloggen. Die eigene CWX-ID dient dabei als eindeutiger Benutzername und der geheime API-Key als Passwort.

Der Sandbox-Server ist dev.cwx.one

Der Live-Server ist my.cwx.one

Zur Simulation können folgende Parameter von crossworkern (Empfehler) und Produktpartner im DEV-System benutzt werden. Diese haben KEINE Gültigkeit im Live-System:

PP-ID: 64305446

CWX-ID: 26455939

Wichtiger Hinweis:

Die coinX-Funktion muss nicht zwangsläufig mit dem Bonus kombiniert werden. Der Bonus kann für sich alleine stehen. Dies für den Anwendungsfall, dass von einem Produktpartner die Einlösung von coinX zur Rabattierung des Warenkorbwertes nicht gewünscht ist.

Für folgende eCommerce Systeme existieren bereits umfassende kostenfreie Plugins:

shopware AG

https://store.shopware.com/cogi985486536124f/crossworx-integration-empfehlungsmarketing.html

An Plugins für shopify, OXID, WooCommerce, Prestashop und weiteren wird derzeit gearbeitet. Wir werden diese hier veröffentlichen.

Status: *** Diese API-Beschreibung ist aktuell ***

Prüfung, ob eine CWX-ID existiert

https://server/api/partner/check-cwx-id

Parameter: 
id - CWX-ID des Nutzers

Diese Abfrage dient dazu, zu prüfen, ob eine übermittelte crossworx-ID (CWX-ID) existiert. es wird eine positive oder negative Validierungsmitteilung zurückgegeben.

2

Speichern einer Bonus-Transaktion 

https://server/api/partner/write-transaction

Parameter: 
ppnumber - CWX-ID des Produktpartners
tpnumber - CWX-ID des crossworkers
price - Preis der Transaktion
ordernumber - Bestellnummer/Transaktionsnummer zur Identifizierung

Diese Funktion schreibt eine Euro-Bonus-Transaktion in den Datensatz des betreffenden crossworkers. Das System stellt fest, welche weiteren crossworker noch bonusberechtigt sind in der Struktur und speichert ebenfalls den Bonus bei diesen crossworkern automatisch. In der App werden diese Werte in Echtzeit verarbeitet und dem Nutzer angezeigt.

3

Gibt CoinX Kontostand eines Nutzers zurück

https://server/api/partner/get-coinx-balance

Parameter: 
id - CWX-ID des Nutzers

Diese Abfrage gibt den coinX-Kontostand eines Nutzers zurück. Dieser kann an beliebigen Stellen eingebunden werden und dazu dienen zu prüfen, ob der crossworker genug coinX zur Inanspruchnahme in der aktuellen Transaktion zur Verfügung hat.

4

Gibt den maximalen CoinX-Wert für einen Warenkorbwert zurück

https://server/api/partner/get-max-coinx-discount

Parameter: 
id - CWX-ID des Produktpartners
value - Warenkorbwert aus dem der maximale CoinX-Abzug berechnet wird

Diese Abfrage gibt den maximal möglichen coinX-Wert für einen Warenkorbwert zurück. Der zugrunde liegende globale Wert (in % vom Warenkorbwert) wird vom Produktpartner im geschützten Backoffice selbst vergeben und kann jederzeit durch ihn angepasst werden. Diese Abfrage berechnet auf dieser Basis den maximal eingesetzten coinX-Wert der bevorstehenden aktuellen Transaktion.

5

Löst die CoinX eines Crossworkers bei einem Produktpartner ein

https://server/api/coinx/redeem

Parameter: 
ppid - CWX-ID des Produktpartners
tpid - CWX-ID des crossworkers
coinx - CoinX Anzahl, die eingelöst werden sollen
transaction_id - Belegnummer/Transaktionsnummer zur Identifizierung

Diese Abfrage übermittelt die eingelösten coinX der betreffenden Transaktion an die Datenbank und bucht diese beim betreffenden crossworker vom bestehenden coinX-Guthaben ab.

6

Gibt den Einladungslink eines crossworkers zurück

https://server/api/partner/get-referrer-link

Parameter: 
id - CWX-ID des Nutzers

Diese Funktion gibt den Einladungslink eines crossworkers zurück. Dieser Einladungslink wird bei der Registrierung eines crossworkers automatisch erzeugt und verändert sich lifetime nicht mehr. Er steht zum Abruf in der Datenbank bereit.

7

Registrieren eines neuen Crossworkers

https://server/api/partner/register-crossworker

Parameter: 
id - CWX-ID des einladenden Nutzers
first_name - Vorname des anzulegenden Nutzers
last_name - Nachname des anzulegenden Nutzers
email - E-Mail-Adresse des anzulegenden Nutzers

Diese Abfrage sendet die Daten zur Registrierung eines neuen crossworkers an das System. Damit ist beispielsweise eine Registrierung eines crossworkers direkt aus dem Checkout-Bereich eines eCommerce Shops möglich, ohne diesen verlassen zu müssen. Der neu registrierte crossworker kann seine ID, welche er per Mail erhält, gleich zur Bonifizierung der geplanten Bestellung einsetzen.

8

Gibt den aktuellen Gesamtbonus-Kontostand eines Nutzers zurück

https://server/api/partner/get-total-bonus

Parameter: 
id - CWX-ID des Nutzers

Diese Abfrage gibt den Gesamt-Kontostand des bisher angesammelten Bonus zurück.

bottom of page