Skip to content

Overview

Pylontech OpenAPI allows approved partners to access end user's sites and devices managed by Pylontech Cloud.

It provides APIs for:

  • discovering authorized sites and their devices;
  • telemetry data, energy statistics, alarms, and
  • managing persistent configuration, recurring schedules, and temporary device commands.

The API is intended for cloud-to-cloud integrations. Access is granted to a partner application and is limited to the sites authorized for that application.

Architecture

text
Partner application

        │ OAuth 2.0 access token

Pylontech OpenAPI


Pylontech Cloud ── Site ── Device

The partner application obtains an access token, calls Pylontech OpenAPI, and operates only on resources within its authorized site scope. A site is the top-level resource exposed by the API. Devices belong to a site and provide the telemetry and control capabilities available to the integration.

Access Models

Pylontech OpenAPI supports two integration flows:

  • Authorization Code — a site owner authorizes a third-party application to access their resources.
  • Client Credentials — a server application receives client credentials and binds specific sites to the client.

See Authorization Code and Client Credentials & Site Binding for their respective flows.

API Environments

Use the base URL assigned to the corresponding region.

EnvironmentBase URL
Europe productionhttps://openapi.pylontechcloud.com/api/openapi/v1
Australia productionhttps://openapi-au.pylontechcloud.com/api/openapi/v1

Credentials and authorizations are environment-specific. A token issued for one environment cannot be used in another environment.

For available resources and operations, open the API Reference.