Unsere API bietet einen eigenen Endpunkt, über den Sie Kunden- und Treuedaten erstellen und bearbeiten können. Dieser Endpunkt unterstützt mehrere Aktualisierungen mit einem API-Aufruf.

Kunden werden anhand ihrer E-Mail-Adresse identifiziert. Ein Enum gibt an, welcher Teil der Kundeninformationen aktualisiert werden soll.

Endpunkt

Zum Verwalten von Kunden können Sie denselben Endpunkt verwenden, um mehrere Kunden gleichzeitig hinzuzufügen oder sie einzeln zu löschen.

// POST Endpoint

https://api.jericommerce.com/v1/programs/{program_slug}/integrations/api

Ersetzen Sie {program_slug} durch den tatsächlichen Program-Slug. Sie finden ihn in JeriCommerce unter Settings > Technical > Program Information.

Dieser Endpunkt wird über den Header api-key geschützt. Lesen Sie die Anleitung zur Authentifizierung.

Kunden erstellen und aktualisieren

Verwenden Sie zum Erstellen oder Hinzufügen von Kunden eine POST-Anfrage mit einem Array von Objekten. Mit einem einzelnen API-Aufruf können Sie bis zu 100 Kunden senden.

Wenn die Anfrage für mindestens einen Kunden erfolgreich ist, wird der Status 201 zurückgegeben. Wenn alle fehlschlagen, wird 404 zurückgegeben.

Die wichtigsten Schlüssel für jedes Objekt sind die E-Mail-Adresse des Kunden und der Funktionsname, der immer "users" lautet, sowie der Payload mit den hinzuzufügenden oder zu aktualisierenden Informationen.

Die JSON-Struktur sieht so aus:

[
 {
 "email": "string",
 "feature": "users",
 "payload": {
 "externalCustomerId": "string",
 "firstName": "string",
 "lastName": "string",
 "phone": "string",
 "emailVerified": boolean,
 "email": "string"
 }
 }
]

Im Folgenden werden die Payload-Felder einzeln erklärt.

email

Dieses Feld wird normalerweise ausgefüllt, wenn die E-Mail-Adresse des Kunden aktualisiert werden soll. Wird sie geändert, muss die nächste API-Anfrage die neue E-Mail-Adresse als Kennung verwenden. Bei gewöhnlichen Aktualisierungen fehlt die Eigenschaft email im Payload.

externalCustomerId

Dies ist die Kennung des Kunden außerhalb von JeriCommerce, normalerweise die ID aus einer externen Datenbank. Sie ist bei jeder Aktualisierung oder Erstellung erforderlich.

firstName

Der Vorname des Kunden wird auf der Treuekarte als Teil seines Namens angezeigt. Der Wert darf null sein.

lastName

Der Nachname des Kunden wird auf der Treuekarte als Teil seines Namens angezeigt. Der Wert darf null sein.

phone

Telefonnummer des Kunden. Standardmäßig ist der Wert null. Wenn Sie keine Daten senden, bleibt das Feld unverändert.

emailVerified

Gibt an, ob die E-Mail-Adresse des Kunden bestätigt wurde. Standardmäßig ist der Wert false. Um den Wert zu aktualisieren, senden Sie den passenden Wert. Wenn keine Änderung erforderlich ist, können Sie das Feld weglassen.

Kunden löschen

Verwenden Sie zum Löschen eines Kunden denselben API-Endpunkt, aber mit der HTTP-Methode DELETE. Kunden müssen einzeln gelöscht werden. Senden Sie dazu die E-Mail-Adresse des zu löschenden Kunden als Query-Parameter.

// DELETE Endpoint

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

Bei erfolgreicher Anfrage erhalten Sie eine 201-Antwort.