Wie kann ich einen API-Schlüssel erstellen?

Dies ist eine Anleitung zur einfachen Erstellung von API-Schlüsseln, die für Integrationen verwendet werden können.

Eine API (Application Programming Interface) ist eine Schnittstelle, die die Integration mit einem System eines Drittanbieters ermöglicht, z. B. Power BI. Sie können die API verwenden, um benutzerdefinierte Integrationen zu erstellen oder noch mehr Ihrer Arbeitsabläufe zu automatisieren.

Um die API zu nutzen, müssen Sie einen API-Schlüssel erstellen. Ein API-Schlüssel ist ein persönlicher Code und dient als Authentifizierungs-Token oder als eindeutige Kennung. Um mehr darüber zu erfahren, wie und wofür Sie den API-Schlüssel verwenden können, besuchen Sie die Impero API-Dokumentation.

Hinweis: Um einen API-Schlüssel zu erstellen, müssen Sie entweder die Rolle Administrator oder API-Manager haben. Sie möchten mehr über Rollen in Impero erfahren? Gehen Sie zu Nutzer, Rollen und Nutzergruppen verwalten.

Achtung! Der API-Schlüssel hat Zugang zu denselben Daten wie der Ersteller des Schlüssels. D.h. wenn der Ersteller Administrator-Zugriff hat, hat auch der Schlüssel Administrator-Zugriff.

Erstellen eines API-Schlüssels

  1. Melden Sie sich bei Impero an, z.B. https://your_organization.impero.com
  2. Klicken Sie auf "Mein Profil" oben rechts.
  3. Unten auf der Seite finden Sie Ihre API-Schlüssel. Klicken Sie auf "Erstelle API-Schlüssel".
  4. Geben Sie einen Namen für den Schlüssel an, der den Zweck des Schlüssels beschreibt. Der Name dient nur zur Identifizierung.
  5. Geben Sie ein Ablaufdatum für den Schlüssel an oder lassen Sie es bei "läuft nie ab".
  6. Wählen Sie den Anwendungsbereich für den API-Schlüssel. Der Anwendungsbereich bestimmt, welche Operationen Sie mit den Daten durchführen können. Sie können wählen:
    1. "Kontrollen", ermöglicht den Zugriff auf und die Änderung von Kontrollen. Hier haben Sie die Möglichkeit, nur "Kontrollen aktualisieren" oder "Kontrollen ansehen" zu wählen. 
    2. "Kontrollaktivitäten anzeigen", was die Anzeige der Kontrolltätigkeiten ermöglicht
    3. "Datenblätter", ermöglicht Zugriff und Veränderung des Datenblattes. Hinweis: Hier können Sie entweder "Datenblattinhalt aktualisieren" wählen, was die Aktualisierung des Datenblattinhalts ermöglicht, oder "Zeige die Struktur des Datenblattes", was nur die Anzeige der Datenblattstruktur ermöglicht.
    4. "Risiken ansehen" ermöglicht die Anzeige der Risikoverzeichnisse, Risikokarten und Entitäten.
  7. Klicken Sie auf "OK".
  8. Ein neuer API-Schlüssel wird nun auf dem Bildschirm angezeigt. Kopieren und speichern Sie den API-Schlüssel, da Sie nach dem Schließen des Dialogfelds nicht mehr auf den Schlüssel zugreifen können. Der API-Schlüssel wird in der Starter-Vorlage verwendet.

Tipp: Wir empfehlen einen Schlüssel für jede Integration und für verschiedene Zwecke. Jeder Nutzer kann mehrere API-Schlüssel erstellen.