Das Feature “API Zugänge verwalten” ist eine Management-Konsole, um diverse API Keys für Drittdienstleister, z.B. für Agenturen oder andere Dienstleister des Verlags, strukturiert und bedarfsgerecht zur Verfügung stellen. Zudem können Zugänge für die PEIQ Federation API und OAuth Logins im System angelegt und verwaltet werden.
Funktionalitäten des Features
Anlegen von API Zugängen für verfügbare API
Konfiguration von API Zugängen für verfügbare API
Inhaltsverzeichnis
Allgemeine Beschreibung
In der Verwaltung für API Zugänge sind die bereits konfigurierten API Zugänge übersichtlich dargestellt. Zum Zugriff auf die jeweilige API werden die Client Credentials, bestehend aus Client ID und Client Secret benötigt. Das Client Secret kann am jeweiligen Zugang über das Key-Icon abgerufen werden. Der Typ der Zugänge wird durch unterschiedliche Icons (<database> für normalen API Zugriff, <sign-in> für OAuth2 Login) gekennzeichnet.
API Zugang erstellen
Normaler API Zugang
Über eine einfache und selbstredende Konfigurationsoberfläche können einem Client verschiedene Berechtigungen für die zur Verfügungen stehenden APIs zugewiesen werden. Mit dem Lesezugriff erhält der Client Zugang zu den GET-Endpunkten der jeweiligen API. Ist der Lese- & Schreibzugriff aktiviert können alle verfügbaren REST-Endpunkte genutzt werden, die die API zur Verfügung stellt.
OAuth2 Login
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 nach dem Login landen soll.
Bearbeitungsprotokoll
Über das Optionsmenü am rechten oberen Rand lässt sich das Bearbeitungsprotokoll aufrufen. Hier kann eingesehen werden, welcher Benutzer, wann, welchen Zugäng angelegt, geändert oder gelöscht hat.
Berechtigte Nutzer
Die Verwaltung für API Zugänge ist mit der Berechtigung “Zugang zur API Zugänge Verwaltung / Zugang bearbeiten und löschen” über die Administrationsseite unter dem Punkt “API 2.0 BETA Zugänge verwalten” erreichbar. Hier können API Zugänge für verfügbare APIs angelegt und konfiguriert werden.