Kunden-Kennungen
6 Endpunkte unter /api/rest/2.0
External customer identifiers (e.g. Google Places ID, Yelp, Apple Maps)
Endpunkte
Alle Pfade sind relativ zur Basis /api/rest/2.0 Ihrer ameax-Installation. Die Antworten folgen dem JSON:API-Format mit data, links und meta.
| Methode | Pfad | Beschreibung |
|---|---|---|
GET |
/customer-identifiers |
List all customer-identifiers |
POST |
/customer-identifiers |
Create a customer-identifier |
GET |
/customer-identifiers/{id} |
Get a customer-identifier |
PUT |
/customer-identifiers/{id} |
Update a customer-identifier |
PATCH |
/customer-identifiers/{id} |
Partially update a customer-identifier |
DELETE |
/customer-identifiers/{id} |
Delete a customer-identifier |
Felder
Diese Felder liefert die API zu Kunden-Kennungen. Dazu kommen die Zusatzfelder Ihrer eigenen Installation — sie werden nach denselben Regeln geprüft wie in der Oberfläche und erscheinen in der Spezifikation Ihres Mandanten.
| Feld | Typ | Beschreibung |
|---|---|---|
customer_id |
integer | Customer ID |
type |
string | Identifier type (e.g. google_places, yelp, apple_maps) |
identifier |
string | The external identifier value |
active |
boolean | Whether this identifier is active |
created_at |
date-time | Creation timestamp |
updated_at |
date-time | Last modification timestamp |
Zugriff
Jede Anfrage braucht ein API-Token im Kopf Authorization: Bearer <token>, wahlweise als Basic-Auth mit dem Benutzernamen api und dem Token als Passwort.
Das Token hängt an einem Benutzer und erbt dessen Rechte: Was dieser Benutzer in der Oberfläche nicht sehen darf, liefert die API auch nicht. Zusätzlich lassen sich je Token ein Ablaufdatum und eine IP-Beschränkung hinterlegen. Mehr dazu auf der API-Übersicht.
Anbindung besprechen.
Sie wollen ein System anbinden und wissen nicht, ob die Schnittstelle abdeckt, was Sie brauchen? Wir schauen es uns gemeinsam an — kostenlos und ohne Verpflichtung.