API Reference
Complete REST API documentation for integrating with Powerfill. All endpoints support JSON and require Basic Authentication.
Authentication Required
All API requests require Basic Authentication using your account email and API password.
Test endpoints with your data at powerfill.app
API Controllers
Select a controller to view all available endpoints, parameters, and response schemas.
Certificates
Operations related to certificates.
Charge Points
Operations related to managing Charge Points.
OCPP Events
Operations related to OCPP security events, firmware update status events and log upload status events.
OCPP Operations
Operations that can be initiated by the Central System at the Charge Points. Some of these operations allows multiple Charge Points to be selected, whereas others are specific to a single Charge Point. For the detailed information on the parameters, please refer to the OCPP specification.
OCPP Tags
Operations related to managing Ocpp Tags. An Ocpp Tag is the identifier of the actor that interacts with the charge box. It can be used for authorization, but also to start and stop charging sessions. An RFID card is an example of an Ocpp Tag.
Permissions
Operations related to managing permissions of Ocpp Tags. A permission is granting of access of an Ocpp Tag to a Charge Box. This allows the owner of the Ocpp Tag, e.g., to start and stop charging sessions at that Charge Box. In order to manage permissions in bulk, we also support managing permissions for "tag groups". Permission management uses the tree model created by the site management. This means: instead of assigning permissions directly to particular Charge Boxes, we create the association with the site node. Since charge boxes can be associated with nodes, the permission of an Ocpp Tag to a Charge Box happens transitively.
Reservations
Operations related to querying reservations.
Settings
Provides endpoints to retrieve and update application settings, including OCPP and Mail configurations.
Sites
Operations related to managing the topology of a site. A site is a physical location where charge boxes are installed. The site is modeled as a tree structure with nodes representing different parts of the site. Each node can have children nodes, which allows for a flexible representation of the site. Charge boxes can be associated with nodes in the tree.
Smart Charging
Operations related to smart charging.
Statistics
Operations related to querying statistics and real-time status of charge points and connectors.
Tag Groups
Operations related to managing Ocpp Tag groups. The Ocpp Tag Group is a logical grouping of Ocpp Tags. This allows for flexible management of permissions in bulk (see permission-controller).
Transactions
Operations related to querying transactions. A transaction represents a charging session at a charge box (i.e. charging station. The notions 'charge box' and 'charging station' are being used interchangeably).
Users
Operations related to managing users (i.e. end-users). The user is a customer, client; a person who is using the services of charging stations via this platform. A user is the holder of an Ocpp Tag.
Web Users
Web users can interact with the system both through the web-based graphical user interface and via REST API access. REST API endpoints allow authorized users to perform actions such as viewing transactions, managing OCPP tags, and more, protected by Basic Authentication mechanism. The email-password pair should be used to construct the Basic Authentication HTTP header for the REST API calls.