Kunde: Aktualisierung und Erstellung

Unsere API bietet einen speziellen Endpunkt zur Verwaltung der Erstellung und Änderung von Kunden- und Treuedaten. Dieser Endpunkt unterstützt eine Reihe von Aktualisierungen mit demselben API-Aufruf.

Es verwendet die E-Mail als primäre Kennung des Kunden und ein Enum, um anzugeben, welcher Teil der Kundeninformationen aktualisiert werden muss.
‍

Endpunkt

Um die Kunden zu verwalten, haben Sie denselben Endpunkt, um mehrere Kunden gleichzeitig hinzuzufügen und sie einzeln zu löschen.

POST https://api.jericommerce.com/v1/programs/{programId}/integrations/api
‍
Sie sollten die {programId} für Ihre echte Programm-ID, die Sie auf jericommerce finden konnten Einstellungen > Technik.
‍

Dieser Endpunkt ist durch einen Autorisierungskopf gesichert. Bitte lesen Sie unsere Dokumentation.

‍

Erstellen und Aktualisieren

Um Kunden zu erstellen oder hinzuzufügen, verwenden wir eine POST-Anforderung, die ein Array von Objekten akzeptiert.
So können Sie bis zu 100 Kunden mit einem einzigen API-Aufruf senden.

Wenn einer der Kunden gut funktioniert, geben Sie eine 201 zurück. Wenn alle fehlerhaft sind, wird ein 404 zurückgegeben.

Die Hauptschlüssel für jedes Objekt sind die E-Mail des Kunden und der Funktionsname, der immer "users" lautet, sowie die Nutzlast, die die Informationen enthält, die für einen Kunden hinzugefügt oder aktualisiert werden sollen.

Hier ist die Struktur des JSON:

1[
2  {
3    "email": "string",
4    "feature": "users",
5    "payload": {
6      "externalCustomerId": "string",
7      "name": "string",
8      "phone": "string",
9      "emailVerified": boolean,
10      "email": "string"
11    }
12  }
13]

Erläutern wir die Felder der Nutzlast nacheinander.

‍

E-Mail

Dieses Feld wird normalerweise ausgefüllt, wenn die E-Mail des Kunden aktualisiert werden muss.
Wenn Sie die E-Mail ändern, sollte die nächste API-Anfrage diese neue E-Mail als Kennung verwenden.
Die E-Mail-Eigenschaft in der Nutzlast ist normalerweise nicht bei jeder Aktualisierung vorhanden.
‍

externalCustomerId

Dies ist die Kennung außerhalb von Jericommerce, normalerweise die Kennung aus einer externen Datenbank.
Wird für jede Aktualisierung oder Erstellung benötigt.
‍

Name

Name des Kunden, der auf dem Brieftaschenausweis angezeigt wird.
Ist ein löschbarer Wert.

‍

Telefon

Telefon des Kunden
Standardmäßig ist der Wert Null. Wenn Sie keine Daten senden, wird das Feld nicht geändert.
‍

emailVerified

Die E-Mail-Adresse des Kunden wurde validiert.
Standardmäßig ist der Wert falsch. Wenn Sie ihn aktualisieren möchten, können Sie den richtigen Wert senden. Wenn keine Änderung erforderlich ist, können Sie das Senden vermeiden.

‍

‍

‍

Kunde löschen

Um einen Kunden zu löschen, verwenden Sie denselben API-Endpunkt, aber mit dem HTTP-Verb DELETE.
Um Kunden zu löschen, müssen Sie einen nach dem anderen löschen, und Sie sollten die E-Mail des zu löschenden Kunden mit Abfrageparametern senden.

‍

DELETE https://api.jericommerce.com/v1/programs/{programId}/integrations/api?email={customerEmail}
‍

Wenn alles gut geht, erhalten Sie eine Antwort von 201.

‍