Um auf die API zugreifen zu können muss man sich erst authentifizieren. Ein technischer Zugang erfolgt über Zugangsdaten, die im AMPAREX eingerichtet werden. Der technische Login wird immer benutzt, wenn technische Daten abgerufen oder gespeichert werden sollen. Typischerweise allgemeine Exporte oder z. B. Kalendersynchronisation. Dabei ist man immer auf eine Filiale und einen Benutzer beschränkt.
Im Gegensatz zum technischen Login gibt es noch einen fachlichen Login. Dies 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. Vor einem fachlichen Login muss immer ein technischer Login erfolgen.
Technischer Login
Dies geschieht über sogenannte Zugangsdaten.
Der Ablauf ist folgender:
- Um die API zu verwenden wird ein Alias benötigt, über den ermittelt werden kann, wer auf die API zugreift. Das Alias erhält man im AMPAREX Client über die Filialverwaltung → Servicezugangsdaten → Ressource spezifische URL
- Alias kopieren
- Login Bereich in der Swagger-UI aufklappen und auf Try-Out klicken:
- Alle erforderlichen Parameter eintragen. Benutzername und Passwort entsprechen den Servicezugangsdaten des Alias:
- Auf Execute klicken → Die Anfrage wird an den Server geschickt
- Als Antwort erscheint im Feld "Server Response" nun das Login Token (Bearer Token):
- Markierten Bereich kopieren. Alles zwischen den Anführungszeichen.
- Nun im Kopf von Swagger-UI auf Authorize klicken:
- Es erscheint folgender Dialog:
In dem Dialog muss in dem Feld "Value" das Login Token (Bearer Token) eingetragen werden. Dazu "Bearer" eintippen plus Leertaste. Danach das zuvor erhaltene Login-Token einfügen und auf Autorize klicken. - Das Login Token ist nun gesetzt und wird für alle folgenden HTTP Aufrufe im Header mitgeschickt.
Fachlicher Login
Vor einem fachlichen Login muss immer ein technischer Login erfolgen, siehe oben. Der fachliche Login muss 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. 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.
Für einen fachlichen Login müssen erst die möglichen Filialen ermittelt werden. Dies geschieht über folgenden API Zugriff:
Das alias ist dasselbe, dass schon im technischen Login verwendet wurde. Um alle Filialen zu erhalten, bitte alle Suchparameter löschen und evtl. ein Limit angeben.
Die entsprechende BranchID aus dem Response kopieren:
Über den Response könnte auch ein Dialog erstellt werden, indem alle verfügbaren Filialen angezeigt werden.
Nun erfolgt der fachliche Login:
Im Response erhalten Sie nun ein neues Login Token, dass wie im technischen Login verwendet werden muss. Siehe Punkt 6-9 im technischen Login.