Tyre Scanner Specifications
Connect the WebHook
Provide an endpoint that receives a request with the POST
verb, the body (in JSON) is described in the following
section.
If the endpoint is secure, please inform the technical team who will implement the necessary code.
Exemple de body
{
"creationDate": "2023-11-23T17:38:16.720Z",
"vehicle": {
"license": "FY-856-SQ",
"externalId": "123456",
"maker": "SEAT",
"model": "Arona"
},
"isProcessingCompleted": true,
"frontAxle": {
"mountedTyreInfos": {
"brandName": "Uniroyal",
"productName": "AllSeasonMax",
"season": "AllSeasons"
},
"originalEquipmentDimension": {
"width": 235,
"ratio": 65,
"isZr": false,
"diameter": 16,
"loadIndex": 115,
"speedIndex": "R"
}
},
"rearAxle": {
"mountedTyreInfos": {
"brandName": "Uniroyal",
"productName": "AllSeasonMax",
"season": "AllSeasons"
},
"originalEquipmentDimension": {
"width": 235,
"ratio": 65,
"isZr": false,
"diameter": 16,
"loadIndex": 115,
"speedIndex": "R"
}
}
}
Request body properties
Property | Not null | Type | Description |
---|---|---|---|
creationDate | yes | String | Analysis creation date |
vehicle | yes | VehicleObjet | Contains vehicle data |
isProcessingCompleted | yes | Boolean | Information relating to the processing status |
frontAxle | no | AxleObject | Front axle information |
rearAxle | no | AxleObject | Rear axle information |
VehicleObject
Property | Not null | Type | Description |
---|---|---|---|
license | yes | String | Vehicle registration number |
externalId | no | String | External code passed during tyre scanner analysis creation |
maker | no | String | Vehicle Brand |
model | no | String | Vehicle model |
AxleObject
Property | Not null | Type | Description |
---|---|---|---|
mountedTyreInfos | no | MountedTyreInfosObject | Tyre data |
originalEquipmentDimension | no | OriginalEquipmentDimension | Data about mounting recommendation |
MountedTyreInfosObject
Property | Not null | Type | Description |
---|---|---|---|
brandName | no | String | Tyre brand |
productName | no | String | Tyre model |
season | no | String | Tyre season |
OriginalEquipmentDimensionObject
Property | Not null | Type | Description |
---|---|---|---|
width | no | Integer | Tyre width |
ratio | no | Integer | Tyre ratio |
isZR | no | Boolean | Is Tyre ZR or not (R is no) |
diameter | no | Integer | Rim diameter |
loadIndex | no | Integer | Tyre load index |
speedIndex | no | Integer | Tyre speed index |