Im Rahmen der Erstellung neuer Entwickler-API-Schlüssel oder der Bearbeitung vorhandener Entwickler-API-Schlüssel in Ihrem Konto können Sie den Zugriff auf den API-Schlüssel anpassen. Mit der Etablierung von Geltungsbereichen können Sie den direkten Zugriff und bestimmte API-Endpunkte für Drittanbieter-Tools, die mit Ihrer Institution verbunden sind, kontrollieren.
Standardmäßig ist die Nutzung von Geltungsbereichen bei der Erstellung eines neuen Entwickler-API-Schlüssels deaktiviert, so dass die Token auf alle Endpunkte zugreifen können, die dem/der autorisierenden Benutzer*in zur Verfügung stehen. Die Bereiche können jedoch jederzeit für einen Entwickler-API-Schlüssel bearbeitet werden und die Zugangs-Token für die autorisierenden Benutzer*innen entsprechend aktualisieren.
Hinweise:
- Die Verwaltung von Entwicklerschlüsseln ist eine Kontoberechtigung. Wenn Sie Entwicklerschlüssel nicht verwalten können, ist diese Berechtigung für Ihre Benutzerrolle nicht aktiviert worden.
- Entwicklerschlüssel sind in Unterkonten nicht verfügbar.
Konto öffnen
Klicken Sie in der globalen Navigation auf den Link Admin [1] und dann auf den Namen des Kontos [2].
Entwicklerschlüssel öffnen
Klicken Sie in der Kontonavigation auf den Link Developer Keys (Entwicklerschlüssel).
Entwicklerschlüssel hinzufügen
Klicken Sie auf die Schaltfläche Add Developer Key (Entwicklerschlüssel hinzufügen).
API-Schlüssel hinzufügen
Klicken Sie auf die Option Add API Key (API-Schlüssel hinzufügen).
Geltungsbereiche durchsetzen
Nachdem Sie die Informationen zum Entwicklerschlüssel ausgefüllt haben, klicken Sie auf die Schaltfläche Enforce Scopes (Geltungsbereiche durchsetzen).
Include-Parameter zulassen
Um die Verwendung aller „Includes“-Parameter für diesen Schlüssel zuzulassen, klicken Sie auf das Kontrollkästchen Allow Include Parameters (Include-Parameter zulassen).
„Includes“-Parameter können Zugriff auf zusätzliche Daten gewähren, die nicht in der Tabelle Endpunkte enthalten sind.
Endpunkte suchen
Um nach einem bestimmten Endpunkt zu suchen, geben Sie den Namen des Endpunkts in das Feld Search Endpoints (Endpunkte suchen) [1] ein.
Um alle verfügbaren Endpunkte zu sehen, scrollen Sie durch die Tabelle Endpunkte [2].
Schreibgeschützte Endpunkte auswählen
Um dem Entwicklerschlüssel nur Lesezugriff (GET) zu gewähren, aktivieren Sie das Kontrollkästchen Read only (Schreibgeschützt). Die Tabelle wird automatisch aktualisiert und wählt alle Bereiche aus, die schreibgeschützte Endpunkte enthalten.
Einzelne Endpunkte auswählen
Sie können den Zugriff auf den Entwickler-API-Schlüssel individuell gestalten. Klicken Sie auf den Namen eines beliebigen Bereichs, um die verfügbaren Endpunkte anzuzeigen [1]. Wählen Sie die gewünschten Endpunkte aus, indem Sie auf das Kontrollkästchen neben dem Endpunktnamen klicken [2]. Die Zeile mit dem Bereichsnamen wird aktualisiert und zeigt eine Zusammenfassung des Zugriffs auf die kollektiv ausgewählten Endpunkte [3].
Schlüssel speichern
Klicken Sie auf die Schaltfläche Save (Speichern).
