API Guides

Die Guides zeigen Schritt für Schritt, wie Daten programmatisch über die ODI-API veröffentlicht werden. Jeder Guide enthält die Endpunkte, die Felder und lauffähige Beispiel-Requests für Produktion und Testsystem.

Zugriff einrichten

Einmalig je System, das Daten veröffentlichen soll:

Schritt	Guide	Wer
1. Service Account anlegen und Berechtigungen zuweisen	Programmatischen API-Zugriff einrichten	Administration
2. Mit Client ID und Client Secret ein Access-Token abrufen	API-Token abrufen	anzubindendes System

Daten veröffentlichen

Ziel	Guide
eine CSV-Datei erstmals als Datensatz veröffentlichen	Datensatz hochladen
die CSV-Datei eines bestehenden Datensatzes ersetzen	Datensatz aktualisieren
einer Zeitreihe einen neuen Datensatz hinzufügen, etwa den nächsten Jahrgang	Datensatzserie fortführen
einen bestehenden WFS- oder WMS-Dienst im Datenkatalog verzeichnen	WFS/WMS-Datensatz anlegen
PDF, JSON, ZIP oder andere Dateien als Distribution hochladen	Datei als Distribution hochladen

CSV-Dateien laufen über die Staging-API und werden dabei gegen ihr Schema geprüft. Alle anderen Formate und Dienste werden über den CKAN-Service direkt im Datenkatalog angelegt.

Nachschlagen

Thema	Seite
Kataloge, Lizenzen, Herausgeber, Kategorien und Raumbezüge mit ihren IDs	Metadaten
alle Endpunkte der ODI-Dienste	API Referenz
lauffähige Python-Skripte (Service Account anlegen, Token abrufen, Datensatz hochladen) und eine Beispiel-CSV	Beispiele im Repository
Konten und Freischaltung	Voraussetzungen