Authentifizierung und Header konfigurieren

In diesem Schritt müssen Sie die Authentifizierung festlegen und bei Bedarf einen oder mehrere Header konfigurieren.

Für die Authentifizierung stehen die folgenden Möglichkeiten zur Verfügung:

  • Keine/Benutzerdefiniert

  • Basic Authentication

  • API-Key

  • Bearer Token

Im Header können Sie beliebige Einträge (Key/Value-Paare) hinzufügen. Detaillierte Informationen hierzu finden Sie in Abschnitt Header hinzufügen.

Typ

Wählen Sie hier den Typ der Authentifizierung aus.

Dynamische Dialoge Beachten Sie, dass nach jeweils gewählter Authentifizierung unterschiedliche Eingabe- und Auswahlfelder angezeigt werden, die für die jeweilige Authentifizierung erforderlich sind.

Im Folgenden finden Sie eine Beschreibung der einzelnen Authentifizierungsmöglichkeiten.

Keine/Benutzerdefiniert

Verwenden Sie den Typ "Keine/Benutzerdefiniert", wenn keine Authentifizierung erforderlich ist oder wenn die Authentifizierung über andere Wege stattfindet, wie beispielsweise durch das Setzen eines eigenen Headers mit Credentials.

Client für session-based Requests wiederverwenden

Wenn Sie den Typ "Keine/Benutzerdefiniert" auswählen, steht die Option "Client für Session-basierte Interaktion wiederverwenden" zur Verfügung.

Das Aktivieren dieser Option bietet sich insbesondere im Zusammenhang mit dem Login an einer API an und wenn die API Session-Cookies vergibt. Diese kann der REST-API-Client vorhalten und in späteren REST-Call-Aktionen innerhalb desselben Prozesses wiederverwenden.

Hintergrund Intrexx verwendet den "Apache HTTP Client 5" als REST-API-Client. Dieser wird bei jeder REST-Call-Aktion generiert und nach deren Ausführung gelöscht. Das Löschen des REST-API-Clients können Sie mit der Option "Client für session-based Requests wiederverwenden" unterbinden. In diesem Fall wird der Client in einer Intrexx-internen Registry abgelegt. Bei weiteren REST-Call-Aktionen innerhalb desselben Prozesses sucht Intrexx in der Registry, ob ein passend konfigurierter Client bereits vorliegt. Wenn dies der Fall ist, verwendet Intrexx automatisch diesen Client.

Da der Client Session-Cookies speichert und ausliefert, bleibt so ein Login bis zum Ende der jeweiligen Prozesses gültig.

Wenn ein Client wiederverwendet wird, wird dies in der Log-Datei mit "Getting retained Client ..." angezeigt.

Basic Authentication

Verwenden Sie den Typ "Basic Authentication", wenn die API eine Basic Authentication erwartet.

Benutzername

Sie können den Benutzernamen frei eingeben oder aus dem Resource-Mapping beziehen oder beides kombinieren.

Passwort

Sie können das Passwort frei eingeben, aus dem Anmeldeinformationsspeicher (Anmeldeinformationsspeicher) oder über das Resource-Mapping beziehen.

Schritt-für-Schritt

Um das Passwort aus Anmeldeinformationsspeicher oder über das Resource-Mapping zu beziehen, gehen Sie wie folgt vor:

  1. Klicken Sie auf den nach unten zeigenden Pfeil am Ende des Passwort-Feldes.

    Die Optionen "Resource-Mapping" und "Aus Anmeldeinformationsspeicher" werden angezeigt.

  2. Wählen Sie die gewünschte Option aus.

    Wenn Sie die Option "Resource-Mapping" ausgewählt haben wird das -Icon angezeigt.

    Wenn Sie die Option "Aus Anmeldeinformationsspeicher" ausgewählt haben wird das -Icon angezeigt.

  3. Klicken Sie auf das gewünschte Icon.

  4. Wählen Sie im Folgedialog den gewünschten Eintrag aus.

Vermeiden Sie, Passwörter im Resource-Mapping als Statischen Text zu hinterlegen und anschließend zur Authentifizierung an der API zu verwenden.

API-Key

Verwenden Sie den Typ "API-Key", wenn die API einen API-Key und den dazugehörigen Informationen erwartet.

Token

Der Token bzw. API-Key kann frei eingegeben werden, aus dem Resource-Mapping bezogen werden oder eine Kombination aus beidem sein.

Authorization Header

Hier können Sie auswählen, welcher Header für den API-Key verwendet werden soll. Die folgenden Optionen stehen zur Verfügung:

  • Authorization: Apikey

  • X-API-Key

    Bei den Optionen "Authorization: Apikey" und "X-API-Key" wird die gewählte Option in der Tabelle im Bereich "Header" angezeigt und der Token wird automatisch eingefügt. Der erstellte Eintrag kann nicht manuell aus der Tabelle im Bereich Header gelöscht werden. Beim Absetzen des REST-Calls wird der entsprechende Header generiert.

  • Benutzerdefiniert

    Wenn Sie die Option "Benutzerdefiniert" wählen, müssen Sie den Header selbst erstellen.

Bearer Token

Verwenden Sie den Typ "Bearer Token", wenn der REST-Call eine Authentifizierung mit einem Bearer Token erfordert.

Token

Der Token kann frei eingegeben werden, aus dem Resource-Mapping bezogen werden oder eine Kombination aus beidem sein.

Bei dieser Option wird immer ein Eintrag mit dem Key BEARER_TOKEN in die Header-Tabelle eingetragen. Dieser Eintrag kann nicht manuell aus der Header-Tabelle gelöscht werden. Beim Absetzen des Calls nutzt der REST-API-Client den Header Authorization: Bearer.

Header-Eintrag hinzufügen

In die Header-Tabelle werden die Header für den Request eingetragen. Im Default-Betrieb werden die Header vom Apache Client selbstständig generiert, sodass in den meisten Fällen keine eigenen Header geschrieben werden müssen. Falls dennoch Header benötigt werden (z.B. für eine selbst angelegte Authentifizierung), müssen Sie die Header-Einträge als Key/Value-Paare eingeben. Werden im Dialog Header gesetzt, überschreiben sie Default-Header mit dem gleichen Key. Das Resource-Mapping wird sowohl auf die Keys als auch auf die Values der Header angewendet, es sind also dynamische Header möglich. Ein typischer Anwendungsfall wäre, einen dynamisch generierten Token in einen Header zu legen (sofern das nicht mit den Optionen API-Key oder Bearer Token ohnehin schon abgedeckt ist).

Schritt-für-Schritt

Um einen Header-Eintrag hinzuzufügen, gehen Sie wie folgt vor:

  1. Öffnen Sie die REST-Call-Aktion.

  2. Wechseln Sie auf die Registerkarte "Authentifizierung und Header".

  3. Klicken Sie auf das - Icon.

    Das Dialogfenster "Header-Eintrag hinzufügen" wird angezeigt.

  4. Erfassen Sie einen Key und einen Wert. Den Wert können Sie manuell eingeben oder aus dem Resource-Mapping beziehen oder eine Kombination aus beidem nutzen.

  5. Klicken Sie auf "OK".

    Der hinzugefügte Header-Eintrag wird angezeigt.

Ihr nächster Schritt

Request konfigurieren