Skip to main content

Onboard Your Device

STEP 1. Register a Device​

1.1 Sign in WISE Portal​

Log in WISE Portal: https://{domain}/platform/desk using the Tenant Admin account.

WEDA Sign In the WISE Portal

1.2 Get User WEDA Core Access Token​

Open a new browser tab and go to: https://{domain}/platform/solutions.
This page will return two types of tokens:

  • DeskCookie
  • AccessToken - used for WEDA API.

The accessToken should be included in the Authorization header when calling APIs:

Authorization: Bearer {access-token}

WEDA accessToken

WEDA API Reference

WEDA API Documentation

1.3 Create a New Org​

Create a new organization using the following API.

Endpoint​

POST /api/v1/orgs

Example Request​

curl --location --request POST 'https://{domain}/api/v1/orgs' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {access-token}' \
--data '{
  "name": "Org1"
}'

Example Response​

{
  "name": "Org1",
  "id": "3a1d1d06-4759-cefd-af34-0705d0ca8902",
  "parentId": null
}

1.4 Refresh the accessToken​

Refresh the token to obtain an org-scoped accessToken. Use the accessToken and refreshToken retrieved from the previous step in the request body.

Endpoint​

POST /platform/solutions/api/v1/auth/tokens

Example Request​

curl --location --request POST 'https://{domain}/platform/solutions/api/v1/auth/tokens?grant_type=refresh_token' \
--header 'Content-Type: application/json' \
--data '{
  "token": "{access-token}",
  "refreshToken": "{refresh-token}"
}'
NOTE

The refresh token API does not require an Authorization header.

Example Response​

{
  "accessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9....",
  "refreshToken": "1b5cf6c2587f472fb8b159....",
  "expiresIn": 7200,
  "tokenType": "Bearer"
}

Use the new accessToken for the following API requests.

1.5 Create a Device​

Create a device using the following API, including the Org ID from the previous step in the request body.

Endpoint​

POST /api/v1/devices

Example Request​

curl --location --request POST 'https://{domain}/api/v1/devices' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {access-token}' \
--data '{
  "deviceId": "48b02d8861de",
  "hwModel": "MIC-710",
  "orgId": "3a1d40ed-4f97-aed8-c727-57704d3d5d2e"
}'
note
  • deviceId: Must be a MAC address (lowercase letters and numbers only, no symbols).
  • hwModel: The system validates hardware information using /etc/board. Open the file with vi /etc/board to check the hardware model. If the file doesn’t exist, create it and enter the hardware model inside.

Example Response​

{
  "deviceId": "48b02d8861de",
  "hwModel": "MIC-710",
  "orgId": "3a1d40ed-4f97-aed8-c727-57704d3d5d2e",
  "status": "Registered"
}

The device is now registered on WEDA Core.

STEP 2. Install WEDA Node​

2.1 Run WEDA Node Activator on the Device​

Click WEDA Node Activator to start the installation process. Follow the instructions to install and run the WEDA Node Activator on your edge device. This will connect your device to the WEDA platform and allow you to manage it through WEDA's interface.

STEP 3. Get Device Telemetry Data​

3.1 Enable Target Sensors​

After obtaining the full list of device capabilities, select the resourceId of the sensors that need to upload data to WEDA Core. Use the following API to update the device configuration and enable the selected sensors with the data reporting frequency.

Endpoint​

PATCH /api/v1/devices/{deviceId}/sensors

Example Request​

curl --location --request PATCH 'https://{domain}/api/v1/devices/48b02d8861de/telemetry-configs/desired' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {access-token}' \
--data '{
  "allInterval": 2000,
  "sensors": [
    {
      "resourceId": "e1090dee-857c-539d-b572-1e8250113520",
      "enabled": true
    },
    {
      "resourceId": "977f6249-d505-562b-a0af-698981f9710c",
      "enabled": true
    },
    {
      "resourceId": "78f03238-8e21-536d-b445-bcbd8d8b9646",
      "enabled": true
    }
  ]
}'

Example Response​

{
  "allInterval": 2000,
  "sensors": [
    {
      "resourceId": "e1090dee-857c-539d-b572-1e8250113520",
      "enabled": true,
      "interval": null
    },
    {
      "resourceId": "977f6249-d505-562b-a0af-698981f9710c",
      "enabled": true,
      "interval": null
    },
    {
      "resourceId": "78f03238-8e21-536d-b445-bcbd8d8b9646",
      "enabled": true,
      "interval": null
    }
  ]
}

3.2 Get Device Telemetry States​

Use the following API to confirm if the configuration have been successfully applied.

Endpoint​

GET /api/v1/devices/{deviceId}/sensors

Example Request​

curl --location --request GET 'https://{domain}/api/v1/devices/48b02d8861de/telemetry-configs/reported' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {access-token}'

Example Response​

{
  "allInterval": 2000,
  "sensors": [
    {
      "resourceId": "e1090dee-857c-539d-b572-1e8250113520",
      "enabled": true,
      "interval": null
    },
    {
      "resourceId": "977f6249-d505-562b-a0af-698981f9710c",
      "enabled": true,
      "interval": null
    },
    {
      "resourceId": "78f03238-8e21-536d-b445-bcbd8d8b9646",
      "enabled": true,
      "interval": null
    }
  ]
}

3.3 Get Latest Device Telemetry Data​

Use the following API to get the latest telemetry snapshot from the device, including online status and the most recent dataObject values.

Endpoint​

GET /api/v1/devices/{deviceId}/inputs/data-objects/latest

Example Request​

curl --location --request GET 'https://{domain}/api/v1/devices/48b02d8861de/inputs/data-objects/latest' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {access-token}'

Example Response​

{
  "deviceId": "48b02d8861de",
  "time": "2025-10-30T06:26:26.145Z",
  "dataObjects": {
    "systemTimeSeconds": 170010.165,
    "ramSwapTotalBytes": 3592273920,
    "sdaDiskIOTimeSecondsTotal": 0,
    "mmcblk0DiskWrittenBytesTotal": 6952206336,
    "mmcblk0DiskReadBytesTotal": 2559474688
  },
  "dataTypes": ["double", "double", "double", "double", "double"]
}

Congratulations! You have successfully onboarded your edge device to the WEDA platform and retrieved telemetry data. Next, you can explore how to deploy AI Containers.

Last updated on Mar-31, 2026 | Version 1.0.0

On this page ...

Is this helpful?