Create a vehicle
This API must be used to create a new vehicle that will belong to your organization. After the vehicle is created, you can add the vehicleId in the trip API request to get the trip scores and data described in the trip analysis section.
We recommend to add a vehicle before requesting the trip analysis service if you need to monitor the vehicle. For each request, the unique vehicle identifier must be added in the trip analysis request.
If you have your admin API key, you can try the API via this link.
postVehicle creation
{status: true,errorCode: 0}
Field | Type | Description |
brand | string | Vehicle brand |
model | string | Vehicle model |
version | double | Model version |
year | double | Vehicle year |
typeIndex | int | |
engineIndex | int | |
power | double | Vehicle power in hp. This value must be entered in horsepower. In case you only have the engine power in kW you can apply the following formula: P [hp] = P [kW] / 0.7355 |
mass | double | Vehicle mass in kg |
engineDisplacement | double | Engine displacement in liters |
gearboxIndex | int | |
autoGearboxNumber | int | Number of gear ratios for the automatic gearbox. This parameter is taken into account only if carGearboxIndex is set to 1 |
consumption | double | Combined fuel consumption [l/100km] measured during the New European Driving Cycle (NEDC) |
frontTireSize | string | Front tire size |
rearTireSize | string | Rear tire size |
length | double | Vehicle length in meter |
width | double | Vehicle width in meter |
height | double | Vehicle height in meter |
driveWheels | int | |
engineCylinderNb | int | Number of cylinders |
Field | Type | Description |
major | int | Major |
minor | int | Minor |
proximityUuid | string | Proximity UUID |
uniqueId | string | Beacon unique identifier |
{"vehiclename": "My car","vehicleId": "<UNIQUE VEHICLE ID>","vehicleCharacteristics": {"brand": "Renault","model": "Clio 5","version": "V 1.0 SCE 65 LIFE","year": "2020","typeIndex": 2,"engineIndex": 4,"power": 65.0,"mass": 1137.0,"engineDisplacement": 1.0,"gearboxIndex": 1,"consumption": 4.82,"autoGearboxNumber": 0,"frontTireSize": "185/65/15","rearTireSize": "185/65/15","length": 4.05,"width": 1.79,"height": 1.44,"driveWheels": 0,"engineCylinderNb": 3},"username": "<UNIQUE DRIVER ID>"}
ErrorCode | Comment |
0 | Success |
1 | Invalid characteristics |
2 | The vehicle unique identifier already exists |
3 | Server error. In this case, we recommend that you try again. If the error persists, please contact [email protected] |
4 | Beacon already used |
