How to get necessary general information via APIs

This is an overview of the most basic MQTT and REST calls that you will certainly need when working with the BlueRange platform.

API for MQTT Broker login

To login to MQTT you need to receive credentials from the server:

  • Clients acting on behalf of a user request credentials for the topics they want to subscribe to with POST /api/v1/iot/mqttSubscriptionCredentials. This also works for users whose MQTT Read is restricted to specific entities. See MQTT Credentials for User Clients.

  • Devices, Gateways and API-token clients receive organization-wide credentials from GET /api/v1/iot/mqtt, as do users with organization-wide MQTT Read.

See more in our MQTT API documentation.

Example:`https://iot.bluerange.io/api/v1/iot/mqtt`

Request organizationUuid

To get the organizationUuid use a GET request for the endpoint /gofer/security/rest/organizations with an authorized login.

Example: Login to the BlueRange platform and reach for https://iot.bluerange.io/gofer/security/rest/organizations

Request siteUuid

To get the siteUuid use a GET request for the endpoint /api/v1/iot/sites. You will receive a list of all sites in your authorized organization.

You get different parameters for the sites including uuid and name. Therefore, you are able to search for the required site by name.

Example: Login to the BlueRange platform and reach for https://iot.bluerange.io/api/v1/iot/sites

Request deviceUuid for a Mesh Node, Asset Tag, …​.

To get a specific deviceUuid use a GET request for the endpoint /api/v1/devices with authorized login.

You get different parameters including uuid and deviceId whereas deviceId represents the serial of a device. Therefore, you are able to search for the required device by serial.

Example: Login to the BlueRange platform and reach for https://iot.bluerange.io/api/v1/devices