InGrid Editor Schnittstelle

Allgemeines¶

Die InGrid Editor Schnittstelle bietet API-Endpunkte zur maschinellen Verarbeitung von Metadaten. Sie ermöglicht den standardisierten Zugriff auf Datensätze über Schnittstellen wie OGC Records und CSW-T sowie weitere nützliche APIs zur Verarbeitung und Integration von Metadaten.

Eine flexible Authentifizierung erlaubt den gesicherten Zugriff auf editierte oder veröffentlichte Inhalte – ideal für automatisierte Workflows und den strukturierten Datenaustausch.

Eine ausführliche Dokumentation der Endpunkte ist über das Swagger-UI zu erreichen. Es dient als Hilfestellung für Testanfragen und gibt detailierte Auskunft über verfügbare Schnittstellen, Anfrage-Parameter und Pfad-Struktur.

• https://ige-ng.informationgrid.eu/swagger-ui/index.html

  Um einen API-Endpunkt über die Swagger-Benutzeroberfläche zu testen, müssen Sie den zuständigen Server auswählen (Dropdown-Menü "Server") und ein gültiges Bearer-Token eingeben (Schaltfläche "Authorise").

Leitfaden¶

Sie haben die Konfiguration bereits abgeschlossen? Diese Leitfaden könnten Sie interessieren.

Konfiguration¶

Um die Schnittstellen nutzen zu können, muss der InGrid Editor installiert sein. Achten Sie bei der Installation darauf, die entsprechenden Profile zu aktivieren, da die Schnittstellen andernfalls nicht zur Verfügung stehen.

Die Aktivierung erfolgt über die Startparameter, z. B.:

-Dspring.profiles.active=ogc-api,ogc-distributions-api,csw-t

Folgende Profile stehen zur Verfügung und können je nach Bedarf aktiviert werden:

Authentifizierung¶

Alle APIs sind mit OAuth 2.0 über Keycloak gesichert. Um mit Endpunkten zu interagieren, muss zunächst ein Bearer-Token erstellt werden und in der Anfrage mit übergeben werden.

Überblick über die erforderlichen Variablen und Berechtigungsnachweise:

NOTE: Zugangstokens sind 1 Minute lang gültig. Nach Ablauf der Gültigkeitsdauer muss das Token mit einem Refresh-Token aufgefrischt werden.

Token anfragen¶

In diesem Abschnitt wird beschrieben, wie Sie Zugangstoken und Refresh-Token via cURL erhalten können.

Ersetzen Sie folgende Variable und führen Sie cURL aus: $KEYCLOAK_HOST, $REALM, $USERNAME, $PASSWORD, $CLIENTID, $CLIENTSECRET

curl -X POST
    $KEYCLOAK_HOST/realms/$REALM/protocol/openid-connect/token
    -H 'Content-Type: application/x-www-form-urlencoded'
    -d username=$USERNAME
    -d password=$PASSWORD
    -d grant_type=password
    -d client_id=$CLIENTID
    -d client_secret=$CLIENTSECRET

Die Antwort ist ein JSON-Objekt, das unter anderem Access-Token und Refresh-Token enthält. Beispiel einer Antwort:

{
    "access_token": "eyJhbGciOiJSUzI1NiIsInZGMZvcm1hdGlvbmdyaWQuZXUvcmVhbG1zL3JpZCIs...",
    "expires_in": 60,
    "refresh_expires_in": 1800,
    "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6I...",
    "token_type": "Bearer",
    "not-before-policy": 1632732926,
    "session_state": "1afef5ee-272c-4c4a-a181-3da38b432bac",
    "scope": "email profile"
}

Token anwenden¶

Sobald Sie einen gültigen access_token erhalten haben, können Sie die Schnittstellen aufrufen. Dazu müssen Sie den access_token als Bearer-Token in den Header beifügen.

--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInZGMZvcm1hdGlvbmdyaWQuZXUvcmVhbG1zL3JpZCIs...'

FAQ¶