Seminar sovity API-Wrapper und Use-Case-Anwendungen entwickeln

Inhaltsverzeichnis

1. Zielsetzung
2. Zielgruppe
3. Voraussetzungen
4. Seminarinhalte
   1. Modul 1: API-Wrapper, Management API und typisierter Client
   2. Modul 2: QuerySpec, Filter und automatisierte Katalogauswertung
   3. Modul 3: Vertragsverhandlung und Contract Agreement
   4. Modul 4: Asynchrone Use-Case-Anwendung, Callbacks und EDR
   5. Modul 5: Automatisierte Tests und CI-Freigabe
5. Praxisübungen
6. Methodik

Zielsetzung

Das Seminar befähigt zur Entwicklung robuster Anwendungen auf Basis der sovity-Schnittstellen. Im Mittelpunkt stehen die Abgrenzung von API-Wrapper und Management API, ein typisierter Client, automatisierte Katalog- und Vertragsprozesse, Transfersteuerung, Callbacks, Endpoint Data References sowie betriebsfähige Fehlerbehandlung.

Zielgruppe

Softwareentwickler, Solution Architects, Integration Engineers und technische Use-Case-Verantwortliche.

Voraussetzungen

Sichere Kenntnisse in REST-APIs und einer modernen Programmiersprache; Grundverständnis von Datenangebot, Vertragsverhandlung und Transfer.

Seminarinhalte

Die Themen werden in der angegebenen Reihenfolge aufgebaut. Jeder Schritt setzt auf dem zuvor geprüften Systemzustand auf.

Modul 1: API-Wrapper, Management API und typisierter Client

Die passende Schnittstelle wird nach Stabilität, Funktionsumfang und Kopplung ausgewählt.

1. Schritt 1: Aufgaben von Oberfläche, API-Wrapper, Use-Case-API und Management API voneinander abgrenzen.
2. Schritt 2: Typisierten Client mit Basisadresse, Authentifizierung, Zeitüberschreitung und Serialisierung aufbauen.
3. Schritt 3: Anfrage- und Antwortmodelle sowie unbekannte Felder versionsrobust behandeln.
4. Schritt 4: Technische Fehler in konsistente Anwendungsfehler mit Korrelations- und Diagnosekontext übersetzen.

Modul 2: QuerySpec, Filter und automatisierte Katalogauswertung

Große Angebotsmengen werden über reproduzierbare Filter- und Seitennavigationsmuster verarbeitet.

1. Schritt 1: Filterausdrücke, Operatoren, Sortierung, Limit und Seitennavigation passend zum Suchziel definieren.
2. Schritt 2: Katalogantwort in ein internes Anwendungsmodell überführen.
3. Schritt 3: Fehlende Treffer zwischen Metadaten-, Policy-, Teilnehmer- und Erreichbarkeitsursache unterscheiden.
4. Schritt 4: Regressionstest für Suchkriterien und vertrauliche Angebote aufbauen.

Modul 3: Vertragsverhandlung und Contract Agreement

Der asynchrone Vertragsprozess wird bis zur belastbaren Vereinbarung verfolgt.

1. Schritt 1: Angebotspolicy und Teilnehmerkontext in eine Verhandlungsanfrage übernehmen.
2. Schritt 2: Prozesskennung speichern und Zustände über Oberfläche oder API beobachten.
3. Schritt 3: Erfolgreiche Vereinbarung eindeutig für nachfolgende Transfers referenzieren.
4. Schritt 4: Ablehnung wegen Identität, Policy oder Protokollkonfiguration gezielt reproduzieren und beheben.

Modul 4: Asynchrone Use-Case-Anwendung, Callbacks und EDR

Katalog, Verhandlung und Transfer werden zu einem resilienten Anwendungsprozess verbunden.

1. Schritt 1: Katalogauswahl und Verhandlungsanfrage automatisieren und Prozesskennungen persistieren.
2. Schritt 2: Zustände über Polling oder Ereignisse verfolgen und widersprüchliche Antworten kontrolliert behandeln.
3. Schritt 3: Callbacks und Endpoint Data References authentisch, zeitlich begrenzt und idempotent verarbeiten.
4. Schritt 4: Wiederholung, Circuit Breaker, Dead-Letter-Behandlung, Metriken und strukturierte Logs ergänzen.

Modul 5: Automatisierte Tests und CI-Freigabe

Funktionale, integrative, sicherheitsbezogene und betriebliche Risiken werden in wiederholbare Tests überführt.

1. Schritt 1: Testmatrix für Assets, Policies, Katalog, Verhandlung, Transfers und Abweisung erstellen.
2. Schritt 2: API- und Schemafälle sowie ein Zwei-Connector-Ende-zu-Ende-Szenario automatisieren.
3. Schritt 3: Ungültige Identität, unzureichende Policy, manipulierte Parameter und Teilausfall testen.
4. Schritt 4: Build, statische Analyse, Tests, Berichte und Rückfallartefakt in eine CI-Freigabe integrieren.

Praxisübungen

Die Übungen verbinden die einzelnen Konfigurations- und Integrationsschritte zu prüfbaren Arbeitsergebnissen.

• Übung 1: Typisierten Client mit zentraler Authentifizierung und Fehlerabbildung aufbauen.
• Übung 2: Datenangebote automatisiert suchen, filtern und auswählen.
• Übung 3: Vertragsverhandlung und Transfer als asynchronen Prozess orchestrieren.
• Übung 4: Callback mit Wiederholung, Idempotenz und Fehlerfall verarbeiten.

Methodik

Kurze Fachimpulse, Demonstrationen und geführte Schrittfolgen wechseln mit eigenständigen Übungen am System. Die Arbeit erfolgt mit nachvollziehbaren Ausgangszuständen, Prüfkriterien und Negativfällen. Konfigurationen und Testnachweise werden so strukturiert, dass sie in betriebliche Checklisten und interne Standards überführt werden können.