Chat now with support
Chat with Support

Identity Manager 9.1 - API-Entwicklungshandbuch

Eigene APIs implementieren

Um eigene APIs zu implementieren, können Sie API-Plugins erstellen.

Der API Server lädt alle DLLs, auf die das Namensschema *.CompositionApi.Server.PlugIn.dll passen, und stellt die darin enthaltenen API-Definitionen zur Verfügung.

Um eine eigene API zu implementieren

  1. Erstellen Sie ein API-Plugin (siehe API-Plugins erstellen und bearbeiten).

  2. Kompilieren Sie den entsprechenden TypeScript API-Client (siehe TypeScript API-Clients kompilieren).

Detaillierte Informationen zum Thema

API-Plugins erstellen und bearbeiten

Mithilfe von API-Plugins können Sie eigens entwickelte APIs implementieren und verwenden.

Voraussetzungen:

  • Sie verwenden eine Versionsverwaltung (beispielsweise Git).

  • Sie verwenden eine integrierte Entwicklungsumgebung (IDE).

Um ein API-Plugin zu erstellen

  1. Starten Sie Ihre IDE (beispielsweise Visual Studio).

  2. Erstellen Sie ein neues .NET Framework 4.8-Projekt mit dem Namen CCC.CompositionApi.Server.Plugin.

  3. Fügen Sie Referenzen auf die folgenden DLL-Dateien aus dem Installationsverzeichnis von One Identity Manager hinzu:

    • QBM.CompositionApi.Server.dll

    • VI.Base.dll

    • VI.DB.dll

  4. Erstellen Sie den API-Code.

  5. Kompilieren Sie die DLL-Datei in Ihrer IDE.

  6. Importieren Sie die DLL-Datei mithilfe des Software Loaders in Ihre One Identity Manager-Datenbank und weisen Sie sie der Maschinenrolle Business API Server zu. Weitere Informationen zum Importieren von Dateien mit dem Software Loader finden Sie im One Identity Manager Administrationshandbuch für betriebsunterstützende Aufgaben.

  7. Starten Sie den API Server neu und stellen Sie sicher, dass die Datei CCC.CompositionApi.Server.Plugin.dll vorhanden ist.

Um ein bestehendes API-Plugin zu bearbeiten

  1. Starten Sie Ihre IDE (beispielsweise Visual Studio).

  2. Öffnen Sie das bestehende .NET Framework 4.8-Projekt.

  3. Bearbeiten Sie den API-Code.

  4. Kompilieren Sie die DLL-Datei in Ihrer IDE.

  5. Importieren Sie die DLL-Datei mithilfe des Software Loaders in Ihre One Identity Manager-Datenbank und weisen Sie sie der Maschinenrolle Business API Server zu. Weitere Informationen zum Importieren von Dateien mit dem Software Loader finden Sie im One Identity Manager Administrationshandbuch für betriebsunterstützende Aufgaben.

  6. Starten Sie den API Server neu und stellen Sie sicher, dass die Datei CCC.CompositionApi.Server.Plugin.dll vorhanden ist.

TypeScript API-Clients kompilieren

Nachdem Sie ein API-Plugin erstellt haben, müssen Sie einen entsprechenden TypeScript API-Client kompilieren.

Um einen TypeScript API-Client zu kompilieren

  1. Öffnen Sie ein Kommandozeilenprogramm.

  2. Führen Sie folgenden Befehl aus:

    imxclient compile-api -N -W /copyapi imx-api-ccc.tgz /packagename imx-api-ccc

    Das Dialogfenster zum Auswählen der Datenbankverbindung öffnet sich.

  3. Im Dialogfenster nehmen Sie eine der folgenden Aktionen vor:

    • Um eine bestehende Verbindung zur One Identity Manager-Datenbank zu verwenden, wählen Sie aus der Auswahlliste Datenbankverbindung auswählen die entsprechende Verbindung aus.

      - ODER -

    • Um eine neue Verbindung zur One Identity Manager-Datenbank zu verwenden, klicken Sie Neue Verbindung erstellen und geben Sie eine neue Verbindung an.

  4. Unter Authentifizierungsverfahren geben Sie das Verfahren und die Anmeldedaten an, mit denen Sie sich an der Datenbank anmelden möchten.

  5. Klicken Sie Anmelden.

  6. Importieren Sie das npm-Paket imx-api-ccc in Ihre TypeScript-Anwendung.

ImxClient-Kommandozeilenprogramm

Mithilfe des ImxClient-Kommandozeilenprogramms können Sie verschiedene Funktionen zum Verwalten des API Servers und von Dateien in der Kommandozeile ausführen.

Detaillierte Informationen zum Thema
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating