Skip to main content

Connected Diagnosis Specification

Brancher le WebHook​

Prévoir un endpoint recevant une requête avec le verbe POST, le body (en json) est décrit dans la section suivante.

Si le endpoint est sécurisé, merci d'en informer l'équipe technique qui implémentera le nécessaire.

Exemple de body​

{
  "reportUrl": "https://myReport.com",
  "creationDate": "2024-01-31T11:00:00Z",
  "vehicle": {
    "license": "ER-368-LY",
    "brand": "Land Rover",
    "model": "Range Rover Evoque",
    "externalId": "myExternalId"
  },
  "front": {
    "left": {
      "data": {
        "reference": {
          "width": 235,
          "ratio": 60,
          "diameter": 17,
          "loadIndex": 98,
          "speedIndex": "V",
          "is3pmsf": false
        },
        "anomaly": {
          "cracks": true,
          "cut": false,
          "objects": false,
          "ageLimitExceeded": false,
          "damaged": false,
          "shoulderWear": false,
          "hernia": false
        },
        "wear": {
          "maxWearPercent": 84,
          "grooves": [
            {
              "grooveNumber": 1,
              "wearPercent": 84,
              "depth": 6.3
            },
            {
              "grooveNumber": 2,
              "wearPercent": 40,
              "depth": 3.8
            },
            {
              "grooveNumber": 3,
              "wearPercent": 40,
              "depth": 3.8
            }
          ]
        }
      },
      "report": {
        "color": "red",
        "dimension": "235/60R17 98V",
        "grooves": "1 / 2 / 3",
        "mountainLabel": "Pneu été",
        "wearPercents": "84%% / 40%% / 40%%",
        "recommendations": [
          {
            "code": "CRACKS",
            "label": "Présence de craquelures"
          },
          {
            "code": "WORN_TYRE_TO_BE_REPLACED",
            "label": "Pneu à remplacer"
          }
        ]
      }
    },
    "right": {
      "data": {
        "reference": {
          "width": 235,
          "ratio": 60,
          "diameter": 17,
          "loadIndex": 98,
          "speedIndex": "V",
          "is3pmsf": false
        },
        "anomaly": {
          "cracks": false,
          "cut": true,
          "objects": false,
          "ageLimitExceeded": false,
          "damaged": false,
          "shoulderWear": false,
          "hernia": false
        },
        "wear": {
          "maxWearPercent": 45,
          "grooves": [
            {
              "grooveNumber": 1,
              "wearPercent": 45,
              "depth": 3.6
            },
            {
              "grooveNumber": 2,
              "wearPercent": 40,
              "depth": 3.5
            },
            {
              "grooveNumber": 3,
              "wearPercent": 42,
              "depth": 3.5
            }
          ]
        }
      },
      "report": {
        "color": "red",
        "dimension": "235/60R17 98V",
        "grooves": "1 / 2 / 3",
        "mountainLabel": "Pneu été",
        "wearPercents": "45%% / 40%% / 42%%",
        "recommendations": [
          {
            "code": "CUT",
            "label": "Coupure sur le flanc"
          },
          {
            "code": "WORN_TYRE_TO_BE_REPLACED",
            "label": "Pneu à remplacer"
          }
        ]
      }
    },
    "geometryNecessary": true
  },
  "rear": {
    "left": {
      "data": {
        "reference": {
          "width": 240,
          "ratio": 55,
          "diameter": 18,
          "loadIndex": 94,
          "speedIndex": "T",
          "is3pmsf": false
        },
        "anomaly": {
          "cracks": false,
          "cut": false,
          "objects": false,
          "ageLimitExceeded": false,
          "damaged": false,
          "shoulderWear": false,
          "hernia": false
        },
        "wear": {
          "maxWearPercent": 8,
          "grooves": [
            {
              "grooveNumber": 1,
              "wearPercent": 8,
              "depth": 1.67
            },
            {
              "grooveNumber": 2,
              "wearPercent": 6,
              "depth": 1.66
            },
            {
              "grooveNumber": 3,
              "wearPercent": 4,
              "depth": 1.65
            }
          ]
        }
      },
      "report": {
        "color": "green",
        "dimension": "240/55R18 94T",
        "grooves": "1 / 2 / 3",
        "mountainLabel": "Pneu été",
        "wearPercents": "8%% / 6%% / 4%%",
        "recommendations": [
          {
            "code": "OK",
            "label": "Environ 31500 km avant usure *"
          }
        ]
      }
    },
    "right": {
      "data": {
        "reference": {
          "width": 240,
          "ratio": 55,
          "diameter": 18,
          "loadIndex": 94,
          "speedIndex": "T",
          "is3pmsf": false
        },
        "anomaly": {
          "cracks": false,
          "cut": false,
          "objects": false,
          "ageLimitExceeded": false,
          "damaged": false,
          "shoulderWear": false,
          "hernia": false
        },
        "wear": {
          "maxWearPercent": 6,
          "grooves": [
            {
              "grooveNumber": 1,
              "wearPercent": 6,
              "depth": 1.66
            },
            {
              "grooveNumber": 2,
              "wearPercent": 4,
              "depth": 1.65
            },
            {
              "grooveNumber": 3,
              "wearPercent": 2,
              "depth": 1.64
            }
          ]
        }
      },
      "report": {
        "color": "green",
        "dimension": "240/55R18 94T",
        "grooves": "1 / 2 / 3",
        "mountainLabel": "Pneu été",
        "wearPercents": "6%% / 4%% / 2%%",
        "recommendations": [
          {
            "code": "OK",
            "label": "Environ 33000 km avant usure *"
          }
        ]
      }
    },
    "geometryNecessary": false
  },
  "recommendations": [
    {
      "code": "FRONT_TYRES_TO_BE_REPLACED",
      "extractLabels": [
        {
          "label": "Les pneus avant de ce véhicule",
          "color": "OFF"
        },
        {
          "label": "ont besoin d'être remplacés",
          "color": "RED"
        }
      ]
    },
    {
      "code": "FRONT_AXLE_NEED_GEOMETRY",
      "extractLabels": [
        {
          "label": "Géométrie nécessaire",
          "color": "ORANGE"
        },
        {
          "label": "à l'avant",
          "color": "OFF"
        }
      ]
    }
  ]
}

Propriétés du body de la requête​

PropriétéNon nullTypeDescription
creationDateouiStringDate de création de l'analyse Connected Diagnosis
reportUrlouiStringUrl du rapport PDF
vehicleouiVehicleObjetContient les données du véhicule
frontouiAxleObjetInformations sur l'axe avant
rearouiAxleObjetInformations sur l'axe arrière
recommendationsouiArray[RecommendationObject]Recommendations globales

VehicleObject​

PropriétéNon nullTypeDescription
licenseouiStringPlaque d'immatriculation
externalIdnonStringCode externe passé lors de la création de l'analyse Connected Diagnosis
brandnonStringMarque du véhicule
modelnonStringModèle du véhicule

AxleObject​

PropriétéNon nullTypeDescription
leftouiStringInformations du pneu gauche
rightouiStringInformations du pneu droite
geometryNecessaryouiBooleanIndique si l'axe a besoin d'une géométrie

TyreObject​

PropriétéNon nullTypeDescription
dataouiDataObjectDonnées brutes du pneu
reportouiReportObjectDonnées calculées du rapport PDF

DataObject​

PropriétéNon nullTypeDescription
referenceouiReferenceObjectRéférences du pneumatique
wearouiWearObjectUsure du pneu
anomalyouiAnomalyObjectAnomalies du pneumatique

ReferenceObject​

PropriétéNon nullTypeDescription
widthouiIntegerLargeur
ratioouiIntegerHauteur du flanc
diameterouiIntegerDiamètre
loadIndexouiIntegerIndice de charge
speedIndexouiStringIndice de vitesse
is3pmsfouiBooleanIndique si le pneu possède le marquage 3PMSF

WearObject​

PropriétéNon nullTypeDescription
maxWearPercentouiIntegerPourcentage d'usure la plus prononcée
groovesouiArray[GrooveObject]Liste des informations par rainure

GrooveObject​

PropriétéNon nullTypeDescription
grooveNumberouiIntegerPosition de la rainure
wearPercentouiIntegerPourcentage d'usure
depthouiDoubleProfondeur restante

AnomalyObject​

PropriétéNon nullTypeDescription
cracksouiBooleanPrésence de craquelure dans les rainures
cutouiBooleanPrésence d'une coupure
objectsouiBooleanPrésence d'un objet dans la bande roulement du pneu (clou / vis / etc)
ageLimitExceededouiBooleanPneu trop agé
damagedouiBooleanBande de roulement endommagée
shoulderWearouiBooleanEpaule effondrée de la bande de roulement
herniaouiBooleanPrésence d'une hernie sur le flanc

ReportObject​

PropriétéNon nullTypeDescription
colorouiStringCode couleur du résultat
dimensionouiStringDimension du pneumatique
mountainLabelouiStringDonnées brutes du pneu
groovesouiStringPosition des rainures
wearPercentsouiStringPourcentages d'usure des rainures
recommendationsouiArray[RecommendationTyreObject]Liste des recommendations du pneu

RecommendationTyreObject​

PropriétéNon nullTypeDescription
codeouiStringCode représentant le résultat de la recommendation
labelouiStringLabel du résultat de la recommendation

RecommendationObject​

PropriétéNon nullTypeDescription
codeouiStringCode représentant le résultat de la recommendation
extractLabelsouiArray[ExtractLabelObject]Liste des labels de recommendation

ExtractLabelObject​

PropriétéNon nullTypeDescription
labelouiStringPlaque d'immatriculation
colorouiStringCode Couleur du résultat

Changelog​

DateChangelog
03/05/2024Ajout de la présence d'une anomalie de type hernie sur le flanc (see AnomalyObject)