Zurück zur API-Übersicht

Kategorie-Zuweisungen

3 Endpunkte unter /api/rest/2.0

Customer to category assignments

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.

MethodePfadBeschreibung
GET /customer-categories List all customer-categorys
POST /customer-categories Create a customer-category
DELETE /customer-categories/{customer_id}/{cat_id} Remove a category from a customer

Felder

Diese Felder liefert die API zu Kategorie-Zuweisungen. 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.

FeldTypBeschreibung
customer_id integer Customer ID
cat_id integer Category ID

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.

Kostenfreie Beratung: +49 9454 94905420