Authentifizierung und Berechtigungen

Auf dieser Seite beschreiben wir die Authentifizierung am entsprechenden REST API-Endpunkt und die Nutzung des Bearer Tokens.

Allgemein

Für die OPENWOWI-API existiert ein öffentliches Swagger Dokument. Wir verwenden für die Beispiele in dieser Dokumentation die untenstehende Sandbox. Für die Authentifizierung benötigen Sie nur einen gültigen User und ein Passwort. Wir empfehlen, hierfür in WOWIPORT einen technischen Nutzer anzulegen.

Sandbox-URL: https://openwowi-demo.wowiport.de/.

Login

Das Login geschieht über die /oauth2/token-Route.

---

POST/oauth2/token

Body

application/x-www-form-urlencoded

grant_type*string

usernamestring

passwordstring (password)

refresh_tokenstring

Response

200400401

OK

Body

text/plainapplication/jsontext/json

access_tokennullable string

token_typenullable string

expires_ininteger (int32)

refresh_tokennullable string

refresh_token_daysinteger (int32)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/oauth2/token', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "grant_type": "text"
    }),
});
const data = await response.json();

Response

200400401

{
  "access_token": "text",
  "token_type": "text",
  "expires_in": 0,
  "refresh_token": "text",
  "refresh_token_days": 0
}

---

Um diesen Endpunkt zu testen, können Sie die untenstehenden Daten verwenden.

grant_type	password
username	Hackathon
password	5olMnBRzaUrC9oIZA4w6;

Die Berechtigungen werden sowohl durch die Rechte des verwendeten Nutzers als auch durch die Endpunktberechtigungen des API-Keys limitiert.

Der Nutzer benötigt hierbei dieselben Berechtigungen, welche auch in der GUI benötigt werden, um die gewünschten Daten lesen oder bearbeiten zu können. Aus Gründen der Infrastruktursicherheit bitten wir um Verständnis, dass die Dokumentation der dezidierten Nutzerrechte nicht in der öffentlichen Dokumentation zu finden ist. Bitte konsultieren Sie hierfür das WOWIPORT-Handbuch.

Die Beschreibung der Einrichtung des API-Keys finden Sie hier:

Einrichtung OPENWOWI