API de spécifications d'unité
Commencer
Les API des spécifications de l’unité fournissent des informations techniques pour une unité spécifique en fonction de son numéro d’identification du véhicule (VIN).
Dans le contexte du concessionnaire, l’API des spécifications de l’unité permet au concessionnaire d’accéder aux informations techniques clés directement dans votre DMS.
Le concessionnaire peut demander des informations sur n’importe quelle unité BRP en utilisant le VIN de l’unité, même si l’unité ne fait pas partie de l’inventaire du concessionnaire.
Par où commencer? Lisez-moi d’abord!
Avant de commencer à travailler sur cette API, vous devez lire les sections suivantes si vous ne les avez pas déjà consultées :
- Informations techniques pour des informations techniques générales sur l'API et les environnements.
- Authentification et informations d’identification pour des détails sur l'authentification et les identifiants.
Informations techniques
Caractéristiques
Type d’API | Type DSP | Version DCP | Complexité |
|---|---|---|---|
Obtenir des données depuis BRP | DMS | V3 - International | Faible |
Envoyer des données à BRP | CRM | V4 - Amérique du Nord | Un peu plus |
Transaction avec BRP | | | Un peu plus encore |
Authentification
L’API utilise Authentification de l’application.
Vous avez besoin d’un jeton d’accès valide avant d’appeler cette API, ou vous devez appeler l’API d'authentification d'application pour en obtenir un.
Le jeton d’accès est valable pendant 30 minutes ! (1799 secondes)
URL de base
Test | https://qa-cloud-api.brp.com/dcp/<v3 ou v4> |
|---|---|
Production | https://cloud-api.brp.com/dcp/<v3 ou v4> |
Ressource : Spécifications de l’unité
Le Spécifications de l’unité contient les informations techniques d’une unité spécifique.
Représentation JSON
{
"serial_no": "2BPSAAKX2KV000006",
"model_year": 2019,
"model_number": "000AAKX00",
"model_name": "SM EXPEDITION LE 900 ACE-E SY/B/B 1",
"model_code": "",
"brands": [
"SKIDOO"
],
"product_line": "SNO",
"product_type": "10",
"manufacturer_name": "Bombardier Recreational Products Inc.",
"color_code_description": "",
"max_no_of_passengers": null,
"engine_code": "900_ACE",
"engine_code_description": "900 ACE",
"engine_displacement": 899,
"engine_power": null,
"no_of_cylinders": 3,
"gross_weight_vehicle_rating": null,
"net_weight": 253.107,
"weight_unit": "KG",
"inventory_type": "Stock",
"status": [
"At_customer_site"
],
"last_change_date": "2022-11-10T20:34:15Z"
}Propriétés
Tous les champs numériques avec décimales utilisent le point (.) comme séparateur décimal. La virgule (,) n’est PAS prise en charge comme séparateur décimal.
Propriété | Type | Définition | Notes |
|---|
Les propriétés marquées d'une dague (†) sont renvoyées dans la langue demandée.
Veuillez noter que la propriété last_change_date peut être nulle car il est possible qu’il n’y ait aucun changement dans la propriété status.
Marques
Code | Valeur |
|---|---|
SKIDOO | Ski-Doo |
SEADOO | Sea-Doo |
LYNX | Lynx |
CANAM | Can-Am |
Lignes de produits
Clé | Valeur | Marque |
|---|---|---|
2WV | Véhicules à deux roues | Can-Am On-Road |
3WV | Véhicules à trois roues | Can-Am On-Road |
ATV | Véhicules tout-terrain | Can-Am Off-Road |
OE | Moteurs hors-bord | Sea-Doo |
PTN | Bateaux pontons | Sea-Doo |
PWC | Motomarines | Sea-Doo |
SNO | Motoneiges | Ski-Doo |
SSV | Véhicules côte à côte | Can-Am Off-Road |
Types de produits
Clé | Valeur |
|---|---|
10 | Véhicule |
20 | Moteur |
30 | Pièces |
40 | Accessoires |
50 | Vêtements |
60 | Licences et jeux |
80 | Manuels |
90 | Remorque |
100 | Reconstruit |
110 | Huiles et produits chimiques |
NA | Lorsqu’aucune correspondance ci-dessus (Indéfini) |
Limitations et contraintes
Format des nombres
Tous les champs numériques avec décimales utilisent le point(.) comme séparateur décimal. La virgule (,) n’est PAS prise en charge comme séparateur décimal.
Référence de l'API
curl --location 'https://cloud-api.brp.com/dcp/v4/unit/3JBLGAR15GJ000100/specifications?language=en-US' \
--header 'Dealer-Number: 0000700304' \
--header 'Authorization: Bearer 'REPLACE_ME' Tables de référence
Langues
Langue en code de langue ISO (ISO-639-1 + ISO 3166-1)
Format : xx-XX
xx : code de langue en minuscules
XX : code de pays en majuscules
Valeurs de codes de langue prises en charge
Code | Langue |
|---|---|
de | Allemand |
en | Anglais |
es | Espagnol |
fi | Finnois |
fr | Français |
it | Italien |
nl | Néerlandais |
no | Norvégien |
pt | Portugais (Brésil) |
sv | Suédois |
Guide pratique
Cette section fournit des informations sur la manière d’obtenir des résultats spécifiques avec l’API.
Obtenir les spécifications d’une unité
Obtenir les informations techniques d’une unité dans l’environnement de production.
curl --location 'https://cloud-api.brp.com/dcp/v4/unit/3JBLWPP10EJ000558/specifications?language=de-DE' \
--header 'Dealer-Number: 0000701404' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' Gestion des erreurs
Cette section présente divers scénarios d'appels incorrects ou erronés qui entraînent des messages d'erreur et des résultats incorrects.
400 Requête incorrecte
Le code de statut 400 est généralement observé pendant le développement et l’intégration et ne devrait pas être reçu lors d’un fonctionnement normal. La réponse renvoyée contient les informations nécessaires pour corriger le problème.
De nombreux problèmes peuvent provoquer un code de statut 400 ; les plus courants sont listés dans le tableau ci‑dessous.
Réponse | Résolution |
|---|---|
Numéro de VIN manquant dans le chemin. {
"status": "400",
"id": "rrt-074faba1d0796ac77-c-ea-24394-1768654-1",
"title": "bad_request",
"meta": {
"service": "00",
"detail": "Chemin introuvable."
}
} | Assurez-vous que le VIN est ajouté au chemin. |
Numéro de concession manquant dans l’en-tête. {
"status": "400",
"id": "rrt-07cdd77f98c381924-d-ea-22528-1563912-1",
"title": "bad_request",
"meta": {
"service": "01",
"detail": "échec de la validation de la requête",
"payload": {
"details": [
{
"message": "Le paramètre d’en-tête 'Dealer-Number' est requis sur le chemin '/unit/{VIN}/specifications' mais n’a pas été trouvé dans la requête.: []"
}
]
}
}
} | Ajoutez le paramètre d’en-tête Dealer-Number avec un numéro de concession valide. |
Retourné si le format de langue n’est pas valide. {
"status": "400",
"id": "rrt-07cdd77f98c381924-d-ea-22528-1564213-1",
"title": "bad_request",
"meta": {
"service": "01",
"detail": "échec de la validation de la requête",
"payload": {
"details": [
{
"message": "La regex ECMA 262 \"^[a-z]{2}-[A-Z]{2}$\" ne correspond pas à la chaîne d’entrée \"XX-AA\": []"
}
]
}
}
} | Le format de langue valide est le suivant Format : xx-XX xx : code de langue en minuscules XX : code pays en majuscules Un format de langue valide doit être saisi afin de produire une réponse correcte. |
Retourné si le paramètre est invalide {
"status": "400",
"id": "rrt-07783bca845d5...",
"title": "bad_request",
"meta": {
"service": "01",
"detail": "échec de la validation de la requête",
"errors": {
"details": [
{
"message": "le paramètre de requête est inattendu : lang: []"
}
]
}
}
} | Lang est un paramètre invalide. Le paramètre Language doit être fourni afin d’obtenir une réponse valide. |
401 Non autorisé
Le code d’erreur 401 Non autorisé est renvoyé lorsque vous tentez d’appeler l’API avec un access_token expiré.
Vous devez obtenir un nouveau access_token en appelant l’API API d'authentification d'application.
Le code d’erreur 401 Non autorisé est également renvoyé si vous n’avez pas demandé l’accès à l’API en créant un ticket dans le Jira du DCP.
Lorsque vous êtes prêt à commencer à travailler sur une API, vous devez créer un ticket de certification dans Jira, comme décrit dans la section Activités de certification avec Jira.
Si vous avez déjà commencé à travailler sur une API et perdu l’accès, créez un ticket de support comme décrit dans la section Ouvrir un ticket de support.
404 Introuvable
Le code d’état 404 Introuvable est renvoyé lorsque le VIN est introuvable.
{
"status": "404",
"id": "rrt-07cdd77f98c381924-d-ea-22528-1563968-1.1",
"title": "not_found",
"meta": {
"service": "02",
"detail": "No record was found for the serial number A1B2C3"
}
}Le concessionnaire a peut-être fait une erreur en saisissant le NIV, ou l’unité n’est pas un produit BRP ou est trop ancienne.
Vous devez signaler l’erreur à l’utilisateur pour qu’il puisse réessayer.
Exigences DSP
Exigences fonctionnelles
ID | Type | Exigence |
|---|---|---|
1 | Obligatoire | Lorsque l’API renvoie le code de statut 404 Introuvable, l’erreur doit être affichée sur l’interface utilisateur. |
2 | Obligatoire | Le concessionnaire doit pouvoir visualiser les spécifications d’une unité en fonction du numéro de série (VIN). |
Activités de certification
Cette section présente toutes les activités de certification et les validations qui doivent être complétées pour certifier l’API.
Assurance qualité
Les tests répertoriés dans le tableau ci‑dessous doivent être réalisés avec succès dans l’environnement de test avant que vous puissiez commencer la phase pilote concessionnaire.
ID | Test | Résultat attendu |
|---|---|---|
1 | Obtenir les spécifications techniques pour le NIV 3JBLGAP60MJ000001 (ATV) en utilisant la langue de votre concessionnaire | Les informations techniques sont affichées sur l’interface utilisateur. |
2 | Obtenir les spécifications techniques pour le NIV YDV00054F021 (PWC) en utilisant la langue de votre concessionnaire | Les informations techniques sont affichées sur l’interface utilisateur. |
3 | Obtenir les spécifications techniques pour le NIV 2BXNBDD10MV000013 (3WV) en utilisant la langue de votre concessionnaire | Les informations techniques sont affichées sur l’interface utilisateur. |
4 | Obtenir les spécifications techniques pour le NIV 3JBVXAV27MK000001 (SSV) en utilisant la langue de votre concessionnaire | Les informations techniques sont affichées sur l’interface utilisateur. |
5 | Obtenir les spécifications techniques pour le NIV YH2LLGNC9NR000595 (SNO) en utilisant la langue de votre concessionnaire | Les informations techniques sont affichées sur l’interface utilisateur. |
6 | Obtenir les spécifications techniques pour le NIV YH2STML51LR0001 (SNO) en utilisant la langue de votre concessionnaire | Le code d’état 404 Non trouvé est renvoyé et vous affichez l’erreur sur l’interface utilisateur. |
Pilote Distributeur
Le tableau ci-dessous décrit les paramètres et validations du pilote distributeur.
Paramètre | Valeur |
|---|---|
Environnement | Production |
Nombre de distributeurs | 1 à 3 |
Durée | 1 semaine |
Validation 1 | Demander aux distributeurs de solliciter les informations techniques pour une unité de chaque ligne de produit. Capturer l’écran avec les informations affichées et l’envoyer à l’équipe DCP. |
Postman
Cette section décrit ce qui est disponible dans Postman pour explorer l’API.
Environnements
Un environnement Postman est disponible pour essayer l’API des Spécifications d’Unité. Cet environnement Postman contient des variables utilisées par les requêtes et configurées pour se connecter à l’environnement de test.
Collections
La collection DMS - Spécifications d’Unité comprend des exemples d’appels API pour récupérer des informations sur les véhicules.