Basis-URL
https://{tenant}.logzi.com/api/company_user/
Jede Anfrage liefert eine JSON-Antwort zurück. Bei Erfolg ist result.code == 1, im Fehlerfall result.code == 0.
/api/company_user/get
Abruf eines einzelnen Mitarbeiters anhand von ID oder Benutzername.
Query-Parameter
| Parameter | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
id | int | Eindeutige Kennung des Mitarbeiters | |
username | string | Abruf ist auch anhand des Benutzernamens möglich |
Beispielanfrage
GET /api/company_user/get?id=3
X-API-KEY: {ihr_api_schluessel}
/api/company_user/list
Abruf einer paginierten Liste von Mitarbeitern mit Filtermöglichkeiten.
Query-Parameter
| Parameter | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
list_offset | int | Versatz für die Seitenblätterung (Standard: 0) | |
list_condition | array | Array der Filterbedingungen |
Beispielanfrage
GET /api/company_user/list?list_offset=0
X-API-KEY: {ihr_api_schluessel}
/api/company_user/save
Anlegen oder Ändern eines Mitarbeiters mit Angabe von Berechtigungen und Zugriffseinstellungen. Für einen neuen Mitarbeiter data[id] = 0.
POST-Felder — data-Objekt
| Feld | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
id | int | 0 = neuer Mitarbeiter, >0 = Änderung | |
company_id | int | Kennung des Unternehmens | |
username | string | Anmelde-Benutzername | |
password_new1 | string | Passwort (bei neuem Benutzer erforderlich) | |
password_new2 | string | Passwortbestätigung (bei neuem Benutzer erforderlich) | |
default_store_id | int | Kennung des Standardlagers | |
superior_company_user_id | int | Kennung des vorgesetzten Mitarbeiters | |
company_user_store_checked | array | Liste der zugelassenen Lager-IDs | |
company_user_paymod_checked | array | Liste der zugelassenen Zahlungsarten-IDs | |
company_user_cash_stock_checked | array | Liste der zugelassenen Kassenbestands-IDs |
Beispielanfrage
POST /api/company_user/save
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json
{
"data": {
"id": 0,
"company_id": 1,
"username": "kiss.janos",
"password_new1": "titkos123",
"password_new2": "titkos123",
"default_store_id": 1
}
}
/api/company_user/delete
Löschen eines Mitarbeiters anhand seiner Kennung.
POST-Felder — data-Objekt
| Feld | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
id | int | Kennung des zu löschenden Mitarbeiters |
Beispielanfrage
POST /api/company_user/delete
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json
{ "data": { "id": 3 } }
/api/company_user/save_interface
Speichern der Benutzeroberflächeneinstellungen für den jeweiligen Mitarbeiter.
POST-Felder — data-Objekt
| Feld | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
id | int | Kennung des Mitarbeiters |
Beispielanfrage
POST /api/company_user/save_interface
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json
{ "data": { "id": 3 } }
/api/company_user/login
Prüfung der Anmeldedaten eines Mitarbeiters (Benutzername-/Passwort-Paar). Bei Erfolg werden die Benutzerdaten zurückgegeben.
Query-Parameter
| Parameter | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
username | string | Anmelde-Benutzername | |
password | string | Passwort |
Beispielanfrage
GET /api/company_user/login?username=kiss.janos&password=titkos123
X-API-KEY: {ihr_api_schluessel}
/api/company_user/save_password
Ändern des Passworts eines Mitarbeiters.
POST-Felder — data-Objekt
| Feld | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
id | int | Kennung des Mitarbeiters | |
password_new1 | string | Neues Passwort | |
password_new2 | string | Bestätigung des neuen Passworts |
Beispielanfrage
POST /api/company_user/save_password
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json
{
"data": {
"id": 3,
"password_new1": "ujtitkos456",
"password_new2": "ujtitkos456"
}
}
Interessierst du dich für unsere Software? Schreib uns einfach!
Jetzt registrieren,
später bezahlen!