General information about API usage

With the help of the be.ENERGISED API you have the possibility to automate and control functions of the software via third party systems. You can make the necessary settings in be.ENERGISED under Settings/System settings/API settings.

User and system tokens are available for accessing the API. User tokens each have limited data access to the user's data, system tokens have access to all information in your client.

What is the Fleet API?

The Fleet API gives you the possibility to create CRM contact, portal user, and card. Fleet customers can then build their own registration forms for their individual fleets based on this API. The fleet drivers can then register with this user in the respective fleet APP and have the correct contract assigned immediately (registration and contract creation are deactivated in the app). The API is secured with a token that can be read from the settings page in your be.ENERGISED instance. The token must be passed as header x-api-token within each request.

Requirements to use the Fleet API

• you have created an API token in the be.ENERGISED backend
• you have configured a company (in be.ENERGISED under User Mmanagement/Companies/Registered companies)
• you have configured a billing contact
• you have configured a rate

Endpoints

The API offers two endpoints: first for providing the driver access via creating CRM contact, portal user and card (register endpoint), second for activating portal user and card (confirm endpoint).

Register Endpoint

The register endpoint creates a CRM contact, portal user, and card. The endpoint accepts the following parameters:

Request Parameters

Contact Object Parameters

User Object Parameters

Card Object Parameters

Sample Request

curl --location --request POST 'https://yourinstancename.beenergised.cloud/api/fleet/v1/register' \
    --header 'x-api-token: your_token' \
    --header 'Content-Type: application/json' \
    --data-raw '{
        "company_id": "Company UUID",
        "contact": {
            "name": "Name",
            "gender": "Gender",
            "city": "City",
            "customer_number": "Customer Number",
            "comment": "Comment"
        },
        "user": {
            "email": "Email",
            "password": "Password",
            "locale": "Locale"
        },
        "card": {
            "card_no": "Card Number",
            "rate_id": "Rate UUID",
            "billing_contact_id": "Billing Contact UUID"
        }
    }'

Sample Response

{
    "status": "success",
    "data": {
        "contact_id": "created_contact_id",
        "user_id": "created_user_id",
        "card_id": "created_card_id"
    }
}

Confirm Endpoint

The confirm endpoint activates the portal user and a card. The endpoint accepts the following parameters:

Request Parameters

Sample Request

curl --location --request PUT 'https://yourinstancename.beenergised.cloud/api/fleet/v1/confirm' \
  --header 'x-api-token: your_token' \
  --header 'Content-Type: application/json' \
  --data-raw '{
      "user_id": user_id_to_activate
      "card_id": card_id_to_activate,
  }'

Sample Response

{
    "status": "success",
    "data": {
        "user_id": "activated_user_id",
        "card_id": "activated_card_id"
    }
}