| Info |
|---|
Das Feature “API Zugänge verwalten” ist eine Management-Konsole, um diverse Adminfunktion, um Zugänge zur API über den Administrationsbereich selbstständig anlegen und verwalten zu können. Mithilfe der Verwaltung für API Zugänge lassen sich API Keys für Drittdienstleister, z.B. für Agenturen oder andere Dienstleister des Verlags, strukturiert und bedarfsgerecht zur Verfügung stellen. Zudem kann ein Zugang für OAuth Logins im System angelegt und verwaltet werden. |
...
| Expand | ||||
|---|---|---|---|---|
| ||||
|
...
Aufbau der Verwaltung für API Zugänge
In der Verwaltung für API Zugänge sind die bereits konfigurierten API Zugänge übersichtlich dargestellt. Zum Für den Zugriff auf die jeweilige API werden die Client Credentials , – bestehend aus Client ID und Client Secret benötigt–benötigt. Das Client Secret kann am jeweiligen Zugang über das Key-Icon abgerufen werden. Der Typ der Zugänge wird ist durch unterschiedliche Icons (<database> Database Icon für normalen API Zugriff, <sign-in> Sign in Icon für OAuth2 Login) gekennzeichnet.
...
Ansicht der Verwaltung für API Zugänge
...
Overlay zum Abruf des Client Secret
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.
...
Konfigurationsoberfläche für die Zuweisung von Zugriffsberechtigungen
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.
...
Relevante Felder zum Anlegen eines Zugangs für einen OAuth Client
Bearbeitungsprotokoll
Über das Optionsmenü Kontextmenü am rechten oberen Rand lässt sich das Bearbeitungsprotokoll aufrufen. Hier kann eingesehen werden, welcher Benutzer, wann, welchen Zugäng Zugang angelegt, geändert oder gelöscht hat.
...
Beispielhaftes Bearbeitungsprotokoll zu einem API Zugangs
Berechtigte Nutzer
Die Verwaltung für API Zugänge ist eine Adminfunktion, welche Benutzer mit der Berechtigung “Zugang zur Verwaltungsübersicht“ und “Zugang zur API Zugänge Verwaltung / Zugang bearbeiten und löschen” über die Administrationsseite unter dem Punkt “API das Benutzermenü → Administration & Moderation → API 2.0 BETA Zugänge verwalten” erreichbarverwalten aufrufen dürfen. Hier können API Zugänge für verfügbare APIs angelegt und konfiguriert werden.
...