Seminar enaio® API-Training – Client- und Server-Schnittstellen

Programmierschnittstellen werden nicht isoliert, sondern im Zusammenspiel mit Objektdefinition, Sicherheitsmodell und Betriebsumgebung betrachtet. Dadurch entstehen Erweiterungen, die fachlich korrekt, technisch wartbar und diagnostizierbar sind.

Zwei Tage sind erforderlich, um Grundlagen und Ereignismodell zu erarbeiten und anschließend einen kleinen Integrationsfall vollständig zu implementieren und zu testen.

Inhaltsverzeichnis

1. Lernziele
2. Zielgruppe
3. Voraussetzungen
4. Seminarinhalte
5. Schnittstellenlandschaft und Systemarchitektur
6. Objektmodell, Sicherheit und Jobs
7. Client- und Serverereignisse
8. Skripting, Diagnose und Wartbarkeit
9. Integrationsprototyp
10. Praxisübungen

Lernziele

• die wichtigsten Schnittstellen und Ausführungskontexte der enaio®-Plattform einordnen
• Objekte, Metadaten, Dokumentinhalte und Rechte im API-Kontext korrekt behandeln
• Client- und Serverereignisse für geeignete Erweiterungspunkte auswählen
• Skripte mit Protokollierung, Fehlerbehandlung und klaren Seiteneffekten entwickeln
• einen Integrationsprototyp systematisch testen und diagnostizieren

Zielgruppe

Anwendungsentwickelnde, technische Consultants, Administrierende und Migrationsverantwortliche mit Aufgaben in Anpassung oder Systemintegration.

Voraussetzungen

Kenntnisse in XML und mindestens einer Skriptsprache. Sicherer Umgang mit enaio®-Objektdefinition und Berechtigungsmodell.

Seminarinhalte

Die Themen werden in einer festen Arbeitsfolge aus Einordnung, Konfiguration oder Bedienung, praktischer Prüfung und dokumentierter Auswertung bearbeitet.

Schnittstellenlandschaft und Systemarchitektur

Die verfügbaren Erweiterungspunkte werden den Komponenten und typischen Integrationszielen zugeordnet.

1. Schritt 1: Client, Webclient, Server, Dienste und Gateway in einer Architekturübersicht abgrenzen.
2. Schritt 2: Clientnahe, serverseitige und webbasierte Schnittstellen nach Einsatzfall unterscheiden.
3. Schritt 3: Authentifizierung, Benutzerkontext und technische Konten für API-Aufrufe einordnen.
4. Schritt 4: Anwendungsfall anhand von Latenz, Transaktionsbedarf und Sicherheitsanforderung klassifizieren.

Objektmodell, Sicherheit und Jobs

Eine API-Operation wird erst dann korrekt, wenn Objektdefinition und Rechteprüfung berücksichtigt sind.

1. Schritt 1: Interne und sichtbare Namen von Objektarten und Feldern ermitteln.
2. Schritt 2: Objekt-ID, Typ-ID, Metadaten und Dokumentinhalt eindeutig auseinanderhalten.
3. Schritt 3: Lesen, Anlegen, Ändern und Löschen im jeweiligen Rechtekontext prüfen.
4. Schritt 4: Passenden Job für eine fachliche Operation auswählen und Parameter vorbereiten.
5. Schritt 5: Rückgabewerte, Statuscodes und fachliche Fehler getrennt auswerten.

Client- und Serverereignisse

Ereignisse ermöglichen kontrollierte Erweiterungen an definierten Punkten eines Arbeitsablaufs.

1. Schritt 1: Auslösenden Benutzer- oder Systemvorgang präzise beschreiben.
2. Schritt 2: Geeignetes Ereignis und Ausführungskontext auswählen.
3. Schritt 3: Verfügbare Objekte und Parameter im Ereignis protokollieren.
4. Schritt 4: Validierung oder Zusatzaktion mit minimalen Seiteneffekten implementieren.
5. Schritt 5: Wiederholungs-, Abbruch- und Fehlerverhalten gezielt testen.

Skripting, Diagnose und Wartbarkeit

Skripte werden mit klaren Ein- und Ausgaben, kontrollierter Protokollierung und reproduzierbaren Tests aufgebaut.

1. Schritt 1: Skript in Initialisierung, Eingabeprüfung, Fachlogik und Fehlerbehandlung gliedern.
2. Schritt 2: Protokolleinträge mit Vorgangs-, Objekt- und Korrelationsdaten versehen.
3. Schritt 3: Fehlerfall ohne unvollständige Datenänderung behandeln.
4. Schritt 4: Testfälle für gültige, ungültige und nicht berechtigte Aufrufe ausführen.
5. Schritt 5: Abhängigkeiten, Konfiguration und Installationsschritte dokumentieren.

Integrationsprototyp

Ein vollständiger Prototyp verbindet Suche, Objektzugriff, Ereignisbehandlung und Diagnose.

1. Schritt 1: Technische Anforderung und Datenfluss in einem Sequenzablauf beschreiben.
2. Schritt 2: Benötigte Objektinformationen über eine geeignete Schnittstelle ermitteln.
3. Schritt 3: Änderung oder Zusatzaktion mit Rechteprüfung umsetzen.
4. Schritt 4: Ergebnis im Client und in den Protokollen kontrollieren.
5. Schritt 5: Prototyp für Übergabe, Wiederverwendung und spätere Erweiterung bereinigen.

Praxisübungen

• Analyse eines Schnittstellenfalls und Auswahl des geeigneten Ausführungskontexts
• Auslesen einer Objektdefinition und Verarbeitung ausgewählter Metadaten
• Implementierung eines Ereignisskripts mit Validierung und Protokollierung
• Fehleranalyse eines absichtlich fehlerhaften API-Aufrufs