Schnittstellenbeschreibung
OpenAPI

OpenAPI Spezifikation

Eine OpenAPI-Spezifikation für mitgelieferte APIs, wie z.B. die RAG API, ist im Mindbreeze Management Center unter <MMC URL>/api-docs/ verfügbar.

Auflistung der OpenAPI-Spezifikationen

Im Mindbreeze Management Center kann unter <MMC URL>/api-docs/ auf eine Liste mit verfügbaren OpenAPI-Spezifikationen zugegriffen werden.

Dabei kann eine Spezifikation ausgewählt und dann angesehen beziehungsweise heruntergeladen werden.

Diese Spezifikationen können in Entwicklertools, wie Postman oder Swagger-UI importiert oder verwendet werden, um programmatisch API-Anfragen auszuführen.

api.v2 Proxy

Um den api.v2 Proxy zu nutzen, braucht der Nutzer sowohl die konfigurierte Rolle aus dem RAG Service („Required Impersonation Role“) als auch die Rolle „InSpire Service Gateway User”. Im RAG Service muss auch die Einstellung „Allow api.v2 Impersonating Proxy“ aktiviert sein („Advanced Settings“ müssen dafür aktiviert sein).

Der Client Service muss dabei “Trusted Peer Cert” als Authentifizierung konfiguriert haben.

Es ist möglich, alle Endpoints mit dem api.v2 Proxy zu erreichen. Ein möglicher Search Request könnte dann beispielsweise so aussehen:

curl -X POST
-d ‘{"query": {"unparsed": "ALL"}}’ \
-H "Content-Type: application/json" \
-H "X-Username: Test Impersonation User" \
-H "Authorization: Bearer {token}" \
-H "x-requested-with: XMLHttpRequest" \
https://{host}:8443/realm/master/api/service/{rag_service_id}/api/mindbreeze.client.api/{client_service_id}/api/v2/search

Authentisierung

Um auf die OpenAPI Spezifikationen zugreifen zu können, muss man sich mit einem Nutzer mit der Rolle „InSpire Service Gateway User“ anmelden.