FAQ
In this section, you’ll find answers to some of the most common questions.
How do I access the API?
Once your account is setup, the API can be accessed via the following domain pattern.
https://[MANDANT SLUG].v2.api.htb.services (e.g. https://community.v2.api.htb.services)
Should you be using a URL that does not match this pattern, we strongly advise you to do switch URLs to ensure accessability.
What is a session token?
A session token is a user-based identifier which is needed for API authorization. It is generated when a user successfully logs in using the initSession operation.
What is a refresh token?
The refresh token is used to prolong a user-session after it has expired. See refreshSession API call.
How long is a session token valid?
It has a lifetime of 60 minutes.
What is an access token?
The access token is a JWT with claims defined by the OpenId standard and is the equivalent to a session token. Its lifetime is defined by the “exp” (expiration time) claim.
Can one user have multiple sessions?
This depends on the Authentication mechanism. It’s possible when using the OpenId approach.
Is there a way to get the data of all users of a mandant?
No, there isn’t. Each user-session only has the permission level to get data related to the contact it belongs to.
What statuses can a charging session have?
started
waiting_for_transaction
roaming_start
roaming_waiting_for_transaction
stopped
What does the error message “Couldn’t fetch email configuration” during user registration mean?
This means that the API is not configured correctly. Please contact our support team.
Does the email address used to register a user need confirmation?
No, it doesn’t.
Are there any character restrictions for user passwords?
No, you can use any characters you want.
How up-to-date is data on ongoing charging sessions?
The data is live, so data can be retrieved as soon as we receive it from the charging station.
What do I have to do to use Auth0?
If you want to use Auth0 as the authentication mechanism, please contact our support team.
What happens if a charging session is remotely stopped twice?
This is not an issue: the first remote stop will stop the charging session. Another remote stop will not have any effect if charging has already been stopped.
Why does the value for CO2 savings for a charging session remain at zero?
This will most likely mean that a configuration is not set as expected in be.ENERGISED. Please contact our support or project management team. They will assist you in setting up the CO2 savings configuration.
Why are the costs for a charging session zero, even if the vehicle is charging?
Most of the time, this issue occurs because the charging rate (tariff) doesn’t have any costs configured. You can define energy-based or time-based charging costs in be.ENERGISED. If neither is configured, there will be no cost calculted for charging processes.
Why are the detailed cost items for a charging session empty?
We provide detailed information about charging costs. If this is missing for a certain charging session, you may have not configured the international taxes for your client in be.ENERGISED.
What happens during a remote start?
The remote start operation is a trigger to post a request for a charging process to be initiated at a charging station i.e. connector. However, the charging stations will of its volition, process the request and send be.ENERGISED a REMOTE_START_TRANSACTION message if it starts the charging process.
There are many factors that influence a remote start, so only a rough overview can be given of the operations involved on be.ENERGISED’s side (in particular order):
Check if the charging process will be initialized via the community roaming network.
Resolve applicable rate and payment details.
Resolve connector and CP
Initialize CDR
Send charging request to CP
CP processes remote start request
CP lets be.ENERGISED know that the remotely triggerd charging process has started.
Sending of meter value begins
What are possible error codes when triggering a remote start?
When a remote start is triggered and successfully started, the status code is 200. The status is “ok” and you will receive the message “Charging successfully started”. If an error occurs during remote start, GraphQL responds with status code 405 and status “Error” with the message “Charging could not be started. The charging station has rejected the request”.
What alternatives do I have when the charging process is stuck at waiting_for_start_transaction?
After five minutes you can start a new remote start transaction because the old one gets closed.
Why do we have a dependency on the station as well?
It may happen that the charging station doesn’t have an internet connection. As a result, be.ENERGISED will not receive any updates from the charging station. As soon as the charging station is online again, station updates will be sent.
What are Cost Items?
For a thorough introduction and setup guide, please refere to our knowledge base article.
Why does a station not appear even if it’s configured?
Please make sure that the following prerequisites and configurations are set:
An EMP tarif is applied to the station
The marketing display option needs to be set to one of the visibility states.
The user querying the station has a compatible contract