Seminar DKAN API Entwicklung und Integration

Die Schulung vermittelt die technische Integration von DKAN über API-Endpunkte und automatisierte Abläufe. Der Schwerpunkt liegt auf sauberer Datenübertragung, robusten Abfragen, Fehlerbehandlung, Authentifizierungskonzepten und reproduzierbaren Integrationsmustern.

Inhaltsübersicht

• API-Landschaft eines DKAN-Portals verstehen
• Metadaten über strukturierte JSON-Nachrichten verarbeiten
• Datastore-Abfragen planen, filtern und testen
• Automatisierte Erstellung und Aktualisierung von Datensätzen vorbereiten
• Fehlerbehandlung, Protokollierung und Wiederholbarkeit berücksichtigen
• Integrationsentwurf für Fachverfahren und externe Portale erstellen

Seminarinhalte

Modul 1: API-Struktur analysieren

1. Verfügbare Endpunkte nach Metadaten, Datastore und Verwaltung unterscheiden.
2. Datenobjekte, Ressourcen, Distributionen und Schemafelder fachlich zuordnen.
3. Antwortstrukturen lesen und für eigene Clients dokumentieren.
4. Grenzen zwischen manueller Redaktion und maschineller Pflege festlegen.

Modul 2: Metadaten programmatisch verarbeiten

1. JSON-Strukturen für Datensätze vorbereiten.
2. Pflichtfelder, optionale Felder und kontrollierte Werte prüfen.
3. Erstellungs- und Aktualisierungsabläufe als wiederholbare Schritte entwerfen.
4. Validierungsfehler auswerten und in verständliche Rückmeldungen übersetzen.

Modul 3: Datastore-Abfragen entwerfen

1. Tabellarische Ressourcen identifizieren und Abfragefähigkeit prüfen.
2. Filter, Sortierung, Feldbegrenzung und Paging sinnvoll einsetzen.
3. Abfragen auf Antwortzeit, Datenmenge und fachliche Genauigkeit testen.
4. Ergebnisdaten für Dashboards, Fachanwendungen oder Exporte aufbereiten.

Modul 4: Integration absichern

1. Authentifizierungs- und Berechtigungskonzepte für technische Konten planen.
2. Fehlerfälle, Timeouts, Wiederholversuche und Idempotenz berücksichtigen.
3. Schnittstellenprotokolle und technische Betriebsdokumentation erstellen.
4. Testdaten, Testfälle und Abnahmekriterien für API-Integrationen definieren.

Modul 5: Automatisierung umsetzen

1. Import- und Aktualisierungsläufe in einzelne Verarbeitungsschritte zerlegen.
2. Vorprüfung, Übertragung, Validierung und Nachkontrolle trennen.
3. Protokolle für erfolgreiche und fehlerhafte Läufe erzeugen.
4. Einen Integrationsfahrplan für produktive Datenlieferungen formulieren.

Praxisübungen

• Beispielhafte JSON-Nutzdaten für Datensätze erstellen
• Datastore-Abfragen mit Filtern und Paging ausarbeiten
• Integrationscheckliste für ein Fachverfahren erstellen