{
    "tenantId": "e0736b86-[....]-e0396846f1f8",
    "type": "RetrofitMeter",
    "manufacturer": "Xenn",
    "reference": "P1000000000",
    "code": "123456"
}

​
What you’ll need

  • Your API credentials and a Tenant or Collective ID
  • The dongle’s P1 reference number
  • The dongle’s pairing code

​
Locating the pairing code

The reference number and pairing code may be provided to you as part of the dongle’s packaging and can always be found when connecting to its local UI.

​
Let’s get started

1

Start the onboarding process

Create an Entity Onboarding Request, setting the to RetrofitMeter and to Xenn.

You’ll also need to specify its as a unique device identifier and a pairing .

​
type
enum<string>
required
​
manufacturer
string
required
​
reference
string
required
​
code
string
required

Lastly, you may need to include either a or to complete the request.

2

Track the onboarding status

Periodically poll the Onboarding API to check if the status of your request has updated to Succeeded. Once it’s complete, you’ll find the newly created Entity and its ID in the object.

You can reference the when using our Readings API.

{
   "id": "3c90c3cc-[....]-8dd25736052a",
   "status": "Succeeded",
   "data": {
       "entity": {
           "id": "3c90c3cc-[...]-8dd25736052a",
           ...
       },
   }, ...
}

​
Work with your newly created Entity

Tip: Take note of your Entity ID before you get started with our APIs.

Readings API

List the dongle’s readings.

{
    "tenantId": "e0736b86-[....]-e0396846f1f8",
    "type": "RetrofitMeter",
    "manufacturer": "Xenn",
    "reference": "P1000000000",
    "code": "123456"
}