Versions Compared

Old Version 2

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user Ilker Oygün

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Um Zugriff auf die API zu erhalten, wird ein Access Token benötigt. Dieses kann über einen speziellen Endpunkt generiert werden, indem sich mit Client ID und Client Secret authentifiziert wird:

Prefix:

/oauth/v2

Methode:

Status
colourBlue
titleGET
/token

Parameter:

  • grant_type Muss immer den Wert “client_credentials” haben

  • client_id Die Client / Public ID

  • client_secret Das Secret (Passwort)

Rückgabewert:

  • Eine Access-Token-Datenstruktur (Bearer)

Diese API Credentials (Client ID und Client Secret) können über die Verwaltung von API Zugängen von berechtigten Benutzer:innen selbst erstellt werden: API Zugänge verwalten (PRINT PPS)

Anleitung zur Verwendung der API

Folgende Berechtigungen werden für die Verwendung der API im PRINT PPS benötigt:

  • “Anlegen und bearbeiten von API Zugängen”

  • “Zugriff auf API-Dokumentation”

Es hat sich bewährt, für diese Art der Berechtigungen eine eigene Rolle (z. B. API Manager) anzulegen und diese ausgewählten Benutzer:innen zuzuweisen.

Note

Achtung:

Durch die Weitergabe von Mit den API-Zugangsdaten an Dritte haben diese die Möglichkeit, Live-Daten im PRINT PPS zu beeinflussen. Missbräuchlich manipulierte Live-Daten können nicht oder nur in Einzelfällen wiederhergestellt werden. Daher muss sehr sorgfältig mit den Zugangsdaten umgegangen und sollten nur an vertrauensvolle Dritte weitergegeben sollte sehr sorgsam umgegangen werden, da durch diese Daten aus dem PRINT PPS abgerufen oder geändert werden können. Aus diesem Grund sollte auch die Berechtigung zur API-Verwaltung nur ausgewählten internen Kolleg:innen gegeben werden.

1. Einrichtung der API Zugänge / Autorisierungsdaten

...

Bei der Zugangskontrolle handelt es sich um eine Implementierung nach dem OAuth V2 Standard. Auf die Details des Protokolls wird im Folgenden nicht eingegangen, stattdessen wird anhand von Beispielen demonstriert, wie die API zum Anfordern von Access Token verwendet werden kann.

Bundle Prefix

/oauth/v2

Beispiel URL

/oauth/v2/token

Autorisierung bei “Try it out”

...

Note

Achtung: Da diese Access Token mit System-Rechten ausgestattet und dementsprechend sehr mächtig sind, sollten sie niemals das Backend verlassen oder über unsicheren Wege verschickt werden.

Methode:

Code Block
[GET]  /token

Parameter:

  • grant_type Muss immer den Wert client_credentials haben

  • client_id Die Client-/Public-ID

  • client_secret Das Secret (Passwort)

Rückgabewert:

  • Eine Access-Token-Datenstruktur (siehe oben).

4. Verwenden der API

Basis URL

...

Filter by label (Content by label)
showLabelsfalse
maxCheckboxfalse
showSpacefalse
reversefalse
cqllabel = "api" and space = "PPSDPUPKB"

Include Page
Disclaimer der PEIQ PRINT PPS - Produktdokumentation
Disclaimer der PEIQ PRINT PPS - Produktdokumentation


Nur für PEIQ-Mitarbeiter:innen
https://peiq.atlassian.net/wiki/x/SQCqPw