API-Schlüssel erstellen

Damit Anwendungen direkt mit Plattformservices wie IBM® X-Force® Exchangekommunizieren können, müssen Sie einen API-Schlüssel bereitstellen.

Informationen zu dieser Task

Der API-Schlüssel ist eine zweiteilige Zeichenfolge, die aus einer eindeutigen Kennung und einem geheimen Token besteht, die für die Authentifizierung beim API-Endpunkt verwendet wird. Die eindeutige ID ist mit einer Benutzer-ID vergleichbar und verfügt über eine Gruppe von Zugriffsberechtigungen, die für eine zugeordnete Identität spezifisch sind. Das mit einem Kennwort vergleichbare geheime Token ist ein Code, der zusammen mit der eindeutigen ID verwendet wird, um die Identität des aufrufenden Prozesses für die API zu verifizieren.

Wichtig:

Schützen Sie Ihren Schlüssel, indem Sie ihn nach 90 Tagen löschen und einen neuen erstellen.

Vorgehensweise

  1. Klicken Sie auf der Homepage auf das Symbol Menü .
  2. Klicken Sie unter Allgemeine Einstellungenauf API-Schlüssel und dann auf API-Schlüssel erstellen.
  3. Geben Sie im Feld API-Schlüsselname einen eindeutigen und aussagekräftigen Namen ein, der den Schlüssel für Sie identifiziert.
  4. Klicken Sie auf Generieren.

Die Ergebnisse

Wenn Ihr Schlüssel erstellt wird, stellt das Teilfenster API-Schlüssel erstellen die API-Schlüsseldetails bereit: Eine eindeutige ID und ein geheimes Token werden zugewiesen.

Wichtig: Nachdem Sie auf Fertiggeklickt haben, können Sie das geheime Token nicht mehr abrufen. Speichern Sie die Schlüsseldetails an einer sicheren Position, indem Sie den Schlüsselcode und das geheime Token kopieren oder in eine Textdatei (.txt) herunterladen.

API-Schlüssel anzeigen

Auf der Seite API-Schlüssel können Sie eine Liste der vorhandenen API-Schlüssel anzeigen.

Vorgehensweise

  1. Klicken Sie auf der Homepage auf das Symbol Menü .
  2. Klicken Sie unter Allgemeine Einstellungenauf API-Schlüssel.
  3. Auf der Seite API-Schlüssel werden Details zu den vorhandenen Schlüsseln angezeigt, die Sie erstellt haben. Die Zeile mit den Werten für jeden Schlüssel enthält den von Ihnen angegebenen Namen und die zugeordnete eindeutige ID. Letzte Änderung enthält das Erstellungsdatum oder das Datum, an dem Sie den Schlüsselnamen zuletzt geändert haben.

API-Schlüssel löschen

Einen API-Schlüssel, den Sie nicht mehr benötigen, können Sie ohne größeren Aufwand löschen.

Vorgehensweise

  1. Klicken Sie auf der Homepage auf das Symbol Menü .
  2. Klicken Sie unter Allgemeine Einstellungenauf API-Schlüssel.
  3. Bewegen Sie den Mauszeiger über die Zeile, die den Schlüssel enthält, den Sie löschen möchten.
  4. Klicken Sie auf Löschsymbol.
  5. Klicken Sie auf Löschen.