API Introduction

Use the EOSVOLT API to manage chargers, sessions, pricing, and operational data directly from your own systems and apps. The API provides a REST interface over HTTPS with JSON requests and responses.

Overview

The EOSVOLT API lets you integrate your applications and services with the EOSVOLT EV-charging platform. You can manage assets such as chargers and locations, control session lifecycles, generate reports, and access fleet or home features depending on your account type.

Style: REST over HTTPS Format: JSON Use cases: Charger management, session control, analytics, exports, and integrations

💡

Tip

Each endpoint page lists required parameters, example requests, and response bodies.
Use the Try it button in the API Reference to test calls directly.

Environments

EOSVOLT provides both a Production and a Staging environment for safe testing.

⚙️

Note

All routes are versioned (for example, /v1/...).
Always confirm the version prefix shown in the API Reference before implementing.

Authentication

All API requests require a bearer token or API key sent via the Authorization header.

Authorization: Bearer YOUR_TOKEN

Tokens have different scopes depending on your account configuration. You can manage and rotate keys in your Admin Portal → API Keys section.

⚠️

Important

Never embed API keys or tokens in client-side code or public repositories.
Rotate credentials immediately if you suspect exposure.

Pagination, filtering, and sorting

Most list endpoints support a combination of:

• page and limit or offset and limit for pagination
• Filtering by time window, status, or location
• Sorting by supported fields

💡

Tip

For large data pulls, iterate using pagination instead of raising the limit parameter.

Error handling

Errors use standard HTTP status codes with JSON responses.

Example response:

{
  "success": false,
  "code": "invalid_parameter",
  "message": "Field 'connectorId' is required."
}

💡

Tip

Use the code field as a stable programmatic identifier for error handling.

Versioning

All routes are versioned (for example, /v1). Backward-incompatible changes are introduced under new version paths. When upgrading, review the changelog for details on affected endpoints.

Typical workflow

1. Authenticate and store a short-lived token securely.
2. Retrieve available resources such as locations and chargers.
3. Perform actions (for example, start or stop sessions, update settings).
4. Export sessions and reports for billing or analytics.

Quick examples

List chargers

curl -X GET "https://api-staging.eosvolt.com/v1/chargers?limit=25" \
  -H "Authorization: Bearer YOUR_TOKEN"

Start a session (example)

curl -X POST "https://api-staging.eosvolt.com/v1/sessions/start" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "connectorId": "242.2.1" }'

⚠️

Example only

Paths and payloads may differ.
Always refer to the endpoint documentation in the API Reference.

Support

• Docs: Browse the left navigation for guides and endpoint details.
• Questions: Contact your EOSVOLT representative or your account’s support channel.
• Integrations: For advanced use cases such as roaming, POS, or dynamic pricing, reach out to discuss integration best practices.