APIs/Connected Vehicle API
APIs/Connected Vehicle API
Vehicle
List vehicles
Endpoint used to get a list of the vehicles which have active relation to the Volvo-id account for whom the request is executed.
get
https://api.volvocars.com/connected-vehicle/v1/vehicles
Scopes
openid
conve:vehicle_relation
Headers
| Key | Description |
| Key accept | Description The mediatype of what should be returned. The valid values are: application/vnd.volvocars.api.connected-vehicle.vehiclelist.v1+json |
| Key authorization | Description The access token issued by Volvo ID identity system. |
| Key vcc-api-key | Description Your application’s VCC API Key. |
All these header values are mandatory. They must exist in every request.Response body
The response’s data node provides a list of the vehicles fitting to the function’s criteria
| Field | Description |
| Field vin | Description 17 letter vehicle identification number. |
Examples
curl -v -X GET 'https://api.volvocars.com/connected-vehicle/v1/vehicles' \
-H 'accept: application/vnd.volvocars.api.connected-vehicle.vehiclelist.v1+json' \
-H 'authorization: Bearer <your-access-token>' \
-H 'vcc-api-key: <your-vcc-api-key>'Get vehicle details
Endpoint used to get some generic properties of the vehicle such as model, model year, color etc. together with one exterior and one interior image url.
get
https://api.volvocars.com/connected-vehicle/v1/vehicles/{vin}
Scopes
openid
conve:vehicle_relation
Headers
| Key | Description |
| Key accept | Description The mediatype of what should be returned. The valid values are: application/vnd.volvocars.api.connected-vehicle.vehicle.v1+json |
| Key authorization | Description The access token issued by Volvo ID identity system. |
| Key vcc-api-key | Description Your application’s VCC API Key. |
All these header values are mandatory. They must exist in every request.Response body
The response’s data node provides the details pre-defined in the endpoint’s specifications.
| Field | Description |
| Field vin | Description 17 letter vehicle identification number. |
| Field modelYear | Description Vehicle’s model year. |
| Field gearbox | Description Text describing the vehicle’s gearbox. |
| Field powerTrain | Description A code representing the vehicle’s engine. |
| Field externalColour | Description Vehicle’s exterior colour. |
| Field fuelType | Description Fuel type like Diesel, Petrol etc. |
| Field images.exteriorDefaultUrl | Description A url which provides a generic image of the vehicle’s exterior view. This url has a validity period. It should not be cached for a further usage. |
| Field images.interiorDefaultUrl | Description A url which provides a generic image of the vehicle’s interior view. This url has a validity period. It should not be cached for a further usage. |
| Field descriptions.model | Description A short text describing the model name / code. |
| Field descriptions.upholstery | Description Text describing the vehicle’s upholstery. |
| Field descriptions.bodyType | Description Text describing the vehicle’s body-type. |
| Field descriptions.salesVersion | Description Text describing the vehicle’s sales-version. |
| Field descriptions.steering | Description Vehicle’s steering wheel description. |
Examples
curl -v -X GET 'https://api.volvocars.com/connected-vehicle/v1/vehicles/{vin}' \
-H 'accept: application/vnd.volvocars.api.connected-vehicle.vehicle.v1+json' \
-H 'authorization: Bearer <your-access-token>' \
-H 'vcc-api-key: <your-vcc-api-key>'