Endpoints
List vehicles
Provides all current valid relations between a Volvo ID (users account) and its connected vehicles.
get
https://api.volvocars.com/extended-vehicle/v1/vehicles
Scopes
openid
vehicle:attributes
Headers
| Key | Description |
Key accept | Description The mediatype of what should be returned. Valid value is: application/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
Returns a list of VIN numbers together with timestamp of relation.
| Field | Description |
Field id | Description Vehicle identifier number, usually a VIN. |
Field timestamp | Description The time when the latest value was received, the time is displayed in milliseconds. |
Examples
curl -X GET 'https://api.volvocars.com/extended-vehicle/v1/vehicles' \
-H 'accept: application/json' \
-H 'authorization: Bearer <your-access-token>' \
-H 'vcc-api-key: <your-vcc-api-key>'List vehicle resources
After receiving which vehicles are connected to the end-user, you can use the resources endpoint with an id from the previous request in order to find out which resources are available for read out on the vehicle.
get
https://api.volvocars.com/extended-vehicle/v1/vehicles/{vin}/resources
Scopes
openid
vehicle:attributes
Headers
| Key | Description |
Key accept | Description The mediatype of what should be returned. Valid value is: application/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
| Field | Description |
Field version | Description Version of this resource. |
Field name | Description Name of the resource. |
Field href | Description Url to the resource for a specific ID. |
Examples
curl -X GET 'https://api.volvocars.com/extended-vehicle/v1/vehicles/{vin}/resources' \
-H 'accept: application/json' \
-H 'authorization: Bearer <your-access-token>' \
-H 'vcc-api-key: <your-vcc-api-key>'Get resource value
After identifying which resources are available for readout you can request information about an individual resource and its value.
get
https://api.volvocars.com/extended-vehicle/v1/vehicles/{vin}/resources/{resource}
Headers
| Key | Description |
Key accept | Description The mediatype of what should be returned. Valid value is: application/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
Regardless of which resource is being requested to get information about a successfull response body will contain the following fields:
| Field | Description |
Field value | Description The value of the resource, all values are represented as textual values. |
Field unit | Description The unit of the value, note that not all values have a unit which they can be represented as. |
Field timestamp | Description The time when the latest value was received, the time is displayed in milliseconds. |
In order to retrieve the values for a resource the end-user needs to have given consent for the specific resource values to be retrieved. Otherwise the request will fail.
Example
Here is an example of how to retrieve the resource engineCoolantTemp from the vehicle.
curl -X GET 'https://api.volvocars.com/extended-vehicle/v1/vehicles/{vin}/resources/engineCoolantTemp' \
-H 'accept: application/json' \
-H 'authorization: Bearer <your-access-token>' \
-H 'vcc-api-key: <your-vcc-api-key>'