Miradore API v2

Miradore API (Application Programming Interface) v2 is an HTTPS REST-based interface for integrating Miradore with other applications. API v2 provides access to resources via URL and it is suitable for CRUD (create, read, update and delete) operations in Miradore.

Authentication

Miradore API v2 uses the authentication key which is sent to the server in the request’s HTTP header X-API-Key.

The authentication key is a random string that can be generated from Miradore web console > System > Infrastructure diagram when the API feature is activated. Please read more about creating an authentication key from the article Getting started with API. See additional instructions about managing authentication keys from Adding API keys and Deleting API keys.

Supported items and methods

The Miradore API v2 is used by sending HTTPS requests to the Miradore server. The API uses standard HTTPS methods GET, PUT, POST, and DELETE. The response format is JSON.

The URL for API v2 calls:

• Include <sitename> in the new URL as a subdirectory.
  • https://online.miradore.com/<sitename>/api/v2/<item>
• Include <sitename> in the HTTP header.
  • https://online.miradore.com (without <sitename>) provide <sitename> in the X-Instance-Name header.

The technical documentation of Miradore API v2, information about supported items and methods, can be found in the Swagger documentation together with some examples. The documentation is available at: https://online.miradore.com/swagger/index.html. You can specify the site name in the X-Instance-Name parameter.

It is possible to try out available API v2 operations with the Swagger tool. In the tool, there is an Authorize button to authorize a session with the authentication key received from Miradore.

Example 1: Locking a device

• The device id and the Site name are required parameters. (Device ID can be also retrieved using Miradore API v1. This is explained in the programmer’s guide of API v1.)

Option 1:

POST https://online.miradore.com/mysitename/api/v2/Device/{id}/Lock

Option 2:

curl -X POST -H "X-Instance-Name: mysitename" https://online.miradore.com/api/v2/Device/{id}/Lock

Example 2: Get the device’s locations from a certain time range

• The device id and Site name are required parameters.
• There are some optional parameters, like startDate and endDate (year-month-day), if you want to define the time range for the results.

Option 1:

GET https://online.miradore.com/mysitename/api/v2/Device/{id}/Location

Option 2:

curl -X GET  https://online.miradore.com/api/v2/Device/{id}/Lock  -H "X-Instance-Name: mysitename"