Kunden-Accounts
12 Endpunkte unter /api/rest/2.0
Customer login accounts (Kunden-Logins)
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 |
/accounts |
List all accounts |
POST |
/accounts |
Create a account |
POST |
/accounts/login |
Execute account login |
GET |
/accounts/{id} |
Get a account |
PUT |
/accounts/{id} |
Update a account |
PATCH |
/accounts/{id} |
Partially update a account |
DELETE |
/accounts/{id} |
Delete a account |
POST |
/accounts/{id}/reset-password |
Reset account password |
GET |
/accounts/{id}/roles |
List account roles |
POST |
/accounts/{id}/roles |
Assign role to account |
DELETE |
/accounts/{id}/roles/{role_id} |
Remove role from account |
POST |
/accounts/{id}/send-credentials |
Send login credentials via email |
Felder
Diese Felder liefert die API zu Kunden-Accounts. 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 this account belongs to |
person_id |
integer | Contact person ID (optional, 0 = no person linked) |
login |
string | Login name (unique identifier for authentication). Use "auto" to generate automatically. |
status |
string | Account status |
email_available |
boolean | Email is available for this account (computed from customer/person) |
forbid_changepw |
boolean | Prevent user from changing their password |
memo_report |
boolean | Receive memo/message reports |
task_report |
boolean | Receive task reports |
document_report |
boolean | Receive document reports |
lastlogin_at |
datetime | Last successful login timestamp |
password_changed_at |
datetime | Last password change timestamp |
confirmed_at |
datetime | Email confirmation timestamp |
credentials_sent_at |
datetime | Last credentials email sent timestamp |
created_by |
integer | User ID who created this account |
created_at |
datetime | Creation timestamp |
updated_by |
integer | User ID who last updated this account |
updated_at |
datetime | Last update 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.