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. 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 sogenennante Zugangsdaten.
Der Ablauf ist folgender:
- Um die API zu vewenden wird ein Alias benötigt, über den ermittelt werden kann, wer auf die API zugreift. Das Alias erhält man im AMPAREX Client unter Filialverwaltung → Servicezugangsdaten → Resource 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.