API Reference
Start typing to search…

API Introduction

Welcome to the EOSVOLT API — a REST interface for integrating with the EOSVOLT EV-charging platform. Use it to manage chargers, sessions, pricing, and operational data from your own systems and apps.

Overview

  • Style: REST over HTTPS
  • Formats: JSON requests/responses
  • Use cases: asset management (chargers, locations), session lifecycle, reporting/exports, and (optionally) fleet/home features depending on your account
💡

Tip

Each endpoint page lists required params, response bodies, and example requests. Use the Try it button in the reference to experiment with real calls.

Environments

EOSVOLT exposes a Production environment plus a Staging environment for safe testing.

EnvironmentBase URL
Productionhttps://api.eosvolt.com/
Staginghttps://api-staging.eosvolt.com/
⚙️

Note

Exact routes are versioned (e.g., /v1/...). Confirm the version prefix shown on each endpoint page before implementing.

Authentication

All endpoints require authenticated requests.

  • Scheme: Bearer token (JWT or API key) sent via the Authorization header.

  • Header:

    Authorization: Bearer YOUR_TOKEN

  • Token scope/permissions: Vary by account. See your admin portal for key management and rotation.

⚠️

Important Do not embed secrets in client-side code or public repos. Rotate keys if you suspect exposure.

Pagination, Filtering, Sorting

Most list endpoints support some combination of:

  • page/limit or offset/limit for pagination
  • Filter params (e.g., by time window, status, location)
  • Sort params where applicable
💡

Tip

For large data pulls, iterate with pagination instead of increasing a single limit.

Error Handling

Errors return standard HTTP status codes with a machine-readable body.

Common patterns:

  • 400 Bad Request — validation or malformed input
  • 401/403 — auth or permission issues
  • 404 — resource not found
  • 409 — conflict (e.g., state not valid for action)
  • 429 — too many requests (rate limiting)
  • 5xx — transient platform error

Error response (illustrative):

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

Tip

Check the code (or equivalent) field for a stable programmatic handle across messages.

Versioning

Routes are versioned (e.g., /v1). Backwards-incompatible changes are introduced under a new version path. When upgrading, review the changelog on the relevant endpoints.

Typical Workflow

  • Authenticate and store a short-lived token securely
  • Discover resources (locations/chargers) you’re allowed to manage
  • Act (start/stop sessions, update settings)
  • Report (pull sessions and exports for analytics/billing)

Quick Examples

List chargers

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

Start session (illustrative)

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 The exact path and payload may differ. Use the endpoint’s page in the reference for the canonical schema.

Support

  • Docs: Browse the left navigation for domain-specific guides and endpoints
  • Questions: Contact your EOSVOLT representative or support channel listed in your tenant
  • Integrations: For advanced use cases (e.g., roaming, POS, dynamic pricing), reach out to discuss best practices