Skip to main content

API Integration

The REST API is used for site configuration and driver-facing operations. It allows you to create and manage sites, topologies, profiles, and optimization settings, as well as provide driver-facing endpoints for session input and personal schedules.

warning

The API does not support data ingress (sending measurements or transactions) or schedule egress. For sending measurement data and receiving optimized schedules, use MQTT, the Smart OCPP Broker, or Eniris Smart Grid One.

What You Can Do with the API​

  • Create and manage sites — define your site topology, devices, and grid connection.
  • Configure optimization settings — set up contracts, profiles, and activation.
  • Driver input/output — allow drivers to submit session details (departure time, energy needs) and retrieve their personal schedules.

API Base URL​

https://api.pleevi.ai

Authentication​

All API requests require a Bearer token in the Authorization header. See Account Setup for how to obtain your access token.

info

For full API reference and all available endpoints, see the API Documentation.

When to Use the API​

The API is the right choice when you need to:

  • Set up and configure sites programmatically instead of using the Portal.
  • Build driver-facing applications that let drivers provide session details and view their schedules.
  • Manage profiles for default departure times and energy requirements.
tip

The API is typically combined with another integration method for data flow. For example, use the API for site configuration while using MQTT for real-time data ingress and schedule delivery, or the Smart OCPP Broker for automatic charging station integration.