Skip to main content

Create EVSE Network through API

Omkar Kadkol
Updated

The EVSE Network API enhances automation and enables easier management of EVSE Networks, Groups, and Assignments in one request. Reducing manual work and errors ensures consistency across the HBS platform.

This API is especially valuable for managing multiple subCPOs, simplifying complex EVSE Groupings in NGP Service Offers, and laying the groundwork for NGP automation.

Business Rules

EVSE Network Creation:

  • You must follow the same process as the HBS portal when creating an EVSE Network.

  • The API enforces data validation for required fields (e.g., unique network name, optional description).

  • If an error occurs, API responses should mirror portal exceptions.

  • Secure access must be maintained via certificate-based authentication.

EVSE Group Creation:

  • The API allows you to create EVSE Groups within an EVSE Network.

  • Group names must be unique within the parent EVSE Network.

  • The API validates required fields, ensuring consistency with the portal.

  • The API supports the creation of multiple EVSE Groups in a single request.

  • The API returns successfully created EVSE Group details (ID, name, timestamps, etc.).

  • Failed attempts return clear status messages.

EVSE Assignment to EVSE Group:

  • The API allows you to assign one or more unique EVSEs to an EVSE Group.

  • The request includes a unique EVSE Group name and a list of EVSE IDs.

  • Duplicate EVSEs are not allowed to be assigned to multiple groups or the same group.

  • The API returns a response confirming successful assignments or detailing failure reasons.

 

EVSE Network Endpoints:

for QA - environment:

https://service-qa.hubject.com/api/evsenetwork/v1/operators/{operatorid}/networks

for PROD - environment: https://service.hubject.com/api/evsenetwork/v1/operators/{operatorid}/networks

Technical Documentation

EVSE network API.

You have two journeys to choose from,

  • Create EVSE network, EVSE groups and assign EVSEs entirely through the portal.
  • Create EVSE network, and EVSE groups, and assign EVSEs through the API.

The developed EVSE Network API will focus on automatically creating EVSE Network, EVSE Group(s) within the network, and assigning EVSEs to the different groups. The request consists of the following fields:

  • EVSE network name

  • EVSE network description

  • EVSE Group(s) names (the API supports the creation of multiple EVSE Groups in a single request)

  • EVSE group description

  • EVSEs to assign

Conditions:

  • The EVSE network name must be unique.
  • EVSE network description is not mandatory.
  • The EVSE Group name must be unique within the EVSE Network.
  • EVSE Group description is not mandatory.
  • The EVSEs can ONLY be assigned to 1 EVSE Group within the Network.
  • EVSEs must already be pushed to HBS - if all EVSEs are correct, the API is successful, and all EVSEs included in the call are assigned to their groups.

Where to locate:

You can see the created EVSE network in the Hubject portal - navigate to Business Contracts | EVSE Network, under the EVSE Network name, you can see:

“Last updated on dd/mm/yyyy at hh:mm:ss via API”

Code Snippets

Create an EVSE network with one EVSE group and assign EVSEs.
image-20250403-071158.png

Create an EVSE network with more than one group and assign EVSEs

image-20250403-071439.png

 

Final Steps in the NGP create offer automation:

You should save the response body after the successful push so that the EVSE Network and Group IDs newly created can be inserted in the next API call (coming in Q2-Q3 2025).

 

Note:

When you want to assign newly pushed EVSEs to an existing EVSE Group/Network, the EVSE Assignment API will still be required for this scenario. The EVSE Assignment API was developed in 2023 and is currently part of the core APIs.

 

GitHub Link: 03_Services/Services Implementation for CPOs/11-eRoamingEVSEAssignment.md

 

Related articles