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

Im Gegensatz zum technischen Login gibt es noch einen fachlichen Login. Dies 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. Vor einem fachlichen Login muss immer ein technischer Login erfolgen.

Technischer Login

Dies geschieht DEr technische Login erfolgt über sogenannte Zugangsdaten.

...

1. Um die API zu verwenden wird ein Alias benötigt, über den ermittelt werden kann, wer auf die API zugreift. Das Den Alias erhält man im AMPAREX Client über die Filialverwaltung → Servicezugangsdaten → Ressource spezifische URL - siehe Nachfolgend Schritte 1-3.
   
   Alias kopieren
   
   
2. Über Schritt 4 wird die für den Swagger-UI benötigte Ressourcen spezifische URL angezeigt und mit Schritt 5 der Alias kopiert.
   
   
3. Wechseln Sie in die Swagger-UI. Im Login Bereich in der Swagger-UI aufklappen und auf 'Try-it-Out' klicken:
   
   
   
4. Alle Tragen Sie alle erforderlichen Parameter eintragenein. Benutzername und Passwort entsprechen den Servicezugangsdaten des Alias:
   
   
   
5. Auf Klicken Sie auf Execute klicken → Die die Anfrage wird an den Server geschickt.
   
   
6. Als Antwort erscheint im Feld "'Server Response" ' nun das für den Login benötigte Token (Bearer Token):.
   
   
   
7. Markierten Bereich und kopieren . Alles Sie alles zwischen den Anführungszeichen.
   
   
8. Nun Klicken Sie im Kopf von Swagger-UI auf Authorize klicken:.
   Es erscheint folgender Dialog:
   Image Removed
   
   

9. In dem erscheinenden Dialog muss in dem Feld

   "

   'Value

   "

   ' das Login Token (Bearer Token) eingetragen werden. Dazu "Bearer" eintippen

   plus Leertaste

   gefolgt von einem Leerschritt. Danach das zuvor erhaltene Login-Token einfügen und auf 'Autorize' klicken.

   
   Image Added
   
   
10. Das Login Token ist nun gesetzt und wird für alle folgenden HTTP Aufrufe im Header mitgeschickt.

...

Für einen fachlichen Login müssen erst die möglichen Filialen ermittelt werden. Dies geschieht über folgenden einen API Zugriff:

Das alias Alias ist dasselbe, dass schon im technischen Login verwendet wurde. Um alle Filialen zu erhalten, bitte sollten alle Suchparameter löschen zuerst gelöscht und evtl. ein Limit angeben werden.

Die entsprechende BranchID aus dem Response kopieren:

...