Einleitung
Um die Orders nicht händisch, sondern durch einen automatisierten Prozess im easy.affiliate-System bearbeiten zu können, wird von der easy Marketing GmbH eine Webservice-API zur Verfügung gestellt, um bereits bestehende Orders im Nachgang zu bearbeiten, sobald diese den Validierungsprozess durchlaufen. Hierfür steht jedem User ein Authentifizierungs-Token und eine Login_id zur Verfügung gestellt. Der Authentifizierungs-Token sowie die Login_id werden dem User über das Frontend zur Verfügung gestellt.
User-ID: Wo ist die User-ID hinterlegt?
Access-Token: Wo ist der Access-Token hinterlegt?
Update als Admin:
https://SUBDOMAIN.de/ws/V6/admin/JSON/Orders
Update als Advertiser:
https://SUBDOMAIN.de/ws/V6/advertiser/JSON/Orders
Beispiel mit cURL
curl -X PUT -H "Content-Type: application/json" -H "X-Network-ID: -1" -H "X-Auth-Token: ADMIN_APIUSER_TOKEN" -H "X-Auth-ID: ADMIN_APIUSER_LOGIN_ID" -d "[{ "campaign_id": 1, "id": 12345, "status": 1, "turnover":100.00, "commission":12.34 },{ "campaign_id": 1, "ordertoken":"123a456b", "status": 2, "turnover": 0.00 }]" https://DOMAIN/ws/V6/admin/JSON/Orders |
|---|
Codebeispiel
Mit der folgenden Methode können mehrere Orders geupdatet werden. Ein Beispielaufruf sieht folgendermaßen aus:
Headers |
Content-Type: application/json X-Network-ID: -1 X-Auth-Token: ADMIN_APIUSER_TOKEN X-Auth-ID: ADMIN_APIUSER_LOGIN_ID |
Body |
[ |
Variablenerläuterung
Headers | ||
Variable | Bedeutung | Datentyp |
Content-Type | Der Content-Type des Requests | String |
X-NETWORKID | Hier wird die ID des Mandanten eingetragen. Wenn nur ein Mandant vorhanden ist oder mandantenübergreifend gearbeitet wird, muss der Wert “-1” eingetragen werden. | Integer |
X-AUTH-TOKEN | Hier wird der API-Authentifizierungs-Token des Admin Nutzers hinterlegt. | String |
X-AUTH-ID | Hier wird die ID des Admin Nutzers hinterlegt. | Integer |
Im nachfolgenden werden die Standard-Parameter aufgelistet. Es ist aber über die API möglich, alle zur Verfügung stehenden Parameter zu updaten.
Body | |||
Parameter | Erklärung | Datentyp | Pflichtfeld |
id | Hier wird die Transaktionsid hinterlegt. Aufbau: “id”:”ID” | String | Ja (oder “ordertoken”) |
ordertoken | Hier wird der Ordertoken hinterlegt. Aufbau: “ordertoken”:”ORDERTOKEN” | String | Ja (oder “id”). Wird der Ordertoken genutzt, ist neben der Campaign ID auch die Trigger ID ein Pflichtfeld. |
campaign_id | Hier wird die Campaign_id hinterlegt. Aufbau: “campaign_id”:CAMPAIGN_ID | Integer | Ja |
trigger_id | Hier wird die Trigger ID hinterlegt Aufbau: “trigger_id”:TRIGGER_ID | Integer | Nein, nur falls Ordertoken genutzt wird. |
status | Hier wird der Status hinterlegt. Status: 0 - offen 1 - bestätigt 2 - storniert Aufbau: “status”:STATUS | Integer | Nein |
turnover | Hier wird der Bestellwert der Transaktion in Kampagnenwährung hinterlegt. Aufbau: “turnover”:TURNOVER | float | Nein |
original_turnover | Hier wird der Bestellwert der Transaktion in Fremdwährung hinterlegt. Aufbau: “original_turnover”:TURNOVER_IN_FREMDWÄHRUNG | float | Nein |
commission | Hier wird die Provisionshöhe in Kampagnenwährung hinterlegt, falls Sie die Commission selbst berechnen möchten Aufbau: “commission”:COMMISSION | float | Nein |
cancel_reason | Übergeben Sie den Stornogrund. | string | Nein |