How to make API requests to the cloud-connected system through the internet?
- Test the request locally:
-
- Check the documentation, find the request you need, make a request and test it using the local system IP address. For example: http://127.0.0.1:7001/api/createEvent?source=Cloud&caption=Test
- Find cloud system Id
-
- There are two ways to do that:
- Open the system on a cloud portal and check the URL. For example: https://dwspectrum.digital-watchdog.com/397f56fb-4c5c-485e-a923-9bea345fa7ba, 397f56fb-4c5c-485e-a923-9bea345fa7ba is the id you need
- Alternative: Make a request /api/moduleInformation (For example: http://127.0.0.1:7001/api/moduleInformation) and find cloudSystemId in the reply
- Format Cloud URL
-
- In your original request replace local IP and port with https://{systemId}.relay.vmsproxy.com
For example, http://127.0.0.1:7001/api/createEvent?source=Cloud&caption=Test turns into https://397f56fb-4c5c-485e-a923-9bea345fa7ba.relay.vmsproxy.com
... http://127.0.0.1:7001/api/createEvent?source=Cloud&caption=Test turns into https://397f56fb-4c5c-485e-a923-9bea345fa7ba.relay.vmsproxy.com/api/createEvent?source=Cloud&caption=Test
Known issues and limitations:
1. This functionality is in beta mode and we might change something in the future, so please keep an eye for updates.
2. This way supports only https protocol
3. This way doesn’t support browser-based requests due to CORS protection
