| Created date | Updated date | Affects version | Fix version |
|---|---|---|---|
|
| Management Portal | N/A |
Für die Authentifizierung an den API-Endpunkten des Blancco Management Portals ist ein API Key erforderlich. API Keys werden über das Management-Portal verwaltet, indem Sie zur Registerkarte "Support" und dann zu "API Key" navigieren.
Alle API Keys
Diese Seite listet alle erstellten API Keys innerhalb Ihres Mandanten mit zusätzlichen Details wie dem Erstellungsdatum des API Keys und dem Eigentümer des Keys auf.
Meine API Keys
Diese Seite listet Ihre eigenen API Keys auf und ermöglicht es Ihnen, neue API Keys zu erstellen und die vorhandenen zu verwalten.
Neuen API Key erstellen
Um einen neuen API Key zu erstellen, wählen Sie "API Key generieren" und geben Sie den Namen und die Beschreibung für den Key an. Beachten Sie, dass der angegebene Name und die Beschreibung für den Rest der Benutzer innerhalb Ihres Mandanten sichtbar sind, wenn sie zur Seite "Alle API Key" navigieren.
Nach der Generierung des Key wird ein Bestätigungsdialog angezeigt, in dem Sie den erstellten API Key kopieren können. Der Key kann auch später auf der Seite "Meine API Keys" kopiert werden.
Verwalten vorhandener API Keys
Sobald Sie mehr als einen API Key erstellt haben, können Sie die vorhandenen API Key auf der Registerkarte "Meine API Keys" anzeigen und verwalten.
Um einen Key zu verwalten, klicken Sie auf das Einstellungssymbol (drei Punkte) neben dem Namen des Schlüssels und es werden Optionen zur Verwaltung des Keys angezeigt.
Die Symbole von links nach rechts sind:
- In die Zwischenablage kopieren - Kopiert den ausgewählten API Key in die Zwischenablage.
- Löschen - Löscht den API Key.
- Bearbeiten - Bearbeiten Sie die Beschreibung und den Namen des ausgewählten Key.
Verwendung des API Key zur Authentifizierung von Anfragen
Um API Anfragen mit Ihrem API Key zu authentifizieren, muss dieser als Teil der Header der Anfrage angegeben werden.
| Header | Erforderlich | Beschreibung |
|---|---|---|
| X-BLANCCO-API-KEY | Yes | Der Inhalt des Headers sollte der API Key sein. Nicht zum Beispiel sein Name. Er könnte etwa so aussehen: "8574e755-1f80-4af4-b7ae-a8187afb3909". Die Struktur kann sich jedoch jederzeit ändern. Die einzige Garantie ist, dass alle API Key einen eindeutigen Wert haben. |
Das folgende Beispiel zeigt, wie man dies als Teil einer einfachen curl-Anfrage einfügt. Ersetzen Sie {UUID} durch eine gültige Berichts-UUID und {API_KEY} durch die Zeichenfolge Ihres API Keys:
curl -X "GET" \
"https://api.eu-west-1.blancco.cloud/v1/report/export/{UUID}" \
-H "accept: */*" \
-H "X-BLANCCO-API-KEY: {API_KEY}"
Weitere Einzelheiten zu den verfügbaren API Endpunkten und deren Verwendung finden Sie hier: [LINK]