Sure, you can handle it. But should you?
Let our experts manage the tech maintenance while you focus on your business.
Let our experts manage the tech maintenance while you focus on your business.
Interface Description
OpenAPI
Copyright ©
Mindbreeze GmbH, A-4020 Linz, 2024.
All rights reserved. All hardware and software names used are brand names and/or trademarks of their respective manufacturers.
These documents are strictly confidential. The submission and presentation of these documents does not confer any rights to our software, our services and service outcomes, or any other protected rights. The dissemination, publication, or reproduction hereof is prohibited.
For ease of readability, gender differentiation has been waived. Corresponding terms and definitions apply within the meaning and intent of the equal treatment principle for both sexes.
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".