Seminar REI3 – APIs, REST und Dateiaustausch

Die Schulung zeigt, wie REI3 Daten und Dateien über abgesicherte REST-Schnittstellen bereitstellt, externe Dienste aufruft und Integrationen belastbar überwacht.

Am Ende steht eine dokumentierte Beispielintegration mit Authentifizierung, Datenvalidierung, Fehlerbehandlung und kontrolliertem Dateiaustausch. Die Inhalte werden an einer isolierten Übungsinstanz oder an einem fachlich neutralen Beispielszenario erarbeitet.

Zielgruppe

Integrationsentwickler, technische Consultants, Solution-Architekten, DevOps-Teams und erfahrene Builder-Autoren.

Voraussetzungen

Builder-Grundkenntnisse, Verständnis relationaler Datenmodelle sowie Grundwissen zu HTTP, JSON, REST und Authentifizierung.

Inhaltsübersicht

1. 1. Schnittstellenvertrag und Datenmodell
2. 2. Bereitstellen von REI3-Endpunkten
3. 3. Authentifizierung und Autorisierung
4. 4. Externe REST-Aufrufe und Orchestrierung
5. 5. Dateiaustausch, Fehlerfälle und Betrieb
6. 6. Praxisfall und Qualitätskontrolle

1. Schnittstellenvertrag und Datenmodell

API-Ressourcen werden aus fachlichen Vorgängen abgeleitet und mit stabilen Ein- und Ausgabeformaten beschrieben. Im Mittelpunkt stehen Ressourcen, HTTP-Methoden, JSON-Strukturen, Versionierung. Als Arbeitsergebnis entsteht einen klaren Schnittstellenvertrag.

1. Schritt 1 – Analyse: API-Ressourcen werden aus fachlichen Vorgängen abgeleitet und mit stabilen Ein- und Ausgabeformaten beschrieben. Dazu werden Ressourcen und HTTP-Methoden anhand eines konkreten Geschäftsfalls abgegrenzt; Abhängigkeiten, Datenverantwortung und Sicherheitsbedarf werden festgehalten.
2. Schritt 2 – Umsetzung: HTTP-Methoden, JSON-Strukturen und Versionierung werden im Integrationsdesign angelegt, verbunden und mit konsistenten Bezeichnungen sowie nachvollziehbaren Standardwerten versehen.
3. Schritt 3 – Prüfung: Positive, negative und rollenbezogene Testfälle kontrollieren einen klaren Schnittstellenvertrag. Fehlermeldungen, Protokolle und unerwartete Seiteneffekte werden ausgewertet.
4. Schritt 4 – Absicherung: Namensregeln, Konfiguration, Testdaten und Rückfallweg werden dokumentiert. Das Ergebnis wird für Freigabe, Wiederverwendung oder den nächsten Ausbauschritt vorbereitet.

2. Bereitstellen von REI3-Endpunkten

Relationen, Queries und Berechtigungen werden zu kontrolliert nutzbaren REST-Endpunkten verbunden. Im Mittelpunkt stehen API-Editor, Basisrelation, Query-Spalten, Schreiboperationen. Als Arbeitsergebnis entsteht einen funktionsfähigen CRUD-Endpunkt.

1. Schritt 1 – Analyse: Relationen, Queries und Berechtigungen werden zu kontrolliert nutzbaren REST-Endpunkten verbunden. Dazu werden API-Editor und Basisrelation anhand eines konkreten Geschäftsfalls abgegrenzt; Abhängigkeiten, Datenverantwortung und Sicherheitsbedarf werden festgehalten.
2. Schritt 2 – Umsetzung: Basisrelation, Query-Spalten und Schreiboperationen werden im REI3 Builder angelegt, verbunden und mit konsistenten Bezeichnungen sowie nachvollziehbaren Standardwerten versehen.
3. Schritt 3 – Prüfung: Positive, negative und rollenbezogene Testfälle kontrollieren einen funktionsfähigen CRUD-Endpunkt. Fehlermeldungen, Protokolle und unerwartete Seiteneffekte werden ausgewertet.
4. Schritt 4 – Absicherung: Namensregeln, Konfiguration, Testdaten und Rückfallweg werden dokumentiert. Das Ergebnis wird für Freigabe, Wiederverwendung oder den nächsten Ausbauschritt vorbereitet.

3. Authentifizierung und Autorisierung

Technische Zugriffe werden auf notwendige Rollen und Datenbereiche begrenzt. Im Mittelpunkt stehen Zugangsdaten, Token, Rollenprüfung, Policy-Prüfung. Als Arbeitsergebnis entsteht einen abgesicherten Maschinenzugang.

1. Schritt 1 – Analyse: Technische Zugriffe werden auf notwendige Rollen und Datenbereiche begrenzt. Dazu werden Zugangsdaten und Token anhand eines konkreten Geschäftsfalls abgegrenzt; Abhängigkeiten, Datenverantwortung und Sicherheitsbedarf werden festgehalten.
2. Schritt 2 – Umsetzung: Token, Rollenprüfung und Policy-Prüfung werden im Administrations- und Builderbereich angelegt, verbunden und mit konsistenten Bezeichnungen sowie nachvollziehbaren Standardwerten versehen.
3. Schritt 3 – Prüfung: Positive, negative und rollenbezogene Testfälle kontrollieren einen abgesicherten Maschinenzugang. Fehlermeldungen, Protokolle und unerwartete Seiteneffekte werden ausgewertet.
4. Schritt 4 – Absicherung: Namensregeln, Konfiguration, Testdaten und Rückfallweg werden dokumentiert. Das Ergebnis wird für Freigabe, Wiederverwendung oder den nächsten Ausbauschritt vorbereitet.

4. Externe REST-Aufrufe und Orchestrierung

REI3 wird als REST-Client eingesetzt, um externe Dienste aus Frontend- oder Backend-Funktionen kontrolliert anzusprechen. Im Mittelpunkt stehen Request-Aufbau, Header, Antwortauswertung, Folgeaktionen. Als Arbeitsergebnis entsteht einen wiederverwendbaren Integrationsbaustein.

1. Schritt 1 – Analyse: REI3 wird als REST-Client eingesetzt, um externe Dienste aus Frontend- oder Backend-Funktionen kontrolliert anzusprechen. Dazu werden Request-Aufbau und Header anhand eines konkreten Geschäftsfalls abgegrenzt; Abhängigkeiten, Datenverantwortung und Sicherheitsbedarf werden festgehalten.
2. Schritt 2 – Umsetzung: Header, Antwortauswertung und Folgeaktionen werden in Backend- und Frontend-Funktionen angelegt, verbunden und mit konsistenten Bezeichnungen sowie nachvollziehbaren Standardwerten versehen.
3. Schritt 3 – Prüfung: Positive, negative und rollenbezogene Testfälle kontrollieren einen wiederverwendbaren Integrationsbaustein. Fehlermeldungen, Protokolle und unerwartete Seiteneffekte werden ausgewertet.
4. Schritt 4 – Absicherung: Namensregeln, Konfiguration, Testdaten und Rückfallweg werden dokumentiert. Das Ergebnis wird für Freigabe, Wiederverwendung oder den nächsten Ausbauschritt vorbereitet.

5. Dateiaustausch, Fehlerfälle und Betrieb

Dateien werden über definierte Import- und Exportpfade übertragen; Zeitüberschreitungen, Wiederholungen und unvollständige Antworten werden beherrscht. Im Mittelpunkt stehen Dateipfade, Upload und Download, Retry-Strategie, Integrationsprotokoll. Als Arbeitsergebnis entsteht eine betriebsfähige Schnittstellencheckliste.

1. Schritt 1 – Analyse: Dateien werden über definierte Import- und Exportpfade übertragen; Zeitüberschreitungen, Wiederholungen und unvollständige Antworten werden beherrscht. Dazu werden Dateipfade und Upload und Download anhand eines konkreten Geschäftsfalls abgegrenzt; Abhängigkeiten, Datenverantwortung und Sicherheitsbedarf werden festgehalten.
2. Schritt 2 – Umsetzung: Upload und Download, Retry-Strategie und Integrationsprotokoll werden in einer Übungsinstanz angelegt, verbunden und mit konsistenten Bezeichnungen sowie nachvollziehbaren Standardwerten versehen.
3. Schritt 3 – Prüfung: Positive, negative und rollenbezogene Testfälle kontrollieren eine betriebsfähige Schnittstellencheckliste. Fehlermeldungen, Protokolle und unerwartete Seiteneffekte werden ausgewertet.
4. Schritt 4 – Absicherung: Namensregeln, Konfiguration, Testdaten und Rückfallweg werden dokumentiert. Das Ergebnis wird für Freigabe, Wiederverwendung oder den nächsten Ausbauschritt vorbereitet.

6. Praxisfall und Qualitätskontrolle

Die Einzelschritte werden in einem zusammenhängenden Übungsfall verbunden. Konfigurationen werden nicht nur funktional, sondern auch hinsichtlich Berechtigungen, Fehlerverhalten, Wartbarkeit und dokumentierter Wiederholbarkeit geprüft.

• Einen Endpunkt für das Anlegen und Lesen von Vorgängen mit Rollenprüfung konfigurieren.
• Einen externen Beispieldienst aus einer Backend-Funktion aufrufen und Antwortdaten speichern.
• Fehlerhafte Nutzdaten, fehlende Berechtigung und nicht erreichbaren Zielservice reproduzieren und behandeln.

Arbeitsweise

Kurze fachliche Einordnungen wechseln mit Demonstrationen und geführten Konfigurationsschritten. Jeder Themenblock endet mit einer Kontrollaufgabe, einem Negativtest und einer dokumentierten Prüfliste.