​

Podero Partner API Developer Reference

Version: 2.0.0 This resource provides a concise overview of the Podero Partner API endpoints, designed for interacting with and governing its hardware and features.

​

Versioning

Given a version number MAJOR.MINOR.PATCH, we increment:

1. MAJOR version when incompatible API changes are made
2. MINOR version when functionality is added in a backward-compatible manner
3. PATCH version when backward-compatible bug fixes are made

The developer documentation is tagged with the corresponding version number. The API URL is tagged with the current MAJOR.MINOR version. New versions are issued when significant changes occur or new features are introduced that may break existing functionality. Bug fixes are made available across all supported API versions.

​

Environments

You can access multiple environments within our systems. Each has its unique access policies and live/mocked configurations.

​

API Documentation

A detailed low-level documentation of the API can be found in the API Reference.

​

Organization and User Management

There are 3 access levels within an organization:

• Administrator
• Staff
• User

The “Administrator” and “Staff” roles can view and edit all other users, their buildings, and devices. An Administrator can add other Staff and Administrators. The Client Credential access for a server-to-server connection has the same privileges as an organization’s Administrator.

​

Permission Matrix

Administrator / Server-to-Server

Role	Create	Read	Update	Delete
Admin Users	✅	✅	✅	✅
Staff Users	✅	✅	✅	✅
Users	✅	✅	✅	✅
Buildings	✅	✅	✅	✅
Energy Contracts	✅	✅	✅	✅
Devices	✅	✅	✅	✅

Staff

Role	Create	Read	Update	Delete
Admin User	❌	✅	❌	❌
Staff User	❌	✅	❌	❌
Users	✅	✅	✅	✅
Buildings	✅	✅	✅	✅
Energy Contracts	✅	✅	✅	✅
Devices	✅	✅	✅	✅

User (End-User)

The “User” can only see and edit their own assets and no assets owned by other users.

Role	Create	Read	Update	Delete
User	❌	✅	✅	❌
Building	✅	✅	✅	✅
Device	✅	✅	✅	✅

​

Core Concepts

​

Organization

An organization is the highest level our Partners have access to. For management purposes, one Partner can maintain multiple organizations.

​

Users

The user refers to the Partner’s end-user, who owns the devices that are being monitored, steered, and optimized through Podero’s platform. The Partner can choose to add their own internal ID, as well as a host of other additional information. Our API is connected to a rich database, allowing the Partners to add extensive information about their users, reducing effort and needed disk space on their own server side.

​

Buildings

Buildings allow our Partners to group devices. In some cases, an end-user has multiple devices at different locations (e.g. a heat pump at home, as well as another one at the summer house). Buildings allow the Partner to manage the consumption more efficiently and correctly associate user behavior to different metering points for the Partner’s billing purposes.

​

Energy Contracts

The Energy Contract model contains information about each user’s energy supplier, their contract type and their energy prices. This information will be considered by the Podero optimization algorithm and for the calculation of the user’s energy savings. Energy Contracts can optionally be linked to buildings.

​

Devices

The devices that can be monitored, steered, and optimized through the Podero platform are:

• Heat Pumps
• Electric Vehicles
• Solar Inverters

​

Next Steps