Seminar windream – Web-Service-Programmierschnittstellen

Der windream Web Service ermöglicht plattformübergreifende Integration über REST und JSON. Das Seminar baut einen robusten API-Client auf, der Authentifizierung, Fehlercodes, große Datenmengen, Wiederholungen und Berechtigungen zuverlässig behandelt.

Inhaltsübersicht

• Zielsetzung
• Zielgruppe
• Voraussetzungen
• Seminarinhalte
• Praxisübungen
• Methodik

Zielsetzung

• REST-Endpunkte, HTTP-Verhalten und JSON-Strukturen sicher verwenden
• Dokumente und Metadaten speichern, abrufen und suchen
• Fehler, Paging, Zeitüberschreitungen und Wiederholungen robust behandeln
• Sicherheit, Tests und produktive Clientarchitektur umsetzen

Zielgruppe

Softwareentwicklung, Webentwicklung, Integrationsentwicklung und technische windream-Beratung.

Voraussetzungen

Programmiererfahrung, vorzugsweise C# und JavaScript, sowie Grundlagen in HTTP, HTTPS, REST und JSON. windream-Fachadministration wird vorausgesetzt. Das Web Service SDK muss verfügbar sein.

Seminarinhalte

Tag 1: Web-Service-Grundlagen und Dokumentzugriff

1. Schritt 1: Web-Service-Architektur, Endpunkte, Versionen und Abhängigkeiten einordnen.
2. Schritt 2: HTTP-Methoden, Header, Statuscodes, Inhaltsarten und HTTPS-Verhalten praktisch prüfen.
3. Schritt 3: Authentifizierung, Session und Berechtigungskontext sicher implementieren.
4. Schritt 4: Dokumente hochladen, abrufen und mit Metadaten versehen.
5. Schritt 5: JSON-Nutzdaten validieren und Feldtypen konsistent abbilden.
6. Schritt 6: Kleinen API-Client mit zentraler Fehler- und Protokollschicht erstellen.

Tag 2: Suche, Robustheit, Sicherheit und Tests

1. Schritt 1: Strukturierte Suchen formulieren und Ergebnisse mit Paging verarbeiten.
2. Schritt 2: Große Dokumente, Streaming, Zeitüberschreitungen und Abbrüche berücksichtigen.
3. Schritt 3: Fehlerkörper, transiente Fehler, Wiederholungen und Idempotenz behandeln.
4. Schritt 4: Eingaben validieren, Geheimnisse schützen und Rechte serverseitig respektieren.
5. Schritt 5: API-Mocks, Integrationstests und reproduzierbare Testdaten aufbauen.
6. Schritt 6: Clientbibliothek paketieren, versionieren und mit Betriebsparametern bereitstellen.

Praxisübungen

• Authentifizierung und Basiskommunikation mit dem Web Service implementieren
• Dokument mit Metadaten speichern und wieder abrufen
• Suche mit Paging und kontrollierter Ergebnisverarbeitung entwickeln
• Fehler- und Wiederholungsstrategie mit automatisierten Tests umsetzen

Methodik

Der API-Client wird schrittweise aufgebaut: Transport, Authentifizierung, Datenmodell, Funktionen, Fehlerbehandlung und Tests. Dadurch bleibt klar, auf welcher Schicht ein Fehler entsteht und wie er reproduzierbar geprüft wird.