Interface Description
OpenAPI

OpenAPI specification

An OpenAPI specification for supplied APIs, such as the RAG API, is available in the Mindbreeze Management Center under <MMC URL>/api-docs/.

List of OpenAPI specifications

A list of available OpenAPI specifications can be accessed in the Mindbreeze Management Center under <MMC URL>/api-docs/.

A specification can be selected and then viewed or downloaded.

These specifications can be imported into developer tools, such as Postman or Swagger-UI and used to programmatically execute API requests.

api.v2 Proxy

To use the api.v2 proxy the user needs the configured role from the RAG Service („Required Impersonation Role“) as well as the „InSpire Service Gateway User” role. In the RAG Service there must also be the „Allow api.v2 Impersonating Proxy“ setting enabled (Advanced Settings must be activated).

The Client Service must have “Trusted Peer Cert” configured as authentication.

It is possible to reach all endpoints via the api.v2 proxy. A possible Search Request can look like this:

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

Authentication

To access the OpenAPI specifications, you must log in with a user with the role "InSpire Service Gateway User".