API-Schlüssel

Mithilfe von API-Schlüsseln kann eine genehmigte externe Anwendung Informationen mit Ihrem Versafy-Arbeitsbereich austauschen – beispielsweise einem internen Support-Portal oder einem Berichtsworkflow –, ohne die Anmeldung eines Teamkollegen zu verwenden. Da ein Schlüssel dauerhaften Zugriff gewährt, erstellen Sie einen Schlüssel nur für eine bekannte Anwendung und einen bekannten Besitzer.

Navigation: Offen Sonstiges → API-Schlüssel.

Die Seite wird nur für Benutzer angezeigt, die API-Schlüssel verwalten dürfen.

Erstellen Sie einen API-Schlüssel

Erstellen Sie für jede Anwendung und Umgebung einen separaten Schlüssel, damit Sie deren Zweck identifizieren und ihn widerrufen können, ohne damit nicht zusammenhängende Arbeiten zu unterbrechen.

Auswählen Neuer API-Schlüssel.
Geben Sie einen eindeutigen Namen ein, der die Anwendung und Umgebung identifiziert.
Erstellen Sie den Schlüssel.
Kopieren Sie es sofort.
Speichern Sie es in einem zugelassenen Passwort-Manager oder Deployment-Secret-Store.

Das vollständige Geheimnis wird nur einmal angezeigt. Versafy kann es später nicht mehr anzeigen.

Benennen Sie die Schlüssel klar und deutlich

Verwenden Sie Namen wie Supportportal – Produktion oder Reporting-Export – Test. Vermeiden Sie Namen, die Passwörter, Kundendaten oder das Geheimnis selbst enthalten.

Erstellen Sie separate Schlüssel für separate Anwendungen und Umgebungen. Dadurch können Sie eine Integration widerrufen, ohne andere zu unterbrechen.

Verwenden Sie Schlüssel sicher

Platzieren Sie niemals einen Schlüssel in Agentenanweisungen, der Wissensdatenbank, Screenshots, Chat-Nachrichten oder in einem Repository festgeschriebenen Quellcodes.
Verwenden Sie niemals einen browserseitigen oder öffentlichen Standort einer Website, an dem Besucher sie einsehen können.
Geben Sie es nur über einen genehmigten Geheimverwaltungsprozess weiter.
Behandeln Sie kopierte Protokolle und Fehlerberichte als potenziell vertraulich.

Anfragebeispiele und verfügbare Vorgänge finden Sie in der API-Referenz Versafy Ihrer Organisation.

Widerrufen Sie einen API-Schlüssel

Auswählen Widerrufen Geben Sie den genauen Schlüssel ein und bestätigen Sie ihn. Der Widerruf wird für Anwendungen, die ihn nutzen, sofort wirksam.

Wenn ein Schlüssel möglicherweise offengelegt wurde, widerrufen Sie ihn zunächst, erstellen Sie einen Ersatz, aktualisieren Sie die externe Anwendung und überprüfen Sie die relevanten Aktivitäten.

Fehlerbehebung beim API-Zugriff

Der Schlüssel wurde nicht kopiert

Widerrufen Sie den unbrauchbaren Schlüssel und erstellen Sie einen neuen. Das ursprüngliche Geheimnis kann nicht noch einmal gelüftet werden.

Eine Anwendung verliert den Zugriff

Stellen Sie sicher, dass der Schlüssel nicht widerrufen wurde, der richtige Arbeitsbereichsschlüssel konfiguriert ist und der angeforderte Kunden-API-Vorgang für diese Integration verfügbar ist.