HomeGuidesAPI ReferenceChangelog
Log In
Changelog
Start typing to search…
Back to All
Added

(v.2.3.0) Enhanced remote charger control & EVSE management & introducing token management

23 days ago

🔹 What's new?

We're introducing comprehensive remote charger control and enhanced EVSE management to the Spirii API, enabling you to manage your charging infrastructure without physical site visits.

Additionally, we're introducing token and token group management, enabling you to manage your charging tokens programmatically.

Remote charge box commands

  • Soft Reset: Graceful restart preserving data and configurations
  • Hard Reset: Full hardware reboot for unresponsive charge boxes

EVSE management and commands

  • Transaction control
    • Remote Start: Initiate charging sessions remotely - essential for app-based authorization and driver support
    • Remote Stop: End active sessions remotely to resolve stuck transactions
  • Unlock Connector: Remotely release connector locks to assist drivers with stuck cables on AC chargers with sockets.
  • Retrieve EVSE Information: List all EVSEs or fetch specific EVSE details including status, connectors, and power capabilities
  • Update EVSE Settings: Modify properties like maximum power output and connector type for individual EVSEs
  • Change Connector Availability: Update OCPP availability status for maintenance without affecting the entire charge box

Tokens management - Full CRUD operations

  • Tokens (also known as ID tags or charge keys) are unique identifiers that authenticate users to initiate a charging session.
  • Spirii differentiates between three types of tokens:
    • RFIDs
    • virtual tokens
    • and vehicle tokens.
  • Use the new token endpoints to manage tokens for your drivers and network.
  • We introduce full CRUD operations for token management, incl. (dis)abling tokens.

Token Groups management - Full CRUD operations

  • In Spirii, a token group is an access management mechanism where only tokens inside a group can authorize charging at specified locations.
  • Use these new token groups endpoints to manage location access for your drivers and network.
  • We introduce full CRUD operations for token group management, incl. (dis)associating locations and tokens to token groups.

📌 New endpoints:

Remote charge box management

  • POST /chargeboxes/:id/reset
  • POST /chargeboxes/:id/reboot

EVSE management

  • POST /evses/:uid/connectors/:id/remote-start-transaction
  • POST /evses/:uid/connectors/:id/remote-stop-transaction
  • POST /evses/:uid/connectors/:id/unlock
  • GET /evses & GET /evses/:id
  • PATCH /evses/:id/connectors/:id
  • POST /evses/:id/connectors/:id/change-availability

Token management

  • GET /tokens/:id
  • GET /tokens
  • POST /tokens
  • POST /tokens/:id/enable
  • POST /tokens/:id/disable
  • PATCH /tokens/:id
  • DELETE /tokens/:id

Token group management

  • GET /token-groups/:id
  • GET /token-groups
  • POST /token-groups
  • POST /token-groups/:id/enable
  • POST /token-groups/:id/disable
  • PATCH /token-groups/:id
  • DELETE /token-groups/:id
  • GET /token-groups/:id/locations
  • POST /token-groups/:id/locations/:locationId
  • DELETE /token-groups/:id/locations/:locationId
  • GET /token-groups/:id/tokens
  • POST /token-groups/:id/tokens/:tokenId
  • DELETE /token-groups/:id/tokens/:tokenId

🔄 Key changes & improvements

Endpoints

Feature

Description

Reset & Reboot

  • Soft reset for graceful restarts
  • Hard reset for unresponsive units

Transaction Control

  • Start sessions before vehicle connection
  • Stop active sessions remotely

Connector Management

  • Unlock AC socket connectors remotely
  • Assist with stuck cables

EVSE Information

  • List and retrieve EVSE details
  • Monitor equipment performance

EVSE Configuration

  • Update maximum power output
  • Modify connector types

Availability Control

  • Change OCPP availability status
  • Manage maintenance windows

Full CRUD operations for Tokens

  • Get a token by ID
  • Get a list of tokens
  • Create a new token
  • Enable a token
  • Disable a token
  • Update a token
  • Delete a token

Full CRUD operations for Token Groups

  • Get a token group by ID
  • Get a list of token groups
  • Create a new token group
  • Enable a token group
  • Disable a token group
  • Update a token group
  • Associate a location with a token group
  • Disassociate a location from a token group
  • Associate a token with a token group
  • Disassociate a token from a token group

📢 Use cases examples

For NOC & support teams:

  • Troubleshoot issues remotely without site visits
  • Assist drivers with authorization and stuck sessions
  • Unlock connectors when cables are stuck

For CPOs:

  • Build custom monitoring and alerting solutions
  • Perform maintenance without taking charge boxes offline
  • Manage fleet operations efficiently
  • Bulk-create and manage tokens
  • Manage location access via token groups

📖 Next steps

  • Explore the API Reference [link] for detailed specifications
  • Read more in our guide here [link]