Versionen im Vergleich

Schlüssel

  • Diese Zeile wurde hinzugefügt.
  • Diese Zeile wurde entfernt.
  • Formatierung wurde geändert.

...

The technical profile can be set up the following way:


Description

(1) Um die API zu verwenden wird ein Alias benötigt, über den ermittelt werden kann, wer auf die API zugreift. Den Alias erhält man im AMPAREX Client über die Filialverwaltung → Servicezugangsdaten → Ressource spezifische URL - siehe Nachfolgend Schritte In order to use the API, an alias will required which will be used to determine who is accessing the API. The alias can be set up on AMPAREX Client in the ‘Branch office administration → Service access data → Resource specific URL – follow the steps 1-3.

(2) Über Schritt 4 wird die für den Swagger-UI benötigte Ressourcen spezifische URL angezeigt und mit Schritt 5 der Alias kopiert Step 4 shows the resource specific URL required for the Swagger UI. The step 5 copies the alias.

(

3)

Wechseln Sie in die Swagger-UI. Im Login Bereich in der Swagger-UI aufklappen und auf

Switch to the Swagger UI. Open the login area in the Swagger UI and click on 'Try-it-Out'

klicken

.

(4) Tragen Sie alle erforderlichen Parameter ein. Benutzername und Passwort entsprechen den Servicezugangsdaten des Alias.

(5) Klicken Sie auf Execute → die Anfrage wird an den Server geschickt.

Image Removed

(6) Als Antwort erscheint im Feld 'Server Response' nun das für den Login benötigte Token (Bearer Token).

(7) Markierten und kopieren Sie alles zwischen den Anführungszeichen.

Image Removed

(8) Klicken Sie im Kopf von Swagger-UI auf Authorize.

Enter all the necessary parameters. User name and password correspond to the alias service access data.

5) Click Execute so the request could be sent to the server.

Image Added

6) As a result, the token required for the login (Bearer token) will appears in the 'Server Response' field.

7) Mark and copy everything between the quotes.

Image Added

8) Click 'Authorize' in the Swagger UI header.

Image Added

9) In the dialog that appears, the login token (Bearer token) must be entered into the 'Value' field. To do this, type in 'Bearer' followed by a space. Then insert the previously received login token and click on 'Authorize'.

The login token is now set and will used for all HTTP calls.

Image Removed

(9) In dem erscheinenden Dialog muss in dem Feld 'Value' das Login Token (Bearer Token) eingetragen werden. Dazu 'Bearer' eintippen gefolgt von einem Leerzeichen. Danach das zuvor erhaltene Login-Token einfügen und auf 'Authorize' klicken.

Das Login Token ist nun gesetzt und wird für alle HTTP Aufrufe im Header mitgeschickt