API Explorer

Every MiaRec web server publishes an interactive API Explorer (Swagger UI) together with the OpenAPI specification of the REST API. Use it to browse all endpoints, their parameters, request and response schemas, and to send test requests from the browser.

The explorer is served at the /api/v2 path of the web portal:

Resource	URL
API Explorer	https://{your-miarec-server}/api/v2
OpenAPI specification	https://{your-miarec-server}/api/v2/miarec-api-v2.yaml

For the MiaRec hosted platform, the explorer is available at https://app.miarec.com/api/v2.

Note

MiaRec can be deployed by customers and service providers in their own environments. In that case, replace app.miarec.com with the address of your MiaRec web portal. The path /api/v2 stays the same.

The OpenAPI specification describes the version of the API that is installed on that server. When this guide and the specification differ, the specification reflects the behavior of your server.

To send requests from the explorer, click Authorize and enter the login and password of an API user. The same security rules apply as for any other client.

Enabling the explorer

The explorer is controlled by the REST API explorer flag in Administration › System › Advanced Settings (see Advanced settings). When the flag is disabled, the /api/v2 page returns 404 Not Found. The API endpoints themselves keep working.