API-Schlüssel

Ein API-Schlüssel ermöglicht es einem anderen Programm, die AurionAI-API für Ihre Organisation zu verwenden. Jeder Schlüssel verfügt über eine Liste von Berechtigungen, sogenannte Scopes. Ein Schlüssel kann nur das tun, was seine Scopes erlauben.

Verfügbarkeit: alle Profile. Nur Administratoren.

Voraussetzungen

• Sie haben die Rolle Eigentümer oder Administrator. Andere Benutzer sehen Zugriff verweigert.
• Sie wissen, was das Programm tun muss, damit Sie ihm nur die benötigten Scopes zuweisen.

API-Schlüssel öffnen

1. Wählen Sie in der Seitenleiste Konfiguration.
2. Öffnen Sie die Kategorie Systemeinstellungen.
3. Wählen Sie API-Schlüssel.

Die Tabelle Aktive Schlüssel zeigt den Namen, den Anfang des Schlüssels, die Scopes, den Status, das Erstellungsdatum, die letzte Verwendung und das Ablaufdatum jedes Schlüssels. Widerrufene Schlüssel werden unter Widerrufene Schlüssel aufgeführt.

Schlüssel erstellen

1. Wählen Sie Schlüssel erstellen.
2. Geben Sie unter Name einen Namen ein, der angibt, welches Programm den Schlüssel verwendet.
3. Optional: Beschreiben Sie unter Beschreibung (optional), wofür der Schlüssel verwendet wird.
4. Wählen Sie unter Ablauf, wann der Schlüssel abläuft. Der Standardwert ist 90 Tage. Sie können auch Kein Ablauf wählen.
5. Wählen Sie unter Berechtigungen die Scopes aus. Ein Gruppen-Kontrollkästchen wählt alle Scopes der Gruppe aus.
6. Wählen Sie Schlüssel erstellen.
7. Kopieren Sie den Schlüssel mit API-Schlüssel kopieren. AurionAI zeigt den vollständigen Schlüssel nur dieses eine Mal an.
8. Wählen Sie Ich habe ihn kopiert — schließen.

Das Programm sendet den Schlüssel im X-API-Key-Header jeder Anfrage. Ein Schlüssel beginnt mit itsm_sk_live_ oder mit itsm_sk_test_ für eine Sandbox-Organisation.

Scopes

Hinweise zu den Scopes:

• Um Wissensdatenbank-Artikel mit Bildern zu veröffentlichen, benötigt ein Schlüssel kb:read, kb:write und kb:media. Mit nur kb:read und kb:write können keine Bilder hochgeladen werden. Es gibt keinen Scope zum Löschen von Artikeln.
• Um ein Anruftranskript zu exportieren, benötigt ein Schlüssel conversations:read, conversations:write und conversations:export; Schlüssel, die erstellt wurden, bevor conversations:export existierte, können erst exportieren, wenn Sie einen Ersatzschlüssel mit diesem Scope erstellen.
• Es gibt keinen Scope „alle Berechtigungen". Wählen Sie jeden Scope aus, den das Programm benötigt.

Schlüssel rotieren

Rotieren Sie einen Schlüssel, wenn Sie vermuten, dass jemand anderes ihn kennt.

1. Wählen Sie in der Spalte Aktionen des Schlüssels Schlüssel rotieren.
2. Wählen Sie im Dialog API-Schlüssel rotieren die Option Schlüssel rotieren.
3. Kopieren Sie den neuen Schlüssel. Der alte Schlüssel funktioniert nicht mehr. Aktualisieren Sie das Programm mit dem neuen Schlüssel.

Der neue Schlüssel behält den Namen, die Scopes und das Ablaufdatum des alten Schlüssels.

Schlüssel widerrufen

1. Wählen Sie in der Spalte Aktionen des Schlüssels Schlüssel widerrufen.
2. Wählen Sie im Dialog API-Schlüssel widerrufen die Option Schlüssel widerrufen.

Die Meldung API-Schlüssel widerrufen wird angezeigt. Programme, die den Schlüssel verwenden, verlieren sofort den Zugriff. Dies kann nicht rückgängig gemacht werden.

Ergebnis

Ein neuer Schlüssel funktioniert sofort, jedoch nur mit seinen Scopes. Die Spalte Status zeigt Aktiv, Läuft bald ab in den letzten sieben Tagen vor dem Ablauf, Abgelaufen oder Widerrufen.

Wenn etwas schiefläuft

• Wählen Sie mindestens eine Berechtigung aus Wählen Sie mindestens einen Scope aus.
• API-Schlüssel konnte nicht erstellt werden Versuchen Sie es erneut. Wenn es erneut fehlschlägt, wenden Sie sich an den AurionAI-Support. Lesen Sie Hilfe erhalten.
• Geheimnis nicht verfügbar AurionAI hat den Schlüssel nicht angezeigt. Verwenden Sie diesen Schlüssel nicht. Widerrufen Sie ihn und erstellen Sie einen neuen.
• Sie haben den Schlüssel verloren. AurionAI kann ihn nicht erneut anzeigen. Rotieren Sie den Schlüssel oder erstellen Sie einen neuen.
• Eine Anfrage mit dem Schlüssel wird abgelehnt. Dem Schlüssel fehlt der Scope für diese Anfrage, oder er ist abgelaufen oder widerrufen. Überprüfen Sie die Spalten Bereiche und Status.
• Ein Programm kann keine Bilder in die Wissensdatenbank hochladen. Fügen Sie kb:media hinzu: Erstellen Sie einen neuen Schlüssel mit kb:read, kb:write und kb:media.

Verwandte Artikel

• Developer API: Nutzung und Webhooks
• Verbinden Sie Ihre ITSM- und CS-Tools
• Hilfe erhalten