To create a custom dashboard using the Hydraloop Device Manager (HDM), follow these instructions to access and interact with our API. You’ll need an API key, which we will provide, to access specific devices and data.
Step 1: Request your API key #
If you haven’t received your API key yet, please contact us to request it. This key will grant access to a predefined list of devices and data.
Step 2: Swagger #
Once you have your API key, you can interact with our API through the Swagger interface. There are two Swagger sites available:
These URLs are:
- Root API: https://hdm.hydraloop.com/api-root/external-api/
- Local API: https://hdm.hydraloop.com/api-local/external-api/
Swagger will allow you to explore the API and test requests directly.
Step 3: Authorise with the API #
To start using the API, you need to authorize with your API key. Make sure to use the Production environment URL: https://hdm.hydraloop.com/ on both the Root and Local servers.
Step 4: Test API requests #
Once authorized, you can use Swagger to test API requests and pull data. Swagger will generate cURL commands that replicate the requests made to the server. These commands can be used in your own software or dashboard to fetch data directly from the Hydraloop system.
Step 5: Device-specific local servers #
The Local server URL can vary depending on the device you are accessing. When you query the Root API for coupled devices, the Local server URL for each device will be provided. Be sure to use the correct URL for each device to retrieve data.
Data compliance and regional servers #
We use different local servers to comply with regional laws and security requirements (e.g., GDPR in Europe). This approach ensures that device data is processed in accordance with local regulations, keeping data secure and compliant with regional laws.
Aditional notes: #
- Always use the Production servers when testing and interacting with the API.
- The Local server URL will be provided when you query for coupled devices.
- If you need any assistance or have questions while building your dashboard, feel free to reach out to our support team.