ITENDE
Sign in to the portal

What the remote API is and how to request access

The remote API gives your platform direct, read-only access to the monitoring data of the photovoltaic and storage plants linked to your organization. It is meant for anyone who wants to bring this data into their own systems.

What it offers

  • plant registry: name, country, time zone, address
  • connectivity: plant and gateways online or offline
  • instantaneous power and power series: PV, loads, grid, battery and state of charge
  • energy totals and series: produced, consumed, imported, exported, charged and discharged
  • active and historical alarms

It is a REST API over HTTPS: requests and responses are JSON, and access is machine-to-machine with OAuth 2.0 client credentials. Data is retrieved by polling: the API does not push data to you.

Address
API base URL https://api.cloud.energyincloud.com
Token endpoint https://k8s.prod.cloud.energyincloud.com/webapp/oauth/token

All data endpoints live under /v1.

What it does not do

  • It does not change your plants. This version is read-only. Control functions (setpoints, operating mode) are not active: they will be activated under a dedicated agreement.
  • It does not see other organizations' plants. A plant that is not linked to your organization comes back as "not found".
  • It does not tell you when something changes. To get fresh data you query the API at regular intervals: the page "Units, signs and data updates" says how often.

How to get a client

API access is enabled only on explicit request: credentials cannot be created from the portal by users.

  1. Ask zeroCO2 for access by writing to info@energysynt.com with the name of your organization.
  2. A zeroCO2 operator creates an API client for your organization and gives you a client_id and a client_secret.
  3. Store the secret in a secrets manager right away: it is shown only once, at creation. Never embed it in client-side code, such as a web page or an app.

If the secret is lost or exposed, ask zeroCO2 for a new client.

By default a client receives these permissions (scopes):

Scope Gives access to
read:plants plant list and detail, connectivity
read:telemetry instantaneous power and power series
read:energy energy totals and series
read:alarms active and historical alarms

Tokens also carry read:controls, reserved for the control functions that are not active in this version.

Which plants the client sees

The client sees exactly the plants linked to your organization. You get the list with GET /v1/plants. Each plant has a stable identifier, plant_id, to use in every other call.

Where to start

  1. Get your client as described above.
  2. Follow "Authentication and first call" to obtain a token and list your plants.
  3. Before you put the integration into service, read "Limits, errors and support".