3.2.1.6. Web API Authentifizierung

Datenquellen-ID

• Eingabefeld für eine Datenquellen-ID

• Es wird automatisch die nächste verfügbare ID eingetragen.

• Bei manueller Eingabe muss eine eindeutige ID verwendet werden.

• Es gibt Zeichen, die in der ID nicht benutzt werden dürfen:

• Die Datenquellen-ID kann nach dem Hinzufügen der Datenquelle nicht mehr geändert werden.

Name der Datenquelle

• Eingabefeld für einen beliebigen Namen

• Es wird automatisch der Name “<ID>-Web API Authentifizierung” eingetragen.

Basic Auth (a)

• Für die Authentifizierungsmethode “Basic Auth” muss ein Benutzername und ein Passwort eingegeben werden.

• Die Zugangsdaten werden automatisch dem Header als Eigenschaft “Authorization” hinzugefügt.

• Benutzername und Passwort werden durch einen Doppelpunkt verbunden und Base64 kodiert hinterlegt sowie der Präfix “Basic” davor geschrieben.

• Beispiel:

  • Benutzername: test

  • Passwort: passwort

  • Header Wert für Authorization: Basic dGVzdDpwYXNzd29ydA==

  • “dGVzdDpwYXNzd29ydA==” entspricht “test:passwort” Base64 kodiert

Bearer Token (b)

• Für die Authentifizierungsmethode “Bearer Token” muss in zwei Eingabefeldern der Präfix des Tokens (üblicherweise “Bearer”) sowie der Bearer Token (Zugriffsschlüssel) eingegeben werden.

• Die Zugangsdaten werden automatisch dem Header als Eigenschaft “Authorization” hinzugefügt.

• Als Wert wird der angegebene Präfix und der Token durch ein Leerzeichen getrennt hinterlegt.

API Key (c)

• Für die Authentifizierungsmethode “API Key” muss ein API-Key-Name und ein API-Key-Wert eingegeben werden. Anschließend wird dieser API-Key – je nach Auswahl – entweder im Header übertragen oder als Query-Parameter an die URL angehängt.

• Beispiel für Query-Parameter:

  • URL: https://my.api.com/handbuch

  • Key: thekey

  • Wert: 12345

  • Anfrage: https://my.api.com/handbuch?thekey=12345

OAuth2 (d)

• Für die Authentifizierungsmethode “OAuth2” muss eine Token-URL, eine Client-ID, ein Client Secret und ein Scope (optional) eingegeben werden.

• Der Token wird vor der Ausführung der HTTP Anfrage neu abgeholt und automatisch im Header als Wert für “Authorization” eingefügt.