Mitarbeiter API

Verwaltung von Unternehmensbenutzern (Mitarbeitern) — Abruf, Erstellung, Anmeldung und Passwortänderung

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.

GET /api/company_user/get

Abruf eines einzelnen Mitarbeiters anhand von ID oder Benutzername.

Query-Parameter

ParameterTypPflichtfeldBeschreibung
idintEindeutige Kennung des Mitarbeiters
usernamestringAbruf ist auch anhand des Benutzernamens möglich

Beispielanfrage

GET /api/company_user/get?id=3
X-API-KEY: {ihr_api_schluessel}
GET /api/company_user/list

Abruf einer paginierten Liste von Mitarbeitern mit Filtermöglichkeiten.

Query-Parameter

ParameterTypPflichtfeldBeschreibung
list_offsetintVersatz für die Seitenblätterung (Standard: 0)
list_conditionarrayArray der Filterbedingungen

Beispielanfrage

GET /api/company_user/list?list_offset=0
X-API-KEY: {ihr_api_schluessel}
POST /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

FeldTypPflichtfeldBeschreibung
idint0 = neuer Mitarbeiter, >0 = Änderung
company_idintKennung des Unternehmens
usernamestringAnmelde-Benutzername
password_new1stringPasswort (bei neuem Benutzer erforderlich)
password_new2stringPasswortbestätigung (bei neuem Benutzer erforderlich)
default_store_idintKennung des Standardlagers
superior_company_user_idintKennung des vorgesetzten Mitarbeiters
company_user_store_checkedarrayListe der zugelassenen Lager-IDs
company_user_paymod_checkedarrayListe der zugelassenen Zahlungsarten-IDs
company_user_cash_stock_checkedarrayListe 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
  }
}
POST /api/company_user/delete

Löschen eines Mitarbeiters anhand seiner Kennung.

POST-Felder — data-Objekt

FeldTypPflichtfeldBeschreibung
idintKennung des zu löschenden Mitarbeiters

Beispielanfrage

POST /api/company_user/delete
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json

{ "data": { "id": 3 } }
POST /api/company_user/save_interface

Speichern der Benutzeroberflächeneinstellungen für den jeweiligen Mitarbeiter.

POST-Felder — data-Objekt

FeldTypPflichtfeldBeschreibung
idintKennung des Mitarbeiters

Beispielanfrage

POST /api/company_user/save_interface
X-API-KEY: {ihr_api_schluessel}
Content-Type: application/json

{ "data": { "id": 3 } }
GET /api/company_user/login

Prüfung der Anmeldedaten eines Mitarbeiters (Benutzername-/Passwort-Paar). Bei Erfolg werden die Benutzerdaten zurückgegeben.

Query-Parameter

ParameterTypPflichtfeldBeschreibung
usernamestringAnmelde-Benutzername
passwordstringPasswort

Beispielanfrage

GET /api/company_user/login?username=kiss.janos&password=titkos123
X-API-KEY: {ihr_api_schluessel}
POST /api/company_user/save_password

Ändern des Passworts eines Mitarbeiters.

POST-Felder — data-Objekt

FeldTypPflichtfeldBeschreibung
idintKennung des Mitarbeiters
password_new1stringNeues Passwort
password_new2stringBestä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"
  }
}

Nimm Kontakt mit uns auf

Interessierst du dich für unsere Software? Schreib uns einfach!

Brauchst du Hilfe?

Wenn du keine Antwort findest und Unterstützung brauchst

Jetzt registrieren,
später bezahlen!

Teste es 3 Tage kostenlos, ohne Risiko und Verpflichtungen!