Zum Hauptinhalt springen
Version: In Entwicklung
UDSP · Schnittstellen

Daten über definierte Schnittstellen nutzen

Dieser Bereich zeigt, welche APIs die UDSP bereitstellt, wie der Zugriff abgesichert ist und welcher Integrationsweg für Kontext-, Sensor-, Geo-, Katalog- oder Objektdaten vorgesehen ist.
Zentraler Zugriffspfad

So erreicht ein Client die geschützten Fach-APIs

Authentifizierung und API-Aufruf sind zwei getrennte Schritte. Keycloak stellt das Token aus; APISIX prüft es und leitet die Anfrage an den zuständigen Fachdienst.

Client

Anwendung, Skript oder Integrationsdienst

Keycloak

Token beziehen

Realm, Identität, Rollen, Scopes und Datenräume

APISIX

API aufrufen

Tokenprüfung, Route, Methode und Weiterleitung

Fachdienst

Stellio, FROST, GeoServer oder Geo-Konfigurationsdienst

Nicht über diesen Gateway-Pfad
  • CKAN Action API
  • MinIO S3 API
  • JSON-LD Context Hoster
Öffentliche Fachschnittstellen

Den Zugang nach Datenart auswählen

Die Schnittstellen sind keine austauschbaren Ansichten auf denselben Bestand. Jede besitzt ein eigenes Datenmodell und eine fachlich führende Komponente.

Kontextdaten
Stellio Context Broker

NGSI-LD

Aktuelle Zustände, Beziehungen, Batch-Operationen und Subscriptions.

Zugang
/stellio/api/ngsi-ld/v1/
Schutz
OAuth 2.0, Scopes und Datenraum
Schnittstelle öffnen
Sensor- und IoT-Daten
FROST-Server

SensorThings API

Things, Datastreams, Observations und zeitlich geordnete Messwerte.

Zugang
/frost-http/v1.1/
Schutz
OAuth 2.0; HTTP und WebSocket
Schnittstelle öffnen
Geodaten
GeoServer

OGC-Dienste

WMS, WFS, WCS und weitere konfigurierte GeoServer-Zugänge.

Zugang
/geoserver/
Schutz
OAuth 2.0 oder freigegebener Open-Data-Pfad
Schnittstelle öffnen
Metadaten und Datenangebote
CKAN

CKAN Action API

Datensätze, Ressourcen, Organisationen und DataStore-Abfragen.

Zugang
https://ckan.<DOMAIN>/api/3/action/
Schutz
CKAN-Berechtigungen und API-Token
Schnittstelle öffnen

Was in diesem Bereich dokumentiert wird​

Als öffentliche Fachschnittstelle gilt hier ein stabiler, für externe Anwendungen vorgesehener Zugang zu Plattformdaten. Dazu gehören die geschützten APISIX-Routen für Stellio, FROST und GeoServer sowie die eigenständige CKAN Action API.

Daneben existieren weitere Integrationswege wie die MinIO S3 API, der JSON-LD Context Hoster und projektspezifische Node-RED-Endpunkte. Sie werden unter Weitere Integrationswege eingeordnet. WebSocket und MQTT als alternative SensorThings-Transporte werden direkt bei der SensorThings API erklärt.

Interne Verbindungen zwischen Plattformkomponenten – beispielsweise PostgreSQL, Kafka, Redis, Solr oder etcd – sind keine öffentlichen UDSP-Schnittstellen. Ihre technische Rolle wird auf den jeweiligen Komponentenseiten beschrieben.

Konfiguration bestimmt die tatsächlich verfügbaren Endpunkte​

Nicht jeder Mandant stellt jede Schnittstelle bereit. Maßgeblich sind:

  • die im Inventory aktivierten Komponenten,
  • die für den Mandanten erzeugten DNS-Namen,
  • die von APISIX installierten Routen,
  • die in Keycloak vergebenen Rollen, Scopes und Datenräume sowie
  • zusätzliche Freigaben wie ein öffentliches GeoServer-Workspace oder ein CKAN-Datensatz.

Die in dieser Dokumentation verwendeten URLs sind deshalb Muster. Ersetzen Sie <DOMAIN>, <REALM>, Datenraum, Workspace und Ressourcenkennungen durch die Werte der konkreten Plattformumgebung.