Seminar Magda API, API-Schlüssel, Automatisierung und mgd CLI

Das Seminar erschließt den programmatischen Zugriff auf Magda. Behandelt werden API-Grundlagen, Authentisierung mit API-Schlüsseln, Registry- und Suchoperationen, robuste Automatisierung sowie der Einsatz der Kommandozeile mgd für Recherche, Download und Pflege von Katalogeinträgen.

Inhaltsübersicht

1. API-Landschaft und Zugriffspfade
2. API-Schlüssel sicher verwenden
3. Registry-Operationen automatisieren
4. Suche und Datenabruf
5. mgd CLI im Arbeitsablauf
6. Robuste Automatisierung
7. Praxisübungen und Voraussetzungen

Zielgruppe

Softwareentwicklung, Datenengineering, DevOps, technische Administration und Integrationsarchitektur.

Lernziele

• Magda-APIs strukturiert erkunden und sicher aufrufen.
• API-Schlüssel korrekt einsetzen, rotieren und entziehen.
• Datensätze und Metadaten per Skript lesen, erzeugen und aktualisieren.
• mgd für wiederholbare Katalogaufgaben einsetzen.
• Automatisierungen mit Fehlerbehandlung, Protokollierung und Wiederanlauf ausstatten.

Seminarinhalte

1. API-Landschaft und Zugriffspfade

1. Schritt 1: Gateway, Registry, Suche und weitere API-Bereiche voneinander abgrenzen.
2. Schritt 2: Geeignete Endpunkte für Lese-, Schreib- und Administrationsaufgaben auswählen.
3. Schritt 3: Anfragen mit Headern, Parametern und JSON-Nutzdaten reproduzierbar formulieren.

2. API-Schlüssel sicher verwenden

1. Schritt 1: Einen zweckgebundenen technischen Benutzer vorbereiten.
2. Schritt 2: API-Schlüssel erzeugen und die erforderlichen Kennungen sicher übergeben.
3. Schritt 3: Fehlende Rechte, abgelaufene Schlüssel und ungültige Header diagnostizieren.

3. Registry-Operationen automatisieren

1. Schritt 1: Records und Aspects über die API abfragen.
2. Schritt 2: Neue Metadatenobjekte mit validen Aspects anlegen.
3. Schritt 3: Änderungen idempotent durchführen und Versionskonflikte behandeln.

4. Suche und Datenabruf

1. Schritt 1: Suchabfragen mit Filtern und Sortierung aufbauen.
2. Schritt 2: Trefferlisten paginieren und für Folgeprozesse aufbereiten.
3. Schritt 3: Distributionen auswählen und Downloads kontrolliert ausführen.

5. mgd CLI im Arbeitsablauf

1. Schritt 1: Katalogverbindung und Anmeldedaten konfigurieren.
2. Schritt 2: Datensätze suchen, anzeigen, herunterladen und bearbeiten.
3. Schritt 3: Wiederkehrende Befehle in Skripte und agentengestützte Arbeitsabläufe integrieren.

6. Robuste Automatisierung

1. Schritt 1: Protokollierung, Zeitüberschreitungen und Wiederholungslogik ergänzen.
2. Schritt 2: Transaktionen durch Prüfschritte und Rücksetzstrategien absichern.
3. Schritt 3: Eine automatisierte Qualitäts- und Bestandsprüfung planen.

Praxisübungen

• Erstellung eines Skripts zum Inventarisieren ausgewählter Datensätze.
• Automatisiertes Anlegen und Aktualisieren eines Katalogeintrags.
• CLI-gestützter Download mit Filterung und Protokollierung.
• Fehlerbehandlung für fehlende Berechtigungen und unvollständige Metadaten.

Voraussetzungen

Sicherer Umgang mit HTTP, JSON und einer Skriptsprache. Grundkenntnisse in Magda sind hilfreich, aber nicht zwingend.