OEM Credentials⚓︎
Important
OEM Credentials are only required if you want to add Tesla, Mercedes-Benz, NIU or Segway vehicles. When adding CloudBoxx vehicles, you do not need to provide credentials. INVERS associates your purchased CloudBoxxes with your fleet automatically.
What are OEM credentials?⚓︎
The INVERS OneAPI does not only support our own CloudBoxx telematics unit, but also several telematics unit models from other vendors. Those are mostly telematics units that have already been installed into the vehicle by the vehicle’s manufacturer (the OEM).
In order to access those vehicles through the INVERS platform, you will need to add OEM credentials to your OneAPI fleet. You will typically receive those credentials from the corresponding OEM if you purchase vehicles which are already equipped with an OEM telematics unit.
Different OEMs require different forms of authentication, and therefore OEM credentials vary from one manufacturer to the other. One set of OEM credentials is typically shared by a group of vehicles (e.g., all vehicles you purchased from that particular OEM). We call these kind of credentials shared credentials. You only need to associate these credentials once with your INVERS OneAPI fleet. The OEM credentials are then safely stored and can be used for all vehicles that are associated with this set of credentials. You can subsequently add these vehicles to your fleet.
Info
In some cases each individual telematics unit requires its own password or set of credentials. This is mostly the case if a direct connection to the telematics unit via TCP is used instead of a cloud solution or OEM API. You will need to provide individual credentials for each vehicle when adding such a vehicle to your fleet. In such a case, you don’t need to provide the aforementioned shared credentials beforehand.
How to add OEM credentials⚓︎
Credentials can be added using the POST endpoint of the OEM Credentials API (see box on the right hand side). A unique identifier will be generated for all credentials. If you are adding vehicles to your fleet using the Vehicle Lifecycle API, this ID is required to tell the INVERS OneAPI which credentials to use in order to access the vehicle via the OEM / third-party API. When creating new credentials, you should also specify a name. This name has to be unique within your fleet and makes it easier for you to identify the credentials later on, for example when querying all credentials added to your fleet via the Vehicle Lifecycle API.
You can store multiple credentials for the same third-party API, e.g., Mercedes-Benz, within your fleet. By doing so, you can use vehicles that require separate credentials for the same third-party API in one single OneAPI fleet.
How to update or delete existing OEM credentials⚓︎
Some properties, e.g. the client_secret, can be updated using the PATCH endpoint of this API (see API specification). Use the DELETE endpoint in order to delete a set of credentials. You can only delete credentials if they are no longer used by any of the vehicles in your fleet.
Info
You can only update properties like the client_secret or password. Credentials with a different client_id or username are considered entirely new. Add them as described above in how to add new credentials.
Example⚓︎
The following examples shows how to add new OEM credentials. Follow instructions to get an access token first in order to retrieve a valid access token for the INVERS OneAPI.
curl -X POST \
'https://api.invers.com/telematics-brands/❰brand❱/credentials' \ # (1)!
-H 'Authorization: Bearer ❰access_token❱' \ # (2)!
-H 'Content-Type: application/json' \
-d '{
"name": "Mercedes-Benz fleet Berlin",
"client_id": "32CFA77D-3B39-4026-BED4-581F132FFFA5",
"client_name": "client1",
"client_secret": "supersecret"
}' # (3)!
- Insert the telematics brand for which you want to store credentials.
- Don’t forget to fill in your access token.
-
Please provide your credentials for the third-party API and choose a name.
You should also provide a name to identify the credentials later.
If the request has been successful, a JSON object is returned along with HTTP status code 201.
Here’s an example of what the response might look like:
1 2 3 4 5 6 7 8 | |
Tesla credentials⚓︎
Adding credentials for privately owned Tesla vehicles differs from other kinds of credentials because the owner of the Tesla has to give his consent.
Info
In case you have a Tesla business account and your Tesla vehicles are linked to that account, these Teslas are not considered “privately owned” and the process described here is not required. Please reach out to your INVERS contact on how to add such vehicles to your fleet.
When creating credentials for privately owned Teslas, you will receive a link (authorize_application_link) in the response of the POST request.
1 2 3 4 5 6 7 8 9 | |
This link has to be forwarded to the vehicle owner. The owner then clicks on the link, logs into his Tesla account and authorizes INVERS as a third party application.
As soon as this process has been completed the credentials will be marked with "authorize_application_completed": true.
Afterwards, the credentials are ready to be used. In case there are multiple vehicles linked to the Tesla account of the owner, this process is only necessary once.
Additionally, Tesla vehicles require a virtual key to be configured for executing remote commands and transmitting vehicle data. Please reach out to your INVERS contact for further information.