Identity Manager 8.2.1 - API-Entwicklungshandbuch

Sie verknüpfen Ihr API Designer-Projekt mit einem neuen oder bestehenden C#-Projekt.
Sie bearbeiten das C#-Projekt in einem externen Programm.
Sie öffnen das C#-Projekt wieder im API Designer und speichern es im API-Projekt.

Um das API Designer-Projekt mit einem C#-Projekt zu verknüpfen

In der Menüleiste klicken Sie Ansicht > Startseite.
Auf der Startseite klappen Sie den Bereich C#-Entwicklung aus.
Im Bereich C#-Entwicklung führen Sie einen der folgenden Aktionen aus:
- Um das API Designer-Projekt als neues C#-Projekt zu exportieren und zu verknüpfen, klicken Sie (C#-Projekt exportieren). Navigieren Sie zu dem Ordner, in den Sie die Inhalte Ihres API Designer-Projekts als C#-Projekt exportieren möchten und klicken Sie OK.
- Um das API Designer-Projekt mit einem bestehenden Projekt zu verknüpfen, klicken Sie (C#-Projekt laden).
Der API Designer wird mit dem C#-Projekt verknüpft.

Um das C#-Projekt in externen Programmen zu bearbeiten

In der Menüleiste klicken Sie Ansicht > Startseite.
Auf der Startseite klappen Sie den Bereich C#-Entwicklung aus.
Im Bereich C#-Entwicklung klicken Sie auf Projektdatei: <Pfad zum C#-Projekt>.

Das Projekt öffnet sich in dem Programm, das mit der Projektdatei verknüpft ist.

TIPP: Um den Projektordner direkt zu öffnen, klicken Sie (Zugehörigen Ordner öffnen).
Bearbeiten Sie das Projekt in dem externen Programm. Sie können beispielsweise API-Dateien erstellen, ändern oder löschen.

Um Änderungen wieder in das API Designer-Projekt zurückzuspielen

Öffnen Sie den API Designer.
In der Menüleiste klicken Sie Ansicht > Startseite.
Auf der Startseite klappen Sie den Bereich C#-Entwicklung aus.
Im Bereich C#-Entwicklung klicken Sie (C#-Projekt mit Basis abgleichen).

Sie sehen nun die Objekte, die Sie außerhalb des API Designers geändert haben.

Wählen Sie aus den Auswahllisten neben den geänderten Objekten die Aktionen die Sie für das API Designer-Projekt durchführen möchten.

Statusmeldung	Beschreibung	Aktionen
Neue C#-Datei	Eine neue API-Datei wurde im C#-Projekt erstellt.	API-Datei hinzufügen: Fügt die C#-Datei, die Sie im externen Programm erstellt haben, Ihrem API Designer-Projekt als API-Datei hinzu. Datei löschen: Löscht die C#-Klasse im C#-Projekt.
Neue API-Datei	Eine neue API-Datei wurde im API Designer-Sharp-Projekt erstellt.	C#-Datei hinzufügen: Fügt die API-Datei, die Sie im API Designererstellt haben, Ihrem C#-Projekt als C#-Datei hinzu. API-Datei löschen: Löscht die API-Datei im API Designer-Projekt.
API-Datei ist neuer	Eine API-Datei wurde im API Designer-Projekt geändert.	Update: Übernimmt die Änderungen an der API-Datei aus dem API Designer-Projekt in das C#-Projekt. Änderungen rückgängig machen: Macht die Änderungen, die Sie in Ihrem API Designer-Projekt an der API-Datei gemacht haben, rückgängig.
C#-Datei ist neuer	Eine API-Datei wurde im C#-Projekt geändert.	Update: Übernimmt die Änderungen an der API-Datei aus dem C#-Projekt in das API Designer-Projekt. Änderungen rückgängig machen: Macht die Änderungen, die Sie in Ihrem C#-Projekt an der API-Datei gemacht haben, rückgängig.

Aktivieren Sie die Kontrollkästchen neben Objekten, für die Sie die gewählten Aktionen durchführen möchten.

TIPP: Um alle Objekte aus- oder abzuwählen, aktivieren Sie das Kontrollästchen Alle auswählen/abwählen über der Liste.
Klicken Sie (Ausgewählte Aktionen anwenden).

API-Projekte

Ein API-Projekt stellt die eigentliche Anwendung, die API selbst, dar.

Sie können API-Dateien, die Sie erstellt haben, in einem API-Projekt zu einer logischen Anwendung zusammenfassen. Das API-Projekt stellt dabei die Konfiguration zur Verfügung. Zu einem API-Projekt gehört die Authentifizierung an der Datenbank.

API-Projekte erstellen

API-Projekte > API-Projekte erstellen

Sie können jederzeit neue API-Projekte erstellen.

Um ein API-Projekt zu erstellen

Starten Sie das Programm API Designer.
In der Menüleiste klicken Sie Ansicht > Navigation.
In der Navigation klicken Sie API-Projekte.
Klicken Sie (Hinzufügen) > API-Projekt hinzufügen.
Im Definitionsbaumfenster klicken Sie den obersten Knoten.
In der Menüleiste klicken Sie Ansicht > Knotenbearbeitung.

Im Knotenbearbeitungsfenster nehmen Sie die folgenden Einstellungen vor:

Einstellung	Beschreibung
Allgemeine Einstellungen
Bezeichner	Geben Sie einen eindeutigen Namen für den Knoten ein.
Technisches Kürzel	Geben Sie einen Kurznamen für das API-Projekt ein. Dieser Name wird später für die Zuordnung des Projekts verwendet.
Control-ID	Geben Sie eine eindeutige ID für den Knoten ein.
Modellversion	Zeigt Ihnen die verwendete Modellversion an.
Ablaufkontrolle
Erweiterungen auf diesem Dokument erlauben	Aktivieren Sie diese Option, um das Anlegen von Erweiterungen an diesem Knoten zu erlauben.
Erweiterte Einstellungen
Erforderliche Datenbankmodule	(Optional) Geben Sie die Datenbankmodule ein, die für dieses API-Projekt erforderlich sind.

Legen Sie weitere Einstellungen für das API-Projekt fest (siehe Authentifizierung für das Web Portal für Betriebsunterstützung konfigurieren und Kompilierung konfigurieren).
In der Symbolleiste klicken Sie (Speichern).

API-Projekte bearbeiten

API-Projekte > API-Projekte bearbeiten

Sie können jederzeit Ihre bereits erstellten API-Projekte bearbeiten.

HINWEIS: Sie können keine API-Projekte bearbeiten, die vom API Designer vordefiniert wurden.

Um ein bestehendes API-Projekt zu bearbeiten

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 bearbeiten möchten.
In der Menüleiste klicken Sie Ansicht > Knotenbearbeitung.
Im Definitionsbaumfenster und Knotenbearbeitungsfenster legen Sie weitere Einstellungen für das API-Projekt fest (siehe Authentifizierung für das Web Portal für Betriebsunterstützung konfigurieren und Kompilierung konfigurieren).
In der Symbolleiste klicken Sie (Speichern).