Versions Compared

Key

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

...

Overlay zum Abruf des Client Secret

Einen Einblick in das Thema gibt das folgende Video:

...

API Zugang erstellen

Normaler API Zugang

...

Um einen Zugang für einen OAuth Client anzulegen, wird der Typ “OAuth2 Login” gewählt. Die Bezeichnung des Zugangs ist hierbei relevant, da dieser als <ClientName> verwendet wird und damit im Authorisierungsdialog genannt wird (z.B. “Darf <ClientName> ihre Account Informationen benutzen?”). Über die Redirect URL kann definiert werden, auf welcher Seite der User Benutzer:innen nach dem Login landen soll.

...

Über das Kontextmenü am rechten oberen Rand lässt sich das Bearbeitungsprotokoll aufrufen. Hier kann eingesehen werden, welcher welche:r Benutzer:in, wann, welchen Zugang angelegt, geändert oder gelöscht hat.

...

Beispielhaftes Bearbeitungsprotokoll zu einem API Zugangs

Berechtigte Nutzer:innen

Die Verwaltung für API Zugänge ist eine Adminfunktion, welche Benutzer:innen mit der Berechtigung “Zugang zur Verwaltungsübersicht“ und “Zugang zur API Zugänge Verwaltung / Zugang bearbeiten und löschen” über das Benutzermenü → Administration & Moderation → API 2.0 BETA Zugänge verwalten aufrufen dürfen. Hier können API Zugänge für verfügbare APIs angelegt und konfiguriert werden.

Note

Wichtige Hinweise zur Verwaltung von API Zugängen

Der Zugang zum Feature “API Zugänge verwalten” und das darüber mögliche Erstellen von API-Zugängen für die Cloud Connect API ist sicherheitsrelevant und sollte nur mit äußerster Sorgfalt gehandhabt werden, da über die API direkt Livedaten im PORTAL beeinflusst und gesteuert werden können. Über die User-API können zudem nutzerbezogene Daten bezogen oder verändert werden.

Es wird daher empfohlen nur API Zugänge, die für das jeweilige Projekt konkret benötigt werden, zu konfigurieren. Sollten die API-Zugänge von Dritten benötigt werden, empfiehlt es sich zudem, mit den externen Partnern Vereinbarungen zur Nutzung der API zu treffen – beispielsweise in Form eines ADV-Vertrages (Vertrag zur Auftragsdatenverarbeitung).

Zugang zur API-Dokumentation

siehe API 2.0 Dokumentation PORTAL

Testszenario mit einem Staging-System oder Testportal

Um Testszenarien im Livesystem zu vermeiden, kann

  1. die API auf einen temporären Staging-System mit Kundenkonfiguration getestet werden.

  2. die API auf einem dauerhaften Testportal mit Kundenkonfiguration getestet werden.

Für nähere Informationen zur Bereitstellung eines temporären Staging-Systems oder Testportal und die dafür notwendigen Aufwände, wenden Sie sich an Ihren Ansprechpartner bei PEIQ.

...

Filter by label (Content by label)
showLabelsfalse
maxCheckboxfalse
showSpacefalse
reversefalse
cqllabel in ( = "api" , "api-dokumentation" ) and space = "PPSD"PUPKB"

Include Page
Disclaimer der PEIQ PORTAL - Produktdokumentation
Disclaimer der PEIQ PORTAL - Produktdokumentation

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