Chat now with support
Chat mit Support

Identity Manager 9.2.1 - API-Entwicklungshandbuch

Über dieses Handbuch Grundlagen der API-Entwicklung Beispiele und Hilfe – Software Development Kit Eigene APIs implementieren ImxClient-Kommandozeilenprogramm

API-Plugins verwalten

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

Voraussetzungen:

  • Sie verwenden eine Versionsverwaltung (beispielsweise Git).

  • Sie verwenden eine integrierte Entwicklungsumgebung (IDE).

Detaillierte Informationen zum Thema

API-Plugins erstellen

Um eigens entwickelte APIs und API-Projekte zu implementieren, können Sie API-Plugins erstellen.

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 einem Namen nach dem folgenden Format: <Name des Projekts>.CompositionApi.Server.Plugin.

  3. Fügen Sie Referenzen auf die folgenden DLL-Dateien aus dem One Identity Manager-Installationsverzeichnis 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. Kopieren Sie die DLL-Datei in das One Identity Manager-Installationsverzeichnis.

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

  8. Starten Sie den API Server neu und stellen Sie sicher, dass die Datei <Name des Projekts>.CompositionApi.Server.Plugin im Ordner bin des API Server-Installationsverzeichnisses vorhanden ist.

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

API-Plugins bearbeiten

Sie können bestehende API-Plugins bearbeiten.

Um ein bestehendes API-Plugin zu bearbeiten

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

  2. Öffnen Sie ein bestehendes .NET Framework 4.8-Projekt.

  3. Bearbeiten Sie den API-Code.

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

  5. Kopieren Sie die DLL-Datei in das One Identity Manager-Installationsverzeichnis.

  6. Importieren Sie die DLL-Datei mithilfe des Software Loaders in Ihre One Identity Manager-Datenbank. 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 <Name des Projekts>.CompositionApi.Server.Plugin im Ordner bin des API Server-Installationsverzeichnisses vorhanden ist.

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

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 (zum Beispiel Windows Powershell).

  2. Im Kommandozeilenprogramm wechseln Sie in das Installationsverzeichnis von One Identity Manager.

  3. Führen Sie das ImxClient-Kommando start-update aus (siehe start-update).

    Beispiel 

    imxclient start-update

  4. Führen Sie das ImxClient-Kommando compile-api aus (siehe compile-api).

    Beispiel 

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

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

  5. 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.

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

  7. Klicken Sie Anmelden.

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

    TIPP: (Optional) Falls Sie einen anderen Paketnamen als imx-api-ccc verwenden möchten, erweitern Sie die Datei remove-local-packages.js und fügen Sie eine Zeile für das Paket in die Liste ein. Dies sorgt dafür, dass Ihr Paket nicht in das Package Locking aufgenommen wird und immer aus der lokalen Quelle aktualisiert wird.

  9. Kopieren Sie die Datei imx-api-ccc.tgz in den Unterordner bin\imx-modules Ihrer IIS-Installation.

  10. Importieren Sie die TGZ-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.

  11. Starten Sie den API Server neu und stellen Sie sicher, dass die Datei imx-api-ccc.tgz im Ordner bin\imx-modules Ihrer IIS-Installation vorhanden ist.

Verwandte Themen
Verwandte Dokumente

The document was helpful.

Bewertung auswählen

I easily found the information I needed.

Bewertung auswählen