API

Die technische Seite der crossworx ID.

Die API verbindet externe Shops, Plattformen und Partnerprozesse mit der crossworx ID. So bleiben Registrierung, Prüfung und Transaktion sauber anschlussfähig.

API Layer

ID, Transaktion und Partnerlogik technisch verbinden.

Die API ist für Partner gedacht, die crossworx nicht nur verlinken, sondern direkt in eigene Prozesse integrieren möchten.

Einsatz

Prüfen, buchen, registrieren und Bonuslogik auslösen.

Kern

Die crossworx ID bleibt über alle Systeme hinweg dieselbe Referenz.

Protokoll REST API

HTTPS-Endpunkte für Partner, eCommerce-Systeme, Plattformen und externe Anwendungen.

Authentifizierung Basic Auth

CWX-ID als Nutzername und generierter API-Key als Passwort für die abgesicherte Kommunikation.

Umgebungen Sandbox & Live

dev.cwx.one für Tests und my.cwx.one für produktive Integrationen.

Endpoint-Übersicht

Von der ID-Prüfung bis zur Bonus-Transaktion.

Die API ist dort wichtig, wo externe Systeme mehr tun sollen als weiterleiten: ID prüfen, Transaktionen buchen, CoinX nutzen oder Registrierung direkt einbetten.

Die Endpunkte bilden den aktuellen technischen Kern ab und halten Partnerprozesse mit der crossworx ID verbunden.

01

Check CWX-ID

/api/partner/check-cwx-id

Parameter: id. Prüft, ob eine angegebene CWX-ID existiert.

02

Save Bonus Transaction

/api/partner/write-transaction

Parameter: ppnumber, tpnumber, price, ordernumber.

03

CoinX Balance

/api/partner/get-coinx-balance

Parameter: id. Liefert den aktuellen CoinX-Bestand eines Nutzers.

04

Max CoinX Value

/api/partner/get-max-coinx-discount

Parameter: id, value. Berechnet den maximal möglichen CoinX-Anteil.

05

Redeem CoinX

/api/coinx/redeem

Parameter: ppid, tpid, coinx, transaction_id.

06

Referral Link

/api/partner/get-referrer-link

Parameter: id. Liefert den Lifetime-Referrer-Link der zugehörigen crossworx ID.

07

Register Crossworker

/api/partner/register-crossworker

Parameter: xname, first_name, last_name, email.

08

Total Bonus

/api/partner/get-total-bonus

Parameter: id. Gibt den kumulierten Bonusstand zurück.

09

Own xName

/api/partner/get-xname

Parameter: none. Liefert das xName des authentifizierten Nutzers.

Schnellregistrierung

Schneller Einstieg für externe Flächen.

Wenn Registrierung nicht auf der Hauptplattform stattfinden soll, kann der Einstieg direkt in bestehende Oberflächen eingebettet werden.

Embed

Iframe für direkte Registrierung.

Ersetze your_xname durch das gewünschte xName-Ziel. So kann eine externe Plattform Nutzer in die crossworx Logik überführen, ohne den Kontext komplett zu verlieren.

<iframe id="cwx-quick-register"
  src="https://my.cwx.one/quick-register-form?xname=your_xname"
  style="height:500px; width:100%;"></iframe>

Integration

Wenn externe Systeme Wert erzeugen, müssen sie anschlussfähig an die Kernlogik sein.

Die API macht aus externen Systemen angebundene Partnerflächen, die mit derselben ID und denselben Transaktionsdaten arbeiten können.