Domotz Pro User Guide QR code Print

5.5.2. API Keys

The Domotz Pro Public API (RESTful) provides developers with an easy and comprehensive way to integrate third party applications.


An application programming interface key (API Key) is the code required in your own application to execute RESTful API calls against the Domotz Cloud, allowing you to retrieve and manage your own account and your Domotz Agents.


You will need at least one API Key to access to your data through the Domotz Pro Public API.

  

To create API Key you need to visit the Portal, under Settings section select the API Key tab: click on create a API Key, fill the passward of your account to unclock the service, give a name to a new API Key. 

Now new API key is created! You can see its code and Endpoint.

Don't forget to copy the API Key code and save it in a safe place, clicking on Copy. Please, note that after closing the popup you will not be able to do see the key anymore.

You will see the created API key and control the number of calls made duiring the last 24 hours. The total number of API calls which can be executed in 24 hours is a function on the number of configured Agents on the Advanced plan (or higher). For more details, visit the Portal under Account and API Key section.

 

You can create multiple API keys if you need to.

The API Key can be used to retrieve general information about all the configured Agents. However, details of the Agents, list of devices and other Agent related information are only available through the Public API on Agents configured on an Advanced plan (or higher).  

 

Please refer to the Domotz PRO Public API documentation for additional information on their usage: https://portal.domotz.com/developers/

 
powered by tomehost