External Systems Integration Made Easy with Miradore APIs

Integrating Miradore with your external information systems is a breeze with Miradore API (Application Programming Interface), a REST-based web service built for enabling integration. API acts as a gateway, allowing companies to share their applications’ data and functionality with external groups like third-party developers and business partners, as well as with their own internal departments. It is used over HTTPS with the GET method to export data directly from the database of Miradore in XML or JSON format.

Depending on the needs of your organization, you can choose between two versions of API v1 and API v2 — that we offer on paid plans. The difference between the two is the way that the content is structured: V1 tends to be more complex while V2 is a self-documenting interface that simplifies integration by offering default empty values for fields left blank in V1. Learn more about the two versions here:

Programmer’s guide to API v1 

Miradore API v2 

What our customers use the Miradore APIs for

• • To display the current number of devices in a site. Some customers even have this number as a widget on their iOS home screen
  • To display the number of located devices
  • To display a user's data consumption over a given period of time
  • User creation (import from Azure Active Directory)
  • To display data in third-party systems
  • To lock loaned devices (Lost mode) after no-return

Here’s a more concrete example of how to use the API

API stands for Application Programming Interface – but you don’t necessarily have to know how to code. Current versions of Excel can easily retrieve data from Miradore. This can be done like so:

1. 1. Create an API Key in your Miradore Site
   2. The URL can be created from the Sitename + API Key: https://online.miradore.com/‘+sitename+‘/API/Device?auth='+apiKey-> You can also open it in your browser and view an XML file
   3. Add which data you want to see. e.g. all managed users with their Online Status (without Other)&select=User.Name,OnlineStatus&filters=Platform ne Other AND Status ne Deleted

You will get the following URL – in our example for the site “leadit”. The entries in bold must be set individually for your site.

“https://online.miradore.com/leadit/API/Device?auth=XXXXXXX=User.Name,OnlineStatus&filters=Platform ne Other AND Status ne Deleted”

Open Excel. Select Data -> From the Web, paste the URL and confirm with "OK".

Select your data source and click Transform data. The following window will open. Click on the text "Table" in line 1. It is important that you click on the word "Table" instead of in the cell. The mouse cursor changes to a hand icon when it is in the right place.

Click again on the text "Table" to display the data. It is important to click on the word "Table" instead of inside the cell. The mouse cursor changes to a hand icon when it is in the right place.

Now you can see the online status.

Use the double arrow in the header to display the names.

Select “Load more” and confirm with “OK”.

Select “Close & Load” in the upper left corner and the data is available in Excel. The advantage over an export is that the data can be retrieved over and over again via the “Update Data” button.

You can find more information out our APIs by exploring our knowledge base.

by Andreas Handler

Andreas works as a Senior Technical Consultant and Customer Success Manager at Miradore. He has been part of the Miradore family since 2016 and is passionate about providing value to organizations by showing them how to increase efficiency with Mobile Device Management. Outside of work, you might find him bouldering or playing volleyball.