Anwendung "API-Schlüssel"

Sie verwenden API-Schlüssel, um eine eingehende Machine-to-Machine-Integration für einen externen Client zu aktivieren. API-Schlüssel können von den OSLC-und REST-APIs sowie als Teil des Integrationsframeworks Verwalten verwendet werden.

Bei einer Machine-to-Machine-Integration interagiert eine externe Maschine ohne Verwendung eines Browsers mit Manage -Daten im Manage -System. API-Schlüssel sind eine native Form von Authentifizierung, die kein externes System oder Repository für die Kennwortspeicherung benötigt.

Standardmäßig werden alle API-Schlüssel beim Speichern verschlüsselt. Diese Einstellung wird mit der Eigenschaft mxe.secureapikey gesteuert.

API-Schlüssel für REST-APIs hinzufügen

Wenn dem externen Client ein API-Schlüssel zugeordnet ist, kann der externe Client auf Daten im Manage -System zugreifen und mit diesen interagieren, indem er den API-Schlüssel als apikey -Abfrageparameter oder als apikey -Anforderungsheader in REST-API-Aufrufen verwendet. REST-API-Aufrufe, die einen API-Schlüssel verwenden, stellen keine persistente Serververbindung her, und der API-Schlüssel muss Teil aller REST-API-Anforderungen sein, die der externe Client absetzt.

Wenn Sie einen API-Schlüssel verwenden möchten, rufen Sie Integration > Anwendung 'API-Schlüssel' im Menü auf.

Extern erstellte API-Schlüssel verwenden

Sie können extern erstellte API-Schlüssel als API-Schlüssel in Maximo® Manageverwenden.Erstellen Sie diesen Typ von API-Schlüssel, indem Sie die MXAPIAPIKEY -REST-API verwenden und Ihren generierten API-Schlüssel mithilfe der JSON-Eigenschaft "apikey" bereitstellen, wie im folgenden Code gezeigt:

POST /oslc/os/mxapiapikey
{
 "apikey":"<outside generated apikey>",
 "expiration":-1
}

Sicherheitszugriff

Als Systemadministrator müssen Sie Manage -Benutzer für die externen Clients synchronisieren, bevor API-Schlüssel für diese Clients erstellt werden. Die Berechtigungen, die dem API-Schlüssel zugeordnet werden, richten sich nach den Berechtigungen für den zugeordneten Benutzer. Sie können API-Schlüssel in der Anwendung API-Schlüssel unter Integrationerstellen und konfigurieren.

Sie können auch die Sicherheit angeben, die nur den angemeldeten Benutzer ermöglicht, einen API-Schlüssel zu erstellen. Um die Erstellung von API-Schlüsseln auf den angemeldeten Benutzer zu beschränken, wechseln Sie in die Anwendung "Systemeigenschaften" und filtern die Einträge nach der Eigenschaft mxe.apikeyforloggedinuser. Geben Sie im Feld Globaler Wert den Wert 1 ein und speichern Sie den Datensatz. Wählen Sie Zeitnahme Aktualisierung aus, um den Wert sofort anzuwenden.

Um den Zugriff auf das System Verwalten für einen externen Client zu inaktivieren, können Sie den zugehörigen API-Schlüssel löschen, aber der externe Client kann weiterhin über ein anderes konfiguriertes Authentifizierungssystem auf das System Verwalten zugreifen. Wenn ein API-Schlüssel kompromittiert ist, löschen Sie den Schlüssel und erstellen Sie dann einen anderen Schlüssel für diesen Benutzer.