{
    "tenantId": "e0736b86-[....]-e0396846f1f8",
    "type": "PV",
    "manufacturer": "Huawei"
}

​
What you’ll need

  • Your API credentials and a Tenant or Collective ID
  • The plant owner needs a Huawei account to provide consent

​
Let’s get started

1

Start the onboarding process

Create an Entity Onboarding Request, setting the to PV and to Huawei.

​
type
enum<string>
required
​
manufacturer
string
required

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

2

Check for required actions

In most cases, the onboarding request will have the Pending until a required is completed.

Huawei always requires an action of Redirect. Such actions contain a . You can redirect your user here or share this link directly with the plant’s owner to complete the action.

Response (Body)
{
    "id": "3c90c3cc-[....]-8dd25736052a",
    "status": "Pending",
    "requestType": "Entity",
    "action": {
        "type": "Redirect",
        "redirectLink": "<string>"
    },
    "data": {
        ...
    }, ...
}
​
action
object
3

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 and the Commands 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

Observe the state of the plant.

Commands API

Curtail or deactivate the inverter.

{
    "tenantId": "e0736b86-[....]-e0396846f1f8",
    "type": "PV",
    "manufacturer": "Huawei"
}