Page Comparison

...

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:

Preﬁx:

/oauth/v2

Methode:

Status

colour	Blue
title	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 (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)

...

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 Preﬁx	/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)

showLabels	false
maxCheckbox	false
showSpace	false
reverse	false
cql	label = "api" and space = "PPSDPUPKB"

Include Page

	Disclaimer der PEIQ PRINT PPS - Produktdokumentation
	Disclaimer der PEIQ PRINT PPS - Produktdokumentation

Versions Compared

Old Version 3

New Version 4

Key

Autorisierung bei “Try it out”

4. Verwenden der API

Basis URL