Create

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.

Vehicle creation

POST https://service.drivequant.com/v3/drivekit/admin/vehicle

Create a new vehicle belonging to your organisation.

Headers

Name	Type	Description
DriveKit-Admin-API-Key	string	Admin API Key

Request Body

Name	Type	Description
username	string	Unique driver identifier
beaconIdentifier	object	Parameters of the beacon linked to the vehicle
vehicleId	string	Vehicle unique identifier
vehicleCharacteristics	object	Characteristics of the vehicle
vehiclename	string	Vehicle name

200

{
	status: true, 
  errorCode: 0
}

Request

beaconIdentifier

Field	Type	Description
major	int	Major
minor	int	Minor
proximityUuid	string	Proximity UUID
uniqueId	string	Beacon unique identifier

Example of JSON body request

{
	"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>"	
}

Error codes

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