Die Custom-API-Integration verbindet JeriCommerce mit einem System, das Ihr Team entwickelt hat oder betreibt, etwa einem CRM oder einem bestehenden Treueprogramm. Sie funktioniert in beide Richtungen:
- Ihr System sendet Daten an JeriCommerce: Kunden sowie ihren Punktestand und ihre Stufe, damit ihre Treuekarte immer Ihre Daten zeigt.
- JeriCommerce sendet Ereignisse an Ihr System: jedes Kundenereignis, etwa eine installierte Karte oder eine eingelöste Prämie, als Webhook an Ihren Server.
Sie brauchen diese Integration nur, wenn Ihr eigenes System die maßgebliche Quelle ist oder Sie Ereignisse empfangen möchten. Um aus Ihrem Code auf ein JeriCommerce-Treueprogramm zuzugreifen, etwa um Punkte zu vergeben oder einen Coupon zuzuweisen, brauchen Sie sie nicht: Verwenden Sie die Aktionen unter Automatisierungen mit einem API-Schlüssel.
Aktivieren ¶
Integration öffnen
Gehen Sie in JeriCommerce zu Settings > Integrations > API.
Webhook-Angaben eintragen
Tragen Sie unter Webhook URL (where you receive our updates) die URL Ihres Servers ein, der die Ereignisse empfangen soll. Tragen Sie unter Secret den Wert ein, mit dem JeriCommerce sie signiert, damit Ihr Server prüfen kann, dass sie echt sind.
Funktionen auswählen
Schalten Sie die Funktionen ein, die Sie brauchen, und klicken Sie dann auf Save.
| Funktion | Einschalten, wenn | Anleitung |
|---|---|---|
| Customer | Ihr System Kunden in JeriCommerce erstellt und aktualisiert. | Kunden synchronisieren |
| Loyalty | Ihr Treueprogramm in einem anderen System läuft und JeriCommerce den von Ihnen gesendeten Punktestand und die Stufe anzeigen soll. | Loyalty-Informationen synchronisieren |
| Events | Ihr Server jedes Kundenereignis empfangen soll. | Events-Webhook |
Wenn Sie Loyalty ausschalten, werden die Treueinformationen (Punktestand, Stufenstatus und Mitgliedsdatum) jedes Kunden im Programm gelöscht. Schalten Sie die Funktion nur aus, wenn Sie zu einem anderen Treueprogramm wechseln, und senden Sie die Punktestände erneut, wenn Sie sie wieder einschalten.
Authentifizierung ¶
Die Synchronisierungs-Endpunkte verwenden denselben API-Schlüssel wie der Rest der API, im Header api-key. Siehe Authentifizierung über die API. Ist die Integration oder die Funktion nicht eingeschaltet, antworten sie mit 403 und API_INTEGRATION_REQUIRED, API_USERS_REQUIRED oder API_LOYALTY_REQUIRED.
An Ihren Server gesendete Ereignisse werden mit Ihrem Secret im Header x-jericommerce-hmac-sha256 signiert. Wie Sie das prüfen, steht im Events-Webhook.