Charger Onboarding by the CPO through API

For Charge Point Operators (CPO) using Jedlix's Smart Charging API, programmatic onboarding offers a streamlined and efficient method to integrate chargers into the platform. This approach is notably advantageous as it bypasses the necessity for additional inputs from end users, thereby accelerating the integration process and minimizing the risk of errors.

Prerequisites

Before attempting to onboard a Charger through the API, ensure that you are registered as a CPO on the Jedlix platform. If this hasn’t been configured, please reach out to your customer success manager to begin the setup process.

How to add a charger through the API

To integrate a charger programmatically, utilize the specialized endpoint to Add a charger to a charge location.

Here, it is mandatory to provide the **externalId** of the charger. This is the unique identifier for the EVSE within the CPOs and suboperator platforms and is immutable. In OCPI, this corresponds to the **uid** in the EVSE object or the **evse_uid** in the Sessions object.

It should not be mistaken for EVSE ID.

Example

Initiate POST Request: Run the subsequent cURL command to incorporate a charger:

curl -X POST "<https://smartcharging.jedlix.com/api/v1/users/{userId}/charging-locations/{chargingLocationId}/chargers>" \\
     -H "Accept: application/json" \\
     -H "Content-Type: application/json" \\
     -H "Authorization: Bearer {ACCESS_TOKEN}" \\
     -d '{"externalId": "{EXTERNAL_ID}"}'

Parameters

• {userId}: Identifier corresponding to the user account where the charger is being integrated.
• {chargingLocationId}: Identifier for the specific charging location where the charger is being integrated.
• {ACCESS_TOKEN}: Your OAuth authentication token obtained during the authentication phase.
• {EXTERNAL_ID}: The unique identifier for the EVSE within the CPOs and suboperator platforms. Corresponds with the EVSE UID in OCPI and should not be mistaken for the EVSE ID.

🚧

Do not use the EVSE ID as External ID

To preserve the uniqueness of an EVSE’s uid within a CPO’s platform and to guarantee that EVSEs are never removed, a CPO must refrain from employing identifiers of the physical hardware for this uid property. Utilizing a physical identifier may violate the uniqueness requirement for uid if the identical physical EVSE is reinstalled at a different location.