Versions Compared

Old Version 1

changes.mady.by.user Simon Pfendt

Saved on

compared with

New Version Current

changes.mady.by.user Simon Pfendt

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Created dateUpdated dateAffects versionFix version

 

 

Management PortalN/A

In order to authenticate against Blancco Management Portal API endpoints an API Key is required. API Keys are managed through the Management Portal by navigating to "Support"-tab and then to "API Keys".

Table of Contents

All API Keys

This page lists all the created API keys within your tenant with additional details such as the creation date of the API key and the owner of the key.

My API Keys

This page lists your own API keys and allows you to create new API keys as well as manage the existing ones.

Creating new API keys

To create a new API key select "Generate API key" and provide the name and the description for the key to create it. Note that name and description provided are visible for the rest of the users within your tenant if they navigate to "All API Keys" page.

Image Removed

After generating the key a confirmation dialog will be presented allowing you to copy the created API key. The key can be copied also later on from the "My API Keys" page.

Image Removed

Managing existing API keys

Once you have more than one API key created you can view and manage existing API keys from the "My API Keys" tab.

Image Removed

To manage a key, click the settings icon (three dots) next to the name of the key and options to manage the are shown.

Image Removed

The icon from left to right are:

  1. Copy to clipboard - Copies the selected API key to the clipboard.
  2. Delete - Deletes the API key.
  3. Edit - Edit the description and name of the selected key.

Using API key to authenticate requests

In order to authenticate API requests using your API key it needs to be provided as part of the headers of the request.

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.

Table of Contents

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.

Image Added

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.

Image Added

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.

Image Added

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.

Image Added

Die Symbole von links nach rechts sind:

  1. In die Zwischenablage kopieren - Kopiert den ausgewählten API Key in die Zwischenablage.
  2. Löschen - Löscht den API Key.
  3. 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.

HeaderErforderlichBeschreibungHeaderRequiredDescription
X-BLANCCO-API-KEYYesThe content of the header should be the API key. Not, for example, its name. It could look something like this

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".

However, the structure can change at any time.

The only guarantee is that all API keys have a unique value.

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 KeysA below example shows how to include this as a part of simple curl request. Replace {UUID} with a valid report UUID and {API_KEY} with the key string of your API key:

Code Block
curl -X "GET" \
  "https://api.eu-west-1.blancco.cloud/v1/report/export/{UUID}" \
  -H "accept: */*" \
  -H "X-BLANCCO-API-KEY: {API_KEY}"

More details on the available API endpoints and how to use them can be found from hereWeitere Einzelheiten zu den verfügbaren API Endpunkten und deren Verwendung finden Sie hier: [LINK]