Erstellen und Verwalten von API-Schlüsseln
Ein API-Schlüssel autorisiert Anfragen an die Datenexport-API. Sie erstellen und verwalten
API-Schlüssel unter Account Administration und geben den Schlüssel an, wenn Sie Anfragen über die Seite „API-Explorer“ oder
aus Ihren eigenen Anwendungen absenden.
Jede Anfrage an die Datenexport-API muss einen gültigen API-Schlüssel in der Kopfzeile
x-api-key enthalten. Der Schlüssel authentifiziert die Anfrage für Ihr Konto (Tenant).
Um API-Schlüssel zu erstellen, benötigen Sie Zugriff auf Administrator unter Account Administration.
Befolgen Sie die in diesem Abschnitt beschriebenen Vorgehensweisen, um:
- Erstellen Sie einen neuen API-Schlüssel.
- Bearbeiten Sie den Namen, das Ablaufdatum oder die Beschreibung eines vorhandenen Schlüssels.
- Drehen Sie einen Schlüssel, um dessen geheimen Wert zu ersetzen, ohne die Identität des Schlüssels zu ändern.
- Entfernen Sie einen Schlüssel aus dem System.
Hinweis: Wenn Sie einen API-Schlüssel erstellen oder aktualisieren, gibt es ein kurzes Zeitfenster,
bevor der Schlüssel registriert und einsatzbereit ist. In der Regel beträgt dieses
Zeitfenster weniger als eine Minute.
- So erstellen Sie einen neuen API-Schlüssel:
- Klicken Sie im linken Bereich von Account Administration auf API-Schlüssel.
- Klicken Sie auf API-Schlüssel erstellen.
- Geben Sie einen Namen und eine Beschreibung für diesen Schlüssel ein.
- Wählen Sie für Ablaufdatum ein Datum aus, das bis zu 367 Tage in der Zukunft liegt.
- Wählen Sie für Lizenzen den Nutzungsplan „RPI Data Export“ für API-Schlüssel aus.
- Klicken Sie auf Weiter.Der Schlüssel wurde generiert und gespeichert.
- Klicken Sie auf Kopieren, um den generierten Schlüssel in Ihre Zwischenablage zu kopieren. Bewahren Sie es
sicher auf. Wichtig: Der vollständige Schlüsselwert wird erst bei der Erstellung des Schlüssels angezeigt. Sie können nicht erneut darauf zugreifen. Sollten Sie den Wert verlieren, müssen Sie den Schlüssel rotieren, um einen neuen zu generieren.
- Klicken Sie auf Ich habe meinen Schlüssel gespeichert, um das Dialogfeld zu schließen.
- So bearbeiten Sie einen bestehenden API-Schlüssel:
- Klicken Sie im linken Bereich von Account Administration auf API-Schlüssel.
- Suchen Sie den Schlüssel, den Sie ändern möchten. Klicken Sie mit der rechten Maustaste auf die Zeile des Schlüssels und wählen Sie API-Schlüssel bearbeiten aus.
- Passen Sie den Namen, das Ablaufdatum oder die Beschreibung nach Bedarf an.Das Bearbeiten eines Schlüssels hat keine Auswirkungen auf den Schlüsselwert. Anwendungen, die den Schlüssel bereits verwenden, funktionieren weiterhin ohne Änderungen.
- Klicken Sie auf OK.
- So rotieren Sie einen API-Schlüssel:
- Klicken Sie im linken Bereich von Account Administration auf API-Schlüssel.
- Suchen Sie den Schlüssel, den Sie drehen möchten. Klicken Sie mit der rechten Maustaste auf die Zeile des Schlüssels und wählen Sie API-Schlüssel rotieren aus.
- Stellen Sie den Parameter Überschneidungszeitraum in Tagen auf die Anzahl der Tage ein, an denen sowohl der bestehende Schlüssel als auch die rotierte Version gleichzeitig aktiv sein sollen.
- Legen Sie für den Schlüssel einen neuen Wert Ablaufdatum fest.
- Klicken Sie auf OK.
- Klicken Sie auf Kopieren, um den generierten Schlüssel in Ihre Zwischenablage zu kopieren. Bewahren Sie es
sicher auf. Wichtig: Der vollständige Schlüsselwert wird erst bei der Erstellung des Schlüssels angezeigt. Sie können nicht erneut darauf zugreifen. Sollten Sie den Wert verlieren, müssen Sie den Schlüssel rotieren, um einen neuen zu generieren.
- Aktualisieren Sie alle Anwendungen, Skripte oder gespeicherten interaktiven Dokumentationssitzungen, die diesen Schlüssel verwenden, bevor der Überschneidungszeitraum abläuft.
- So entfernen Sie einen Schlüssel aus dem System:
- Klicken Sie im linken Bereich von Account Administration auf API-Schlüssel.
- Suchen Sie den Schlüssel, den Sie drehen möchten. Klicken Sie mit der rechten Maustaste auf die Zeile des Schlüssels und wählen Sie Sofort löschen aus.
- Wählen Sie im Dialogfeld Folgendes aus: Ja, diesen Schlüssel löschen.Dieser Schritt ist erforderlich, da das Löschen unwiderruflich ist. Sobald Sie den Schlüssel gelöscht haben, können Sie ihn nicht mehr wiederherstellen.
- Klicken Sie auf OK.
Sie können den neuen oder aktualisierten API-Schlüssel auf der Seite mit der interaktiven Dokumentation verwenden, um die Datenexport-API zu testen, sowie in jeder Anwendung, die Anfragen an die API sendet.