Getting Started¶
Dieser Bereich führt in die Nutzung der Open Data Infrastruktur (ODI) ein: welche Zugänge nötig sind, wie Berechtigungen eingerichtet werden und wie sich die Plattform lokal betreiben lässt.
Voraussetzungen¶
Das Lesen und Validieren von Datensätzen ist ohne Benutzerkonto möglich. Für das Hochladen und Aktualisieren von Daten wird ein Benutzerkonto mit den entsprechenden Berechtigungen benötigt.
Der Zugang ist auf eingeladene Nutzerinnen und Nutzer beschränkt. Produktion und Testsystem sind getrennt; ein Konto der Testumgebung gilt nicht in der Produktion.
| Schema-Repository und Upload | Keycloak | |
|---|---|---|
| Produktion | schema.odi.schleswig-holstein.de | keycloak.odi.schleswig-holstein.de |
| Test | schema-repo-frontend.odi-stage.schleswig-holstein.de | keycloak.odi-stage.schleswig-holstein.de |
Lokale Entwicklungsumgebung
Die gesamte ODI-Infrastruktur lässt sich auch lokal betreiben – ganz ohne Einladung. Wie das geht, steht auf der Seite Lokale Umgebung aufsetzen.
Benutzerkonto¶
Mit einem bestehenden Benutzerkonto eines der folgenden Bundesländer ist eine direkte Anmeldung möglich:
- Schleswig-Holstein
- Hamburg
- Bremen
- Mecklenburg-Vorpommern
- Sachsen-Anhalt
Wer über keines dieser Länderkonten verfügt, erhält ein individuelles Konto. Die Zugangsdaten werden nach dem Anlegen bereitgestellt.
Zusätzliche Berechtigung erforderlich
Die erfolgreiche Anmeldung allein reicht noch nicht aus, um Daten zu veröffentlichen. Zusätzlich ist eine Freischaltung für den jeweiligen Herausgeber (Publisher) erforderlich. Sobald die Berechtigung eingerichtet ist, erfolgt eine entsprechende Benachrichtigung.
Die Freischaltung nimmt die Administration der ODI in Keycloak vor. Die Schritte dazu stehen unter Autorisierung und Benutzer anlegen und CKAN-Token zuweisen.
Zugang zur API¶
Für die programmatische Nutzung der ODI-API wird eines der folgenden Zugangsmodelle benötigt:
- Ein eigenes Benutzerkonto mit den entsprechenden Berechtigungen
- Zugangsdaten zu einem Service Account
Die Einrichtung eines Service Accounts wird im Guide Programmatischen API-Zugriff einrichten beschrieben.
Einstieg nach Rolle¶
| Rolle | Ziel | Seite |
|---|---|---|
| Daten veröffentlichen | Daten per Skript oder aus einem Fachsystem veröffentlichen | API Guides |
| Zugänge verwalten | eine Gruppe für einen Herausgeber anlegen und Tokens hinterlegen | Autorisierung |
| einer Person Schreibrechte im Datenkatalog geben | Benutzer anlegen und CKAN-Token zuweisen | |
| ein Skript oder Fremdsystem anbinden | Programmatischen API-Zugriff einrichten | |
| Plattform betreiben | die ODI lokal starten | Lokale Umgebung aufsetzen |
| verstehen, wie Stage und Produktion aufgebaut sind und ausgerollt werden | DevOps & Betrieb | |
| die Architektur der ODI kennenlernen | Zielarchitektur |