APIs

Accessing data via an API is possible if the service gives you the authorization. In this chapter, you will learn how to

• create the api key and define the access rights of a user group
• use the APIKey to authenticate user

Access to APIs is subject to authentication and authorisation.

APIs access rights are defined by creating a user group and defining the access right per API. In the account manager, user groups, create a group and define all apis access rights.

BasicAuth authentication requires an application key and an application secret called api Keys. In the account manager, settings, global, there is an entry “API Keys”, Click on the “Add ApiKey” button, select the user group to belong to and save. Copy the generated APi Key.


This use case shows you the APIs you can use to obtain a list of all the assets in your account, obtain the details of an asset based on its identifier and retrieve data from connected devices.

List all assets for the currently logged-in user.

GET ASSETS https://report.iotfactory.eu/api/assets?fields=_id&fields=name

Request headers

Basic authentication involves sending a verified username and password with your request In the request Headers, the Authorization header passes the API a Base64 encoded string representing your username and password values, appended to the text Basic as follows:

Basic <Base64 encoded username and password>

URL Variables

Get one asset by ID

GET ASSET https://report.iotfactory.eu/api/assets/{id}

Request headers

Basic authentication involves sending a verified username and password with your request In the request Headers, the Authorization header passes the API a Base64 encoded string representing your username and password values, appended to the text Basic as follows:

Basic <Base64 encoded username and password>

URL Params

—

URL Variables

Get measurements from asset devices

GET ASSET https://report.iotfactory.eu/api/assets/{id}/measurements

URL Params

—

URL Variables

Devices, smart devices or static lists can be attached to an asset. The identifiers of these objects can be found in the corresponding table of an asset.

Ex: Get the last ten weekly smart measurements of a smart devices (_id:6513e6769a0d12001268d169) attached to an asset(_id:6508132813019d0012630749) after the 16/11/2023 10pm UTC

    https://report.iotfactory.eu/api/assets/6508132813019d0012630749/measurements?device=6513e6769a0d12001268d169&type=Occupied (first)&step=weekly&limit=10&after=2023-11-16T22:00:00.000Z
    

Result:

    {
  "data": [
      {
          "_id": "65aef1c2d6c621996407a92c",
          "smartdevice": {
              "id": "6513e6769a0d12001268d16c",
              "team": "1ha4pei7n.hp",
              "name": "Desk occupied"
          },
          "timestamp": 1705878000000,
          "updatedAt": "2024-01-23T14:36:18.131Z",
          "device": {},
          "staticList": {},
          "measurements": [
              {
                  "type": "Occupied (first)",
                  "value": 0,
                  "before": 1705878000000,
                  "at": "2024-01-21T22:55:00.000Z",
                  "unit": "",
                  "cache": true
              }
          ]
      },
      
      ...
      
      {
          "_id": "6573242b70f14a87dbaf0079",
          "smartdevice": {
              "id": "6513e6769a0d12001268d16c",
              "team": "1ha4pei7n.hp",
              "name": "Desk occupied"
          },
          "timestamp": 1700434800000,
          "updatedAt": "2023-12-08T14:14:35.531Z",
          "device": {},
          "staticList": {},
          "measurements": [
              {
                  "type": "Occupied (first)",
                  "value": 0,
                  "before": 1700434800000,
                  "at": "2023-11-19T22:55:00.000Z",
                  "unit": "",
                  "cache": false
              }
          ]
      }
  ],
  "pages": 1,
  "parent": {
      "_id": "6508132813019d0012630743",
      "name": "Anderlecht"
  },
  "recordsFiltered": 10
  }