Fleet Clearance
By using the Fleet Clearance API endpoints, it's possible for fleet operators to activate and deactivate data access to their vehicles. The raw Swagger specification is available at https://github.com/highmobility/open-api-specifications/blob/main/hm-fleet-clearance-v1.yml
Get the status of VINs that have previously been registered for data access clearance.
- : fleet clearance
URL Encoded JSON
{"summary":"Filter by VIN - Equality","value":{"vin":{"operator":"eq","value":"EXVETESTVIN000001"}}}Success
Vehicle Identification Number (VIN)
When an invalid ServiceAccountToken is used.
When the application doesn't have fleet access.
The client has sent too many requests in a given amount of time. Please wait before retrying. There is no rate limit enforced at this moment for this endpoint, but we reserve the right to enable it if necessary. Please use this API moderately and avoid bursts of calls within a few seconds.
Server Errors
GET /v1/fleets/vehicles HTTP/1.1
Host: api.high-mobility.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"vin": "VIN0TESTVIN000000",
"status": "approved",
"brand": "mercedes-benz",
"tags": {
"foo": "bar",
"bar": "baz"
},
"changelog": [
{
"timestamp": "2022-03-22T09:36:51",
"status": "pending"
},
{
"timestamp": "2022-03-22T10:36:51",
"status": "approved"
}
]
}
]- : fleet clearance
Success
When an invalid ServiceAccountToken is used.
When the application doesn't have fleet access.
Invalid Input. It occurs when the payload is missing a params or the the application is not configured.
The client has sent too many requests in a given amount of time. Please wait before retrying. There is no rate limit enforced at this moment for this endpoint, but we reserve the right to enable it if necessary. Please use this API moderately and avoid bursts of calls within a few seconds.
Server Errors
POST /v1/fleets/vehicles HTTP/1.1
Host: api.high-mobility.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 259
{
"vehicles": [
{
"vin": "WBADT43452G296403",
"brand": "mercedes-benz",
"tags": {}
},
{
"vin": "WBADT43452G296404",
"brand": "bmw",
"tags": {}
},
{
"vin": "VIN012345678901234",
"brand": "ds",
"tags": {}
},
{
"vin": "VIN01234567890123",
"brand": "unknown",
"tags": {
"foo": "bar",
"bar": "baz"
}
}
]
}{
"vehicles": [
{
"vin": "WBADT43452G296403",
"status": "pending",
"tags": {}
},
{
"vin": "WBADT43452G296404",
"status": "pending",
"tags": {
"foo": "bar",
"bar": "baz"
}
},
{
"vin": "VIN012345678901234",
"status": "error",
"description": "vin should be 17 character(s)"
},
{
"vin": "VIN0123456789012",
"status": "error",
"description": "The brand is invalid"
}
]
}Get the status of a VIN that has previously been registered for data access clearance.
- : fleet clearance
VIN of the vehicle in question.
Success
Vehicle Identification Number (VIN)
When an invalid ServiceAccountToken is used.
When the application doesn't have fleet access.
Given resource not found
The client has sent too many requests in a given amount of time. Please wait before retrying. This endpoint allows up to 60 calls per minute per application.
Server Errors
GET /v1/fleets/vehicles/{vin} HTTP/1.1
Host: api.high-mobility.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"vin": "text",
"status": "approved",
"brand": "bmw",
"changelog": [
{
"timestamp": "text",
"status": "approved",
"reason": "text"
}
],
"tags": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}Delete the clearance for the given VIN. If the vehicle is in approved state, a revoke is performed. If the clearance is in pending state, the activation process is canceled. The cancelation is currently supported for Mercedes-Benz, Volkswagen, Audi, Skoda, SEAT, CUPRA and the Stellantis brands.
- : fleet clearance
VIN of the vehicle in question.
Success
Vehicle Identification Number (VIN)
When an invalid ServiceAccountToken is used.
When the application doesn't have fleet access.
Given resource not found
When deleting a clearance with given VIN is not possible.
When cancellation is not possible at this moment.
The client has sent too many requests in a given amount of time. Please wait before retrying. There is no rate limit enforced at this moment for this endpoint, but we reserve the right to enable it if necessary. Please use this API moderately and avoid bursts of calls within a few seconds.
Server Errors
DELETE /v1/fleets/vehicles/{vin} HTTP/1.1
Host: api.high-mobility.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"vin": "VIN0TESTVIN000000",
"status": "revoking",
"tags": {
"foo": "bar",
"bar": "baz"
}
}Deprecated: use DELETE /v1/fleet/vehicles/{vin} end point instead
- : fleet clearance
VIN of the vehicle in question.
Bearer token
Vehicle Identification Number (VIN)
An access token can be retrieved for the FleetVin if the status is "approved"
Optional description of the VIN
Server Errors
POST /v1/fleets/{vin}/cancel_activation HTTP/1.1
Host: api.high-mobility.com
Authorization: text
Accept: */*
{
"vin": "WBADT43452G296403",
"status": "pending",
"tags": {
"foo": "bar",
"bar": "baz"
}
}Creates an access token for a VIN that has the "approved" state. This access token can be used to retrieve car data through any of the SDKs or the REST API.
- : fleet clearance
Success
Access Tokens
Date and Time in ISO8601 format example: '2018-11-06T10:20:37.094533Z'
Date and Time in ISO8601 format example: '2018-11-06T10:20:37.094533Z'
Token type
List of scopes
Refresh token
Expiration time in seconds
Access token
Error
When an invalid ServiceAccountToken is used.
When the application doesn't have fleet access.
Server Errors
POST /v1/fleets/access_tokens HTTP/1.1
Host: api.high-mobility.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"token_type": "bearer",
"scope": "diagnostics.get.mileage door_locks.get.locks windows.get.windows_positions",
"refresh_token": "7f7a9be0-04c9-4202-a59f-35d55079b6ba",
"expires_in": 600,
"access_token": "a50e89e5-093c-4727-8101-4c6e81addabe"
}Last updated
Was this helpful?