Administrationshandbuch edoc invoice cockpit

Authentifizieren des administrativen Benutzers bei der edoc invoice cockpit-REST-API

Sie müssen sich als Benutzer mit vollständigen administrativen Berechtigungen bei der REST-API von edoc invoice cockpit authentifizieren, um edoc invoice cockpit zu konfigurieren.

Bevor Sie beginnen

  • Sie benötigen Zugriff auf Keycloak auf dem edoc platform-Server.

  • Sie müssen Administrationsberechtigungen auf dem edoc platform-Server haben.

  • Sie benötigen eine API-Anwendung, z.B. Bruno oder Postman.

So geht’s

  1. Navigieren Sie zu <Base-URL>/auth und melden Sie sich als Administrator an. Ersetzen Sie <Base-URL> durch die Basis-URL von edoc platform (inklusive https:// oder http://).

  2. Erstellen Sie eine OpenID Connect-Anwendung. Folgen Sie den Schritten in diesem Artikel der Keycloak: Creating an OpenID Connect client (Server Administration Guide) (in englischer Sprache).

  3. Navigieren Sie anschließend zu Clients und wählen Sie die von Ihnen zuvor erstellte Anwendung aus.

  4. Kopieren Sie unter Settings den Wert in Client ID.

  5. Kopieren Sie unter Credentials den Wert in Client Secret.

  6. Öffnen Sie Ihre API-Anwendung und wählen Sie als Authentifizierungsmethode für REST-Aufrufe OAuth 2.0 aus.

  7. Wählen Sie den entsprechenden Anmeldetyp (grant type) für die Anmeldedaten der Anwendung (client credentials) aus.

  8. Geben Sie im Eingabefeld für die Token-URL den Wert <Base-URL>/auth/realms/master/protocol/openid-connect/token ein. Ersetzen Sie <Base-URL> durch die Basis-URL von edoc platform (inklusive https:// oder http://).

  9. Fügen Sie im Eingabefeld für die Anwendungs-ID den Wert ein, den Sie zuvor in Keycloak aus Client ID kopiert haben.

  10. Fügen Sie im Eingabefeld für den geheimen Clientschlüssel (client secret) den Wert ein, den Sie zuvor in Keycloak aus Client Secret kopiert haben.

Tipp

Prüfen Sie abschließend, ob Sie mit diesen Daten ein Zugangstoken abfragen können. Überprüfen Sie unbedingt Ihre Eingaben, falls die Abfrage fehlschlägt.