Kategorien
7 Endpunkte unter /api/rest/2.0
Customer categories (hierarchical/nested set)
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 |
/categories |
List all categorys |
POST |
/categories |
Create a category |
GET |
/categories/tree |
Get the category tree |
GET |
/categories/{id} |
Get a category |
PUT |
/categories/{id} |
Update a category |
PATCH |
/categories/{id} |
Partially update a category |
DELETE |
/categories/{id} |
Delete a category |
Felder
Diese Felder liefert die API zu Kategorien. 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 |
|---|---|---|
parent_id |
integer | Parent category ID (0 = root level) |
name |
string | Category name |
color |
string | Display color (hex, e.g. #FF0000) |
sort |
integer | Left value in nested set (managed automatically) |
nextsort |
integer | Right value in nested set (managed automatically) |
layer |
integer | Depth level (1 = root, managed automatically) |
searchable |
boolean | Whether category appears in search filters |
createable |
boolean | Whether category can be assigned to new customers |
customer_list |
boolean | Whether category appears in customer list filter |
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.