API de couverture de garantie d'unité
Commencer
L’API de couverture de garantie d’unité permet au concessionnaire de vérifier la couverture de garantie d’une unité avant de commencer le processus de réclamation de garantie. La demande est basée sur le numéro d’identification du véhicule (VIN) de l’unité.
Le concessionnaire peut demander l’état de la couverture de garantie 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.
La figure ci-dessous montre comment les informations sur l’état de la couverture de garantie sont présentées sur BOSSWeb. Votre DMS devrait avoir un écran similaire à BOSSWeb pour afficher les informations.
Comme indiqué dans la section Comment faire , une unité peut avoir plus d’une couverture de garantie.
👉 Si la date actuelle est avant la coverages.start_date ou après la coverages.end_date, la couverture de garantie n’est pas active.
Par où commencer ? Lisez-moi en premier !
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.
Résumé métier
Sujet | Description |
|---|---|
Portée | Unité (Amérique du Nord) |
Scénarios |
|
Fonctionnalités principales |
|
Processus opérationnels pris en charge |
|
Avantages pour les concessionnaires |
|
Avantages pour BRP |
|
Informations techniques
Caractéristiques
Type d’API | Type DSP | Version DCP | Complexité |
|---|---|---|---|
Obtenir des données du BRP | DMS | V3 - International | Faible |
Envoyer des données au BRP | CRM | V4 - Amérique du Nord | Un peu plus |
Transaction avec le 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 or v4> |
|---|---|
Production | https://cloud-api.brp.com/dcp/<v3 or v4> |
Ressource : Couverture d’Unité sous Garantie
La ressource Couverture d’Unité sous Garantie est renvoyée par l’API lorsque l’état de couverture de garantie d’une unité est demandé.
Représentation JSON
{
"serial_no": "YDV01537J718",
"overall_coverage_start_date": "2018-07-31",
"overall_coverage_end_date": "2021-07-30",
"product_code": "00013JC00",
"product_description": "",
"product_line": "PERSONAL WATERCRAFTS",
"coverages": [
{
"coverage_code": "N;V;M",
"policy_code": "B.E.S.T. Promo - PWC - 24M",
"policy_name": "B.E.S.T. Promo - PWC - 24M",
"policy_type_code": "004",
"promo_code": "06-18-PWC-CA_COV3_FIN_OR_NPFIN",
"promo_descr": "3 YEARS COVERAGE PROMO FINANCING PARTICIPATING OR NOT",
"reference_no": "0004107460",
"months": "24",
"start_date": "2019-07-31",
"end_date": "2021-07-30",
"creation_date": "2022-02-18",
"deductible_amount": 50,
"last_change_date": "2022-07-06T20:29:59Z"
},
{
"coverage_code": "N;V;M",
"policy_code": "Standard - PWC - NA - OS - 12M",
"policy_name": "Standard - PWC - NA - OS - 12M",
"policy_type_code": "002",
"promo_code": "",
"promo_descr": "",
"reference_no": "WC-1491732",
"months": "12",
"start_date": "2018-07-31",
"end_date": "2019-07-30",
"creation_date": "2022-02-18",
"deductible_amount": 0,
"last_change_date": "2022-07-06T20:29:59Z"
}
]
}Propriétés
Propriété | Type | Définition | Notes |
|---|---|---|---|
serial_no | string | Numéro de série de l’unité | Longueur max : 18 |
overall_coverage_start_date | date | Date de début de couverture globale, au format ISO 8601. | aaaa-mm-jj |
overall_coverage_end_date | date | Date de fin de couverture globale, au format ISO 8601. | aaaa-mm-jj |
product_code | string | Code identifiant de manière unique un produit. | Longueur max :18 |
product_description | string | Description du produit. | Longueur max :40 |
product_line | string | Une valeur provenant de la table Lignes de Produits ci-dessous. | Longueur max : 15 |
coverages | tableau d’objets | Liste des couvertures de garantie |
|
coverages.coverage_code | string | Code de couverture de garantie. Un à trois des codes suivants : M - Emissions d’échappement N - Emissions évaporatives V - Aucun suivi requis S’il y a plus d’un code, ils sont séparés par un « ; ». | Longueur max : 6 Exemples :
|
coverages.policy_code | string | Le code de police décrit généralement les modalités de durée de la couverture. | Longueur max : 80 |
coverages.policy_name | string | Valeur définissant les détails d’une police de couverture de garantie. | Longueur max : 50 |
coverages.policy_type_code | string | Un code de type de police figurant dans la table Code de Type de Police ci-dessous. | Longueur max : 3 |
coverages.promo_code | string | Le code promotionnel. Vide si aucun n’a été utilisé. | Longueur max : 80 |
coverages.promo_description | string | La description de la promotion. Vide si aucune promotion n’a été utilisée. | Longueur max : 255 |
coverages.reference_no | string | L’enregistrement d’inscription sous lequel cette couverture a été créée. | Longueur max : 50 |
coverages.months | string | Durée de couverture de la police pour l’unité donnée, en mois. | Longueur max : 2 |
coverages.start_date | date | Date de début de couverture de la police, au format ISO 8601. | aaaa-mm-jj |
coverages.end_date | date | Date de fin de couverture de la police, au format ISO 8601. | aaaa-mm-jj |
coverages.creation_date | date | Date de création, au format ISO 8601. | aaaa-mm-jj |
coverages.deductible_amount | number | Montant de la franchise. | Format : 16.2 |
coverages.last_change_date | date-time | Date de dernière modification de la police, au format ISO 8601 UTC. | Format : YYYY-MM-DDTHH:MM:SSZ |
Gammes 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 | Ponton | Sea-Doo |
PWC | Motomarines | Sea-Doo |
SNO | Motoneiges | Ski-Doo |
SSV | Véhicules côte à côte | Can-Am Off-Road |
Code de type de police
Code | Description |
|---|---|
001 | PDI |
002 | Standard |
003 | Garantie limitée prolongée |
004 | Promo B.E.S.T. |
005 | B.E.S.T. Détail |
006 | Goodwill |
007 | Goodwill autonomie |
008 | PA&A - 12 mois |
009 | PA&A - 24 mois |
010 | PA&A - 48 mois |
011 | PA&A - à vie |
012 | Spécial avec garantie de type Standard |
013 | Spécial avec garantie de type Étendue Limitée |
014 | Spécial avec garantie de type B.E.S.T. |
Référence de l'API
curl --location 'https://qa-cloud-api.brp.com/dcp/v4/unit/5KTWS1311JF538567/warranty-coverage' \
--header 'Dealer-Number: 0000690095' \
--header 'Authorization: Bearer REPLACE_ME'Comment faire
Cette section fournit des informations sur la manière d'obtenir des résultats spécifiques avec l'API.
Obtenir le statut de couverture de garantie
Obtention du statut de couverture de garantie d'une unité dans l'environnement de production.
curl --location 'https://cloud-api.brp.com/dcp/v4/unit/2BPSMLJB8JV000048/warranty-coverage?language=fr-CA' \
--header 'Dealer-Number: 0000691690' \
--header 'Authorization: Bearer REPLACE_ME'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 Mauvaise Requête
Le code d’état 400 est généralement observé lors du développement et de l’intégration et ne devrait pas être reçu lors d’opérations normales. La réponse renvoyée contient les informations nécessaires pour corriger le problème.
De nombreux problèmes peuvent provoquer un code d’état 400 ; les plus courants sont répertoriés dans le tableau ci-dessous.
Réponse | Résolution |
|---|---|
Numéro VIN manquant dans le chemin. {
"status": "400",
"id": "rrt-074faba1d0796ac77-c-ea-24394-1768654-1",
"title": "bad_request",
"meta": {
"service": "20",
"detail": "Chemin introuvable."
}
} | Assurez-vous que le VIN est ajouté au chemin. |
Numéro de concessionnaire 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}/warranty-coverage' 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. |
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 avec un appel à l'API d'authentification d'application.
Le code d’erreur 401 Unauthorized 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 retourné lorsque le statut de couverture de garantie n’est pas trouvé pour le NIV fourni.
{
"status": "404",
"id": "rrt-07cdd77f98c381924-d-ea-22528-1563968-1.1",
"title": "not_found",
"meta": {
"service": "20",
"detail": "No record was found for the serial number A1B2C3"
}
}Le concessionnaire a peut‑être fait une erreur en entrant le NIV, ou l’unité n’est pas un produit BRP ou est trop ancienne.
Vous devez signaler l’erreur à l’utilisateur pour lui permettre de réessayer.
Exigences DSP
Exigences fonctionnelles
ID | Type | Exigence |
|---|---|---|
1 | Obligatoire | Lorsque le code d’état 404 Not Found est renvoyé par l’API, l’erreur doit être affichée sur l’interface utilisateur. |
2 | Obligatoire | Le concessionnaire doit pouvoir visualiser l’état de la couverture de garantie d’une unité en fonction du numéro de série (VIN) de l’unité. |
Activités de certification
Cette section présente toutes les activités de certification et les validations qui doivent être effectuées pour certifier l'API.
Assurance qualité
Les tests répertoriés dans le tableau ci-dessous doivent être effectués avec succès dans l'environnement de test avant que vous puissiez commencer la phase pilote avec les concessionnaires.
ID | Test | Résultat attendu |
|---|---|---|
1 | Obtenir l’état de la couverture de garantie pour au moins 3 de ces VIN :
| Fournir des captures d’écran pour chaque VIN. Les captures doivent montrer l’intégralité des informations sur l’état de la couverture de garantie. |
Pilote concessionnaire
Le tableau ci-dessous décrit les paramètres et validations du pilote concessionnaire.
Paramètre | Valeur |
|---|---|
Environnement | Production |
Nombre de concessionnaires | 1 à 3 |
Durée | 1 semaine |
Validation 1 | Fournir des captures d'écran pour au moins 5 requêtes de couverture de garantie pour chaque concessionnaire. La capture d'écran doit afficher l'intégralité des informations sur l'état de la couverture de garantie. |
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 de Couverture de Garantie. Cet environnement Postman contient des variables utilisées par les requêtes et est configuré pour se connecter à l’environnement de test.
Collections
La collection DMS - Couverture de Garantie inclut des exemples d'appels API pour récupérer des informations sur les concessionnaires.