Mithilfe des Knotens Kompilierungseinstellungen im Definitionsbaumfenster des API Designers legen Sie Einstellungen fest, die für die Kompilierung der API benötigt werden.

Wenn Sie im Code Ihrer API Code aus anderen DLLs verwenden möchten (beispielsweise API-Dateien aus anderen Projekten), müssen Sie eine Assembly-Referenz erstellen, damit der Kompiler diese DLLs erkennt.

Um eine Assembly-Referenz zu erstellen

Starten Sie das Programm API Designer.
In der Menüleiste klicken Sie Ansicht > Navigation.
In der Navigation klicken Sie API-Projekte.
In der Baumstruktur doppelklicken Sie das API-Projekt, die Sie bearbeiten möchten.
Im Definitionsbaumfenster rechtsklicken Sie den Knoten Kompilierungseinstellungen.
Im Kontextmenü klicken Sie Assembly-Referenz.

Der Knoten Assembly-Referenz wird dem Knoten untergeordnet.
Im Definitionsbaumfenster klicken Sie den Knoten Assembly-Referenz.
In der Menüleiste klicken Sie Ansicht > Knotenbearbeitung.
Im Knotenbearbeitungsfenster geben Sie im Eingabefeld Referenzierte Assembly den Namen der Assembly ein, die Sie referenzieren möchten.
In der Menüleiste klicken Sie (Speichern).

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

Erstellen Sie ein API-Plugin (siehe API-Plugins erstellen und bearbeiten).
Kompilieren Sie den entsprechenden TypeScript API-Client (siehe TypeScript API-Clients kompilieren).

Detaillierte Informationen zum Thema

API-Plugins erstellen und bearbeiten

Eigene APIs implementieren > API-Plugins erstellen und bearbeiten

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

Zusätzlich können Sie bereits bestehende API-Projekte, die Sie mit dem API Designer erstellt haben, in API-Plugins konvertieren (siehe API-Projekte in API-Plugins konvertieren).

Voraussetzungen:

Sie verwenden eine Versionsverwaltung (beispielsweise Git).
Sie verwenden eine Integrierte Entwicklungsumgebung (IDE).

Um ein API-Plugin zu erstellen

Starten Sie Ihre IDE (beispielsweise Visual Studio).
Erstellen Sie ein neues .NET Framework 4.8-Projekt mit dem Namen CCC.CompositionApi.Server.Plugin.
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
Erstellen Sie den API-Code.
Kompilieren Sie die DLL-Datei in Ihrer IDE.
Importieren Sie die DLL-Datei mithilfe des Software Loaders in Ihre One Identity Manager-Datenbank und weisen Sie sie der Maschinenrolle 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.
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

Starten Sie Ihre IDE (beispielsweise Visual Studio).
Öffnen Sie das bestehende .NET Framework 4.8-Projekt.
Bearbeiten Sie den API-Code.
Kompilieren Sie die DLL-Datei in Ihrer IDE.
Importieren Sie die DLL-Datei mithilfe des Software Loaders in Ihre One Identity Manager-Datenbank und weisen Sie sie der Maschinenrolle 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.
Starten Sie den API Server neu und stellen Sie sicher, dass die Datei CCC.CompositionApi.Server.Plugin.dll vorhanden ist.

API-Projekte in API-Plugins konvertieren

Eigene APIs implementieren > API-Plugins erstellen und bearbeiten > API-Projekte in API-Plugins konvertieren

Sie können API-Projekte, die Sie mit dem API Designer erstellt haben, in API-Plugins konvertieren. Dafür müssen Sie den Code des API-Projekts als C#-Code in eine API-Datei importieren, das API-Projekt anschließend löschen und ein neues API-Plugin mit dem Code aus der neuen API-Datei erstellen.

Um ein API-Projekt in ein API-Plugin zu konvertieren

Starten Sie das Programm API Designer.
In der Menüleiste klicken Sie Ansicht > Navigation.
In der Navigation klicken Sie API-Projekte.
In der Baumstruktur doppelklicken Sie das API-Projekt, das Sie konvertieren möchten.
Klicken Sie Generierter Code.
Kopieren Sie den gesamten Code in die Zwischenablage.
In der Menüleiste klicken Sie Ansicht > Navigation.
In der Navigation klicken Sie API-Dateien.
Klicken Sie (Hinzufügen) > API-Datei hinzufügen.
Im neuen Fenster fügen Sie den Code aus der Zwischenablage ein.
Im Eingabefeld Bezeichner geben Sie einen Namen für die API-Datei ein.
In der Symbolleiste klicken Sie (Speichern).
Löschen Sie das API-Projekt (siehe API-Projekte löschen).
Erstellen Sie das API-Plugin und verwenden Sie dabei den Code aus der neu erstellten API-Datei (siehe API-Plugins erstellen und bearbeiten).