Authentifizierung und Berechtigungen

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

Allgemein

Um unsere Beispiele zur Nutzung der API nachvollziehen zu können, können Sie einen Zugang zu unserer Sandbox beantragen. Bitte kontaktieren Sie hierfür [email protected]. Sie erhalten dann einen technischen User und einen API Key. Für die Beantragung benötigen wir eine E-Mailadresse (diese wird für die Passwortvergabe an den Benutzer gebunden) für die Versendung der Einladung zu unserer Sandbox und Zustellung des API Keys.

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 (siehe auch "Hinweise zum Benutzer").

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

Login

Das Login erfolgt über die Route "/oauth2/token".

Der "grant_type" lautet bei der Erstanmeldung "Password".

Bei späteren Anmeldungen können Sie den "grant_type" auf "refesh_token" setzen und diesen mit dem Parameter "refesh_token" erneuern. Die erneute Übersendung des Passwortes und des Users entfällt bei dieser Methode.

---

post

Rumpf

application/x-www-form-urlencoded

grant_typestringErforderlich

usernamestringOptional

passwordstring · passwordOptional

refresh_tokenstringOptional

Antworten

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

text/plainapplication/jsontext/json

post

/oauth2/token

HTTPcURLJavaScriptPython

POST /oauth2/token HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 84

"grant_type='text'&username='text'&password='password'&refresh_token='text'"

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

---

Hinweise zum Benutzer

Wir empfehlen die Anlage eines technischen Nutzers für die Verwendung der OPENWOWI. Sollten Sie einen Benutzer mit Zugriff auf die Benutzeroberfläche von WOWIPORT verwenden wollen, bitten wir folgende Informationen zu beachen.

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.

Wenn Sie die Zwei-Faktor-Authentifizierung aktiviert haben, kann die Authentifizierung über OAuth2 nicht erfolgreich vorgenommen werden.

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 sowie Hinweise zur Freischaltung für unsere Sandbox finden Sie hier:

Einrichtung OPENWOWI