{
    "tenantId": "e0736b86-[....]-e0396846f1f8",
    "type": "PV",
    "manufacturer": "SMA",
    "reference": "0987654321",
    "email": "somebody@example.com"
}

​
What you’ll need

  • Your API credentials and a Tenant or Collective ID
  • The plant ID for the PV system
  • The email address of the plant owner

​
Locating the plant ID

In SMA’s Sunny Portal, the plant ID is part of the URL when navigating to the corresponding plant or when clicking on the PV System Logbook navigation tree item. The plant ID may not be visible in the UI itself.

​
Let’s get started

1

Start the onboarding process

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

You’ll also need to specify the plant ID as its , and the plant owner’s address.

​
type
enum<string>
required
​
manufacturer
string
required
​
reference
string
required
​
email
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.

SMA always requires an action of Consent. This means that the action has to be completed through SMA’s website or by responding to a notification they have sent to the plant owner. Such actions also contain a leading to more information on how to complete the action.

Response (Body)
{
    "id": "3c90c3cc-[....]-8dd25736052a",
    "status": "Pending",
    "requestType": "Entity",
    "action": {
        "type": "Consent",
        "documentationLink": "<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": "SMA",
    "reference": "0987654321",
    "email": "somebody@example.com"
}