Seminar VisionsTrust – API-Integration und API Consumption

API-basierte Datenverarbeitung verbindet Datenangebote mit verarbeitenden Diensten. Das Seminar behandelt die fachliche und technische Vorbereitung von Daten- und Service-Ressourcen, die Konfiguration des API-Consumption-Ablaufs und die kontrollierte Ausführung über den Data-Space-Connector.

Inhaltsverzeichnis

1. Zielsetzung
2. Seminarinhalte
3. Praxisübungen
4. Zielgruppe
5. Voraussetzungen
6. Methodik

Zielsetzung

Nach dem Seminar können Datenlieferanten und Serviceanbieter kompatible Ressourcen konfigurieren, Endpunkte und Parameter sicher beschreiben, Vertragsvoraussetzungen prüfen und einen API-Consumption-Ablauf vollständig testen und überwachen.

Seminarinhalte

1. Integrationsszenario und Rollen modellieren

• Schritt 1: Datenlieferant, Serviceanbieter, Connectoren und Projektkontext eindeutig bestimmen.
• Schritt 2: Eingabe-, Verarbeitungs- und Ausgabeobjekte fachlich beschreiben.
• Schritt 3: Erfolgskriterien, Fehlergrenzen und Verantwortlichkeiten festlegen.

2. Datenressource als API-Nutzlast vorbereiten

• Schritt 1: Geeignete Datenressource und deren Datenformat auswählen.
• Schritt 2: Kennzeichnung als Nutzlast für die API-Verarbeitung setzen.
• Schritt 3: Abrufquelle, Zugriffsschutz und technische Repräsentation vollständig dokumentieren.

3. Service-Ressource für API Consumption konfigurieren

• Schritt 1: Eingabeanforderungen und Rückgabeformat des Dienstes definieren.
• Schritt 2: Service-Endpunkt, Methode und technische Rahmenbedingungen hinterlegen.
• Schritt 3: Kompatibilität zwischen Datenressource und Serviceeingang prüfen.

4. Parameter und Zugangsdaten verwalten

• Schritt 1: Pflicht-, optionale und dynamische Parameter unterscheiden.
• Schritt 2: Geheimnisse nur über vorgesehene Kennungen referenzieren.
• Schritt 3: Gültigkeit, Rotation und Fehlverhalten von Zugangsdaten testen.

5. Angebote und Projektkontext herstellen

• Schritt 1: Ressourcen in auffindbare Angebote überführen.
• Schritt 2: Angebote dem passenden Projekt und den beteiligten Rollen zuordnen.
• Schritt 3: Vertragsstatus, Richtlinien und Signaturen vor der Ausführung kontrollieren.

6. Connector-Ablauf technisch nachvollziehen

• Schritt 1: Aufrufkette vom Auslöser bis zum Datenabruf schrittweise verfolgen.
• Schritt 2: Übergabe der Nutzlast an den Dienst und Rückführung des Ergebnisses prüfen.
• Schritt 3: Status- und Korrelationsinformationen für die Nachverfolgung verwenden.

7. Fehlerbehandlung und Wiederholbarkeit entwerfen

• Schritt 1: Eingabe-, Transport-, Verarbeitungs- und Vertragsfehler getrennt behandeln.
• Schritt 2: Wiederholungsregeln und Idempotenz für kritische Aufrufe festlegen.
• Schritt 3: Abbruch, Kompensation und manuelle Klärung in einem Fehlerkatalog beschreiben.

8. Sicherheit und Beobachtbarkeit umsetzen

• Schritt 1: Minimale technische Berechtigungen und getrennte Umgebungen einrichten.
• Schritt 2: Protokolle ohne unnötige Nutzdaten oder Geheimnisse gestalten.
• Schritt 3: Messpunkte für Laufzeit, Fehlerquote und Ergebnisqualität definieren.

9. Ende-zu-Ende-Test durchführen

• Schritt 1: Testangebote und Vertragskontext vollständig vorbereiten.
• Schritt 2: API-Consumption-Austausch mit kontrollierten Testdaten starten.
• Schritt 3: Ergebnis, Protokolle und Wiederholungsfall anhand eines Abnahmeprotokolls bewerten.

Praxisübungen

• Daten- und Service-Ressource für einen Verarbeitungsfall modellieren.
• Parameter- und Geheimniskonzept für drei Umgebungen erstellen.
• API-Consumption-Ablauf im Testkontext ausführen und protokollieren.
• Fehlerfälle für ungültige Nutzlast, fehlende Freigabe und nicht erreichbaren Dienst bearbeiten.

Zielgruppe

Softwareentwicklung, Integrationsarchitektur, API-Management, Data Engineering, DevOps, technische Produktverantwortung und Data-Space-Administration.

Voraussetzungen

Sichere Grundlagen zu HTTP-basierten Schnittstellen, Authentifizierung, Datenformaten und der VisionsTrust-Struktur aus Ressourcen, Angeboten, Projekten und Verträgen.

Methodik

Strukturierter Fachvortrag, geführte Demonstrationen, schrittweise Konfigurationsübungen, Fallstudien, Kontrolllisten und betreute Ende-zu-Ende-Szenarien. Ergebnisse werden unmittelbar gegen definierte Akzeptanzkriterien geprüft.