barscaret-downcaret-leftcaret-rightcaret-upcheckchevron-leftchevron-rightfile-pdfinfosign-in-altsignin text-widthtimesyoutube

API & Integrations > API

Miradore API

Updated on January 31st, 2023

Miradore API (Application Programming Interface) is a REST-based web service that is intended for integrating Miradore with external information systems. It is used over HTTPS with the GET method to export data directly from the database of Miradore in XML or JSON format.

API stands for an application programming interface where two or more computer programs communicate with one another. It's a software interface, which offers a service to other software. They enable companies to open up their applications' data and functionality to external third-party developers, and business partners along with their own internal departments. There are three categories of API protocols or architectures: REST, RPC and SOAP.

Please note that the API is not available in the Free plan. See Plans and pricing for more information.

Getting started

Read step-by-step instructions on how to start using the API from Getting started with API.

Authentication keys

All API requests are authenticated with an authentication key, and the authentication keys are managed in the management console of each Miradore site. The tasks related to the management of the API authentication keys are explained in Adding API keys and Deleting API keys.

Guides for APIs

APIs are aimed at different use cases. Use the API you find more suitable for your needs.

Learn more about API v2 CRUD operations.
Learn more about API v1 advanced queries.

Please do not hesitate to contact our support if you have any questions or development suggestions.

The difference between API v1 and v2

The difference between the two is the way that the content is structured. V1 tends to be more complex while V2 is simplified. API V2 also provides default fields to the ones left empty. The V2 API is a modernized self-documenting API interface. It makes establishing new integrations easier for developers. It provides default empty values for fields that are left empty in API v1. Which one of these you should use depends on your individual needs. Please see Programmer’s guide to API v1 and Miradore API v2 articles on our Knowledge Base for further information.

  • This field is for validation purposes and should be left unchanged.

Previous Article:

Next Article: