Page tree

Um auf die API zugreifen zu können muss man sich zuerst authentifizieren. Ein technischer Zugang erfolgt über Zugangsdaten, die im AMPAREX eingerichtet werden. Dazu wird der technische Login immer dann benutzt, wenn technische Daten abgerufen oder gespeichert werden sollen. Typischerweise z. B. allgemeine Exporte oder Kalendersynchronisationen. Dabei ist man auf eine Filiale und einen Benutzer beschränkt.

Im Gegensatz zum technischen Login gibt es noch einen fachlichen Login. Dieser wird immer dann benötigt, wenn sich verschiedene Mitarbeiter über die API anmelden möchten. Mögliche Anwendungsfälle sind z. B. Mobile APPs mit Login von Mitarbeiten.

Fachlicher Login

Der fachliche Login sollte immer erfolgen, wenn sich mehrere Mitarbeiter in unterschiedlichen Filialen über die API anmelden möchten. Für einen fachlichen Login können die bestehenden Benutzer Logindaten in AMPAREX verwendet werden.

Achtung

Für einen fachlichen Login muss ein sicheres Passwort in AMPAREX verwendet werden (Groß-/Kleinbuchstaben mit Zahlen und Sonderzeichen). Ist das Passwort unsicher wird der Login über die API abgelehnt. Dabei erhalten sie aus Sicherheitsgründen aber keine Hinweise in der Fehlermeldung. Die Fehlermeldung ist ein HTTP Status Code 401 (Unauthorized) ohne weiteren Hinweis.

Der Zugang zu dem online tool "Swagger" ist aus Sicherheitsgründen für Echt-Systeme deaktiviert!

Die Anleitungen und Routen zu den Endpunkten sind natürlich trotzdem gültig und können verwendet werden. Die Routen können auf unserem öffenltichen Testsystem https://trial.amparex.net:8078/amparex/webaxapi/swagger-ui.html ausprobiert werden.


Beschreibung

Um den fachlichen Login verwenden zu können, müssen ähnlich zu dem technischen Login die Servicezugangsdaten konfiguriert werden. Hierfür wird jedoch der Zugangstyp auf "AMPAREX Benutzer/Passwort" gesetzt.

Nun ist es möglich, sich über den /Login mit seinem AMPAREX-Benutzer anzumelden. Die Verwendung des "Alias" und die nachfolgende Verwendung des "Bearer Tokens" bleiben hierbei identisch zu dem fachlichen Login.

Der fachliche Login erfolgt initial mit einer zuvor in AMPAREX konfigurierten Standard-Filiale für das Benutzerkonto.

Möchte man sich für eine andere Filiale anmelden, kann die Methode /axlogin verwendet werden:

  • Der Aufruf ist ähnlich dem des technischen Logins, allerdings kann hier eine Zielfiliale mitgegeben werden. Dieser Aufruf kann nicht initial zum Login verwendet weren, da dieser Request bereits ein Bearer-Token voraussetzt.
  • Das neue zu erhaltende Bearer-Token identifiziert nun jeden Aufruf mit dem Mitarbeiter und der angegebenen Filiale. Daher ist es nötig alle weiteren Requests nun mit dem neuen Token durchzuführen.
  • No labels
Skip to end of metadata
Go to start of metadata