Skip to content

Architecture

The MiaRec REST API is the single point of entry to the resources of the MiaRec platform. A client application sends HTTP requests to the MiaRec web server to retrieve resources (for example, calls or users) and to create, update, or delete them (for example, create a user, set a custom field of a call). The web server answers with data in JSON format.

Architecture

The API is served by the same web server as the web portal, under the /api/v2/ path. It uses the same user accounts, roles, and permissions as the web portal, so an integration sees exactly what its user is allowed to see.

Example of request:

GET https://miarec.example.com/api/v2/users/546340bf-7b47-11e4-85a4-e03f497dbdff.json

Example of response:

{
  "user": {
    "user_id": "546340bf-7b47-11e4-85a4-e03f497dbdff",
    "name": "John Smith",
    "groups": ["256740bf-7b47-11e4-85a4-e03f497dbd33"],
    ...
  }
}

Deployment models

MiaRec is available as a hosted service and as software deployed on premises or in a customer's cloud. The API is the same in both cases; only the base URL differs:

  • Hosted platform: https://app.miarec.com/api/v2/
  • Your own deployment: https://{your-miarec-server}/api/v2/

In a multi-tenant deployment, an API user of the System tenant can manage all tenants, whereas an API user of a customer tenant sees the resources of that tenant only.