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.

Create a vehicle

post

Authorizations

api-key

DriveKit-Admin-API-KeystringRequired

Header parameters

DriveKit-Admin-API-KeystringRequired

DK admin token

Content-TypestringRequiredDefault: Application/json

Body

application/json

Adds a new vehicle in the database

usernamestring · min: 1Optional

Username of the vehicle's owner

vehiclenamestring · min: 1Required

Vehicle Name

vehicleIdstring · min: 1Required

Vehicle client Id

Responses

200

OK

application/json

messagestringOptional

400

Bad Request

application/json

401

Unauthorized

application/json

409

Conflict

application/json

post

/drivekit/admin/vehicle

HTTPcURLJavaScriptPython

POST /v3/drivekit/admin/vehicle HTTP/1.1
Host: service.drivequant.com
DriveKit-Admin-API-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 473

{
  "username": "[email protected]",
  "vehiclename": "John's Astra",
  "vehicleId": "18077be9-1e03-436a-87be-3827ae6522fe",
  "vehicleCharacteristics": {
    "brand": "Opel",
    "model": "Astra",
    "version": "2.2",
    "year": "2007",
    "typeIndex": 1,
    "engineIndex": 1,
    "power": 150,
    "mass": 1400,
    "engineDisplacement": 1.2,
    "gearboxIndex": 2,
    "consumption": 4.5,
    "autoGearboxNumber": 0,
    "frontTireSize": "205/55/16",
    "rearTireSize": "205/55/16",
    "length": 4.5,
    "width": 1.8,
    "height": 1.45,
    "driveWheels": 0,
    "engineCylinderNb": 4
  }
}

{
  "message": "Vehicle created successfully"
}

Request Body

The table below summarizes the content of a request body.

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

BeaconIdentifier

The table below summarizes the content of a beaconIdentifier object.

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

Body sample

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