API des promotions
Bien démarrer
L'API Promotions permet au concessionnaire d'obtenir les promotions disponibles pour une unité par son numéro de série (VIN) ou son numéro de modèle.
👉 Dans la version actuelle, seules les promotions unit sont disponibles. Dans une future version de l'API, les promotions PA&A devraient être disponibles.
Les promotions disponibles sur un modèle d’unité sont documentées à travers des bulletins de promotion qui contiennent une ou plusieurs promotions.
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 plus de détails sur l'authentification et les identifiants.
Résumé de l'entreprise
Sujet | Description |
|---|---|
Portée | Unité en Amérique du Nord dans DMS et CRM |
Scénarios |
|
Fonctionnalités principales |
|
Processus métier pris en charge |
|
Avantages pour les concessionnaires |
|
Avantages pour BRP |
|
Informations techniques
Caractéristiques
Type d'API | Type de DSP | Version DCP | Complexité |
|---|---|---|---|
Obtenir des données de BRP | DMS | V3 - International | Faible |
Envoyer des données à BRP | CRM | V4 - Amérique du Nord | Un peu plus |
Transaction avec BRP | | | Quelque peu plus |
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 API d'authentification d'application pour en obtenir un.
Le jeton d'accès est valide pendant 30 minutes ! (1799 secondes)
URL de base
Test | https://qa-cloud-api.brp.com/dcp/v4 |
|---|---|
Production | https://cloud-api.brp.com/dcp/v4 |
Ressource : Promotions
Lorsqu’elle est appelée pour demander les promotions pour un numéro de série (VIN) ou un numéro de modèle, l’API Promotions renvoie une ressource Promotions.
Représentation JSON
{
"module_number": "00029RA00",
"model_name": "PWC GTI SE 130 BE IBR 24",
"bulletins": [
{
"bulletin_code": "02-23-BRP-UNT-CA",
"bulletin_description": "B.E.S.T. SALESPERSON REWARD (SPIFF) PROG",
"date_until_reserved": "2023-04-01",
"date_until_consumed": "2024-01-31",
"is_stackable": true,
"is_pre_order": false,
"promotions": [
{
"promotion_category": "Immediate",
"promotion_deposit_amount": 0.00,
"promotion_code": "0000000387",
"promotion_types": [
{
"promotion_type": "11",
"component_description": "50$ SPIFF CONTINGENT ON 2 YEAR BEST SALE",
"benefit_promo_code": "02-23-BRP-UNT-CA_SPIFF50"
}
]
}
]
},
{
"bulletin_code": "01-24-PWC-UNT-CA",
"bulletin_description": "2024 Sea-Doo PWC Pre-Order Sales Event",
"date_until_reserved": "2024-03-31",
"date_until_consumed": "2024-06-30",
"is_stackable": true,
"is_pre_order": false,
"promotions": [
{
"promotion_category": "Certificate",
"promotion_deposit_amount": 500.00,
"promotion_code": "0000000976",
"promotion_types": [
{
"promotion_type": "04",
"component_description": "2Y + $250 OFF $1,000 IN ACCESSORIES / 2A + 250 $ DE RABAIS SUR UN ACHAT DE 1 000 $ D'ACCESSOIRES",
"benefit_promo_code": "01-24-PWC-UNT-CA_COV2_ACCESSORIES"
}
]
}
]
}
]
},Propriétés
Property | Type | Definition | Note |
|---|---|---|---|
model_number | string | Code that uniquely identifies a unit model. | Length: 9 |
model_name | string | The model description. | |
bulletins | List of objects | List of bulletins. | |
bulletins.bulletin_code | string | Bulletin number. | Max Length: 15 |
bulletin.bulletin_description | string | Bulletin description. | |
bulletins.date_until_reserved | datetime | Promotion start date, in ISO 8601 format. | Format: YYYY-MM-DDTHH:MM:SSZ |
bulletins.date_until_consumed | datetime | Promotion end date, in ISO 8601 format. | Format: YYYY-MM-DDTHH:MM:SSZ |
bulletins.is_stackable | boolean | Indicates if the promotion types are stackable (AND) or not stackable (OR). In the first case, the dealer can select more than one promotion bulletin. | |
bulletins.is_pre_order | boolean | Indicates if the promotion is applicable for pre-order. | |
bulletins.promotions | List of objects | List of promotions. | |
bulletins .promotions .promotion_category | string | Promotion category, one of the following values:
| Max Length: 18 |
bulletins .promotions .promotion_deposit_amount | string | Amount of the deposit required to reserve a promotion. | |
Bulletins .promotions .promotion_code | string | Promotion code (agreement code). | Max Length: 10 |
bulletins .promotions .promotion_types | List of object | List of promotion types. | |
bulletins .promotions .promotion_types .promotion_type | string | Promotion type. One of the values from the Promotion Types table below. | Max Length: 2 |
bulletins .promotions .promotion_types .component_description | string | Component description. | |
bulletins .promotions .promotion_types .benefit_promotion_code | string | Benefit promotion code. | Max Length: 18 |
Types de promotions
Code | Description |
|---|---|
01 | Rabais en argent |
02 | Couverture prolongée |
03 | Financement au détail |
04 | Rabais en argent et couverture prolongée |
05 | Rabais en argent et financement au détail |
06 | Couverture prolongée et financement au détail |
07 | Rabais en argent, couverture et financement au détail |
08 | Argent au lieu de mises à niveau |
09 | Argent au lieu d’accessoires et de vêtements |
10 | Montant du dépôt |
11 | SPIFF (incitatifs ou primes de vente à court terme) |
12 | Argent au lieu de mises à niveau et de couverture prolongée |
13 | Argent au lieu d’accessoires et de vêtements + couverture prolongée |
14 | Démo |
Limitations et contraintes
Promotions pour l'unité
Dans cette version, l'API Promotions renvoie uniquement les promotions liées aux ventes à l'unité.
Comprendre les promotions
Cette section fournit plus d’informations sur la structure des promotions et la manière dont elles sont affichées dans BOSSWeb.
👉 Gardez à l’esprit que les promotions sont propres au concessionnaire et évoluent au fil du temps.
Elles sont propres au concessionnaire parce qu’une promotion peut être valable uniquement pour certaines régions, par exemple, la côte ouest des États-Unis.
Bulletins de promotion
Les informations renvoyées par l’API Promotions sont une liste de résumés de promotions résumés documentés dans les bulletins de promotion. L’API Promotions ne renvoie pas la documentation complète de la promotion : le concessionnaire doit aller sur BOSSWeb pour récupérer les documents de promotion selon ses besoins.
👉Les concessionnaires savent comment utiliser les informations renvoyées par l’API Promotions puisqu’il s’agit des mêmes informations affichées dans BOSSWeb.
Plus d’un bulletin de promotion peut être actif en même temps pour un numéro de modèle. Dans certains cas, le concessionnaire peut sélectionner plus d’un bulletin de promotion selon la propriété is_stackable .
Un bulletin de promotion contient une ou plusieurs promotions. Lorsqu’il y a plus d’une promotion dans un bulletin, le concessionnaire doit en sélectionner une.
Scénarios de promotions
Cette section présente différents scénarios de promotion. Pour chacun, la charge utile JSON de l’API Promotions est présentée avec l’affichage correspondant dans BOSSWeb.
Votre DSP devrait avoir un écran similaire à celui présenté dans les captures d’écran BOSSWeb pour afficher les promotions.
👉 Les exemples ont été réalisés pour le concessionnaire 0000694307 le 5 juillet 2024, dans l’environnement de production.
Si vous appelez l’API Promotions au moment où vous lisez ceci, vous obtiendrez une liste différente de promotions.
Un bulletin avec une promotion
La charge utile ci‑dessous montre les promotions pour le modèle 0003CNA00. Il n’y a qu’un seul bulletin contenant une promotion.
{
"model_number": "0003CNA00",
"model_name": "ATV DS 90-4ST 90 RD 22",
"bulletins": [
{
"bulletin_code": "12-24-ORV-UNT-US",
"bulletin_description": "BUY ONE ATV/SSV,GET $500 OFF A YOUTH ATV",
"date_until_reserved": "2024-06-01",
"date_until_consumed": "2024-07-31",
"is_stackable": true,
"is_pre_order": false,
"promotions": [
{
"promotion_category": "Authorization Code",
"promotion_deposit_amount": "0.00",
"promotion_code": "0000002097",
"promotion_types": [
{
"promotion_type": "01",
"component_description": "BUY ONE ADULT ORV GET $500 ON A YOUTH MODEL (250$ CREDIT PER UNIT)",
"benefit_promotion_code": ""
}
]
}
]
}
]
}L’affichage BOSSWeb est le suivant.

Deux bulletins avec une promotion
La charge utile pour le modèle 0002WNA00 contient 2 bulletins et chacun contient une promotion.
Tous les bulletins de promotion ont la propriété is_stackable définie à true, ce qui signifie que le concessionnaire peut sélectionner une promotion parmi tous les bulletins de promotion, comme indiqué par le AND entre les bulletins de promotion sur l’écran BOSSWeb.
{
"model_number": "0002WNA00",
"model_name": "ATV OUTL DPS 450 GY 22",
"bulletins": [
{
"bulletin_code": "01-24-BRP-UNT-US",
"bulletin_description": "B.E.S.T. SALESPERSON REWARD (SPIFF)",
"date_until_reserved": "2024-02-01",
"date_until_consumed": "2025-01-31",
"is_stackable": true,
"is_pre_order": false,
"promotions": [
{
"promotion_category": "Immediate",
"promotion_deposit_amount": "0.00",
"promotion_code": "0000001707",
"promotion_types": [
{
"promotion_type": "11",
"component_description": "50$ SPIFF CONTINGENT ON 2 YEAR BEST SALE",
"benefit_promotion_code": ""
}
]
}
]
},
{
"bulletin_code": "12-24-ORV-UNT-US",
"bulletin_description": "BUY ONE ATV/SSV,GET $500 OFF A YOUTH ATV",
"date_until_reserved": "2024-06-01",
"date_until_consumed": "2024-07-31",
"is_stackable": true,
"is_pre_order": false,
"promotions": [
{
"promotion_category": "Authorization Code",
"promotion_deposit_amount": "0.00",
"promotion_code": "0000002097",
"promotion_types": [
{
"promotion_type": "01",
"component_description": "BUY ONE ADULT ORV GET $500 ON A YOUTH MODEL (250$ CREDIT PER UNIT)",
"benefit_promotion_code": ""
}
]
}
]
}
]
}L’affichage BOSSWeb montre que le concessionnaire peut sélectionner les 2 promotions puisqu’il y a un ET entre les 2 bulletins.

Bulletins multiples avec promotions multiples
La charge utile pour le modèle 000G1RA00 montre que le concessionnaire peut sélectionner des promotions provenant des 3 bulletins puisque la propriété is_stackable est définie à true.
Le concessionnaire peut sélectionner :
- Une promotion du bulletin de compensation Apple CarPlay.
- La promotion du bulletin B.E.S.T. RÉCOMPENSE DU VENDEUR (SPIFF).
- Une promotion du bulletin Expérience Can-Am (Arrêts corporatifs).
{
"model_number": "000G1RA00",
"model_name": "RD SPYDER RT LTD 1330 SE6 GY DRK 24",
"bulletins": [
{
"bulletin_code": "10-24-3WV-UNT-US",
"bulletin_description": "Apple CarPlay Compensation",
"date_until_reserved": "2023-08-20",
"date_until_consumed": "2024-10-31",
"is_stackable": true,
"is_pre_order": false,
"promotions": [
{
"promotion_category": "Immediate",
"promotion_deposit_amount": "0.00",
"promotion_code": "0000002114",
"promotion_types": [
{
"promotion_type": "02",
"component_description": "APPLE CARPLAY COMP. 1Y EXTRA COV",
"benefit_promotion_code": ""
},
{
"promotion_type": "01",
"component_description": "500$(375$ DEALER CREDIT) APPLE CARPLAY COMP.",
"benefit_promotion_code": ""
}
]
}
]
},
{
"bulletin_code": "01-24-BRP-UNT-US",
"bulletin_description": "B.E.S.T. SALESPERSON REWARD (SPIFF)",
"date_until_reserved": "2024-02-01",
"date_until_consumed": "2025-01-31",
"is_stackable": true,
"is_pre_order": false,
"promotions": [
{
"promotion_category": "Immediate",
"promotion_deposit_amount": "0.00",
"promotion_code": "0000001707",
"promotion_types": [
{
"promotion_type": "11",
"component_description": "50$ SPIFF CONTINGENT ON 2 YEAR BEST SALE",
"benefit_promotion_code": ""
}
]
}
]
},
{
"bulletin_code": "05-24-3WV-UNT-US",
"bulletin_description": "Can-Am Experience (Corporate Stops)",
"date_until_reserved": "2024-03-01",
"date_until_consumed": "2024-07-31",
"is_stackable": true,
"is_pre_order": false,
"promotions": [
{
"promotion_category": "PIN Code",
"promotion_deposit_amount": "0.00",
"promotion_code": "0000001801",
"promotion_types": [
{
"promotion_type": "01",
"component_description": "500$ CASH REBATE",
"benefit_promotion_code": ""
},
{
"promotion_type": "09",
"component_description": "500$ IN PA&A (CREDIT OF 400$) - PENDING CLAIM SUBMISSION",
"benefit_promotion_code": ""
}
]
}
]
}
]
}L’écran BOSSWeb est comme ceci. Notez le ET entre les bulletins et le OU entre les promotions dans le premier et le dernier bulletin.

Bulletins non empilables
La charge utile pour le modèle 000MXSD00 montre un exemple de bulletins non empilables puisque la propriété is_stackable est définie sur false.
Cela signifie que le concessionnaire doit sélectionner soit une promotion du premier bulletin (SNO MY25 TEST) ou une promotion du dernier bulletin (RÉCOMPENSE DU MEILLEUR VENDEUR (SPIFF)).
{
"model_number": "000MXSD00",
"model_name": "SM MXZ XRS 850 YL 129 1.2RS HUB 25",
"bulletins": [
{
"bulletin_code": "01-25-SNO-UNT-TEST",
"bulletin_description": "SNO MY25 TEST",
"date_until_reserved": "2024-07-06",
"date_until_consumed": "2024-12-31",
"is_stackable": false,
"is_pre_order": false,
"promotions": [
{
"promotion_category": "Certificate",
"promotion_deposit_amount": "1000.00",
"promotion_code": "0000002421",
"promotion_types": [
{
"promotion_type": "02",
"component_description": "3 YEAR COVERAGE/3 ANS DE GARANTIE",
"benefit_promotion_code": ""
},
{
"promotion_type": "06",
"component_description": "3 YEAR COVERAGE+ SECURE RATE/3 ANS DE GARANTIE+SÉCURISER VOTRE TAUX",
"benefit_promotion_code": ""
},
{
"promotion_type": "01",
"component_description": "1000$ IN PA&A (800$ CREDIT) PENDING CLAIM/1000$ EN PAV(CRÉDIT DE 800$) AVEC REQUÊTE",
"benefit_promotion_code": ""
},
{
"promotion_type": "05",
"component_description": "1000$ IN PA&A (800$ CREDIT)WITH CLAIM+SECURED RATE/1000$ PAV(CRÉDIT 800$) AVEC REQUÊTE+SÉCUR TAUX",
"benefit_promotion_code": ""
},
{
"promotion_type": "06",
"component_description": "3 YEAR COVERAGE+ SECURE RATE/3 ANS DE GARANTIE+SÉCURISER VOTRE TAUX",
"benefit_promotion_code": ""
},
{
"promotion_type": "05",
"component_description": "1000$ IN PA&A (800$ CREDIT)WITH CLAIM+SECURED RATE/1000$ PAV(CRÉDIT 800$) AVEC REQUÊTE+SÉCUR TAUX",
"benefit_promotion_code": ""
}
]
}
]
},
{
"bulletin_code": "01-24-BRP-UNT-US",
"bulletin_description": "B.E.S.T. SALESPERSON REWARD (SPIFF)",
"date_until_reserved": "2024-02-01",
"date_until_consumed": "2025-01-31",
"is_stackable": true,
"is_pre_order": false,
"promotions": [
{
"promotion_category": "Immediate",
"promotion_deposit_amount": "0.00",
"promotion_code": "0000001707",
"promotion_types": [
{
"promotion_type": "11",
"component_description": "50$ SPIFF CONTINGENT ON 2 YEAR BEST SALE",
"benefit_promotion_code": ""
}
]
}
]
}
]
}L’écran BOSSWeb affiche un OU entre les bulletins, ce qui signifie qu’ils ne sont pas cumulables.

Promotions avec VIN
L’API Promotion fournit un service pour obtenir les promotions d’un VIN. La charge utile retournée fonctionne exactement comme les appels avec un numéro de modèle.
Par exemple, cet appel :
curl --location 'https://cloud-api.brp.com/dcp/v4/unit/2BXNBDD24RV001472/promotions?usage_code=REC_01' \
--header 'Dealer-Number: 00006943075' \
--header 'Authorization: Bearer REPLACE_ME'Renvoie la charge utile suivante :
{
"model_number": "000G1RA00",
"model_name": "RD SPYDER RT LTD 1330 SE6 GY DRK 24",
"bulletins": [
{
"bulletin_code": "10-24-3WV-UNT-US",
"bulletin_description": "Apple CarPlay Compensation",
"date_until_reserved": "2023-08-20",
"date_until_consumed": "2024-10-31",
"is_stackable": true,
"is_pre_order": false,
"promotions": [
{
"promotion_category": "Immediate",
"promotion_deposit_amount": "0.00",
"promotion_code": "0000002114",
"promotion_types": [
{
"promotion_type": "02",
"component_description": "APPLE CARPLAY COMP. 1Y EXTRA COV",
"benefit_promotion_code": ""
},
{
"promotion_type": "01",
"component_description": "500$(375$ DEALER CREDIT) APPLE CARPLAY COMP.",
"benefit_promotion_code": ""
}
]
}
]
},
{
"bulletin_code": "01-24-BRP-UNT-US",
"bulletin_description": "B.E.S.T. SALESPERSON REWARD (SPIFF)",
"date_until_reserved": "2024-02-01",
"date_until_consumed": "2025-01-31",
"is_stackable": true,
"is_pre_order": false,
"promotions": [
{
"promotion_category": "Immediate",
"promotion_deposit_amount": "0.00",
"promotion_code": "0000001707",
"promotion_types": [
{
"promotion_type": "11",
"component_description": "50$ SPIFF CONTINGENT ON 2 YEAR BEST SALE",
"benefit_promotion_code": ""
}
]
}
]
},
{
"bulletin_code": "05-24-3WV-UNT-US",
"bulletin_description": "Can-Am Experience (Corporate Stops)",
"date_until_reserved": "2024-03-01",
"date_until_consumed": "2024-07-31",
"is_stackable": true,
"is_pre_order": false,
"promotions": [
{
"promotion_category": "PIN Code",
"promotion_deposit_amount": "0.00",
"promotion_code": "0000001801",
"promotion_types": [
{
"promotion_type": "01",
"component_description": "500$ CASH REBATE",
"benefit_promotion_code": ""
},
{
"promotion_type": "09",
"component_description": "500$ IN PA&A (CREDIT OF 400$) - PENDING CLAIM SUBMISSION",
"benefit_promotion_code": ""
}
]
}
]
}
]
}Et l'affichage BOSSWeb est comme ceci :

Référence de l'API
curl --location 'https://qa-cloud-api.brp.com/dcp/v4/unit/3JBLGAR41NJ002076/promotions?usage_code=REC_01' \
--header 'Dealer-Number: 0000690095' \
--header 'Authorization: Bearer REPLACE_ME' curl --location 'https://qa-cloud-api.brp.com/dcp/v4/promotions?usage_code=REC_01&model_no=0002WNA00' \
--header 'Dealer-Number: 0000690095' \
--header 'Authorization: Bearer REPLACE_ME' Code d'utilisation
Code | Description |
|---|---|
REC_01 | Récréatif/Personnel |
DE_01 | Démo |
LE_01 | Location |
LO_01 | Prêt |
GOV_01 | Gouvernement |
REN_01 | Location |
COM_01 | Commercial |
AG_01 | Agricole |
PS_01 | Personnel professionnel |
FR_01 | Enregistrement forcé |
CSG_01 | Consignation |
RA_01 | Course |
SL/LS_01 | Prêt scolaire LS conditions de financement sur 365 jours |
SL/LT_01 | Prêt scolaire LT conditions de financement sur 465 jours |
MI_01 | Militaire |
NC_01 | Gratuit |
Comment faire
Cette section fournit des informations sur la manière d’obtenir des résultats spécifiques avec l’API.
Obtenir les promotions pour un NIV
Obtenez les promotions disponibles en utilisant le NIV d’une unité et pour un usage commercial. Cet appel peut être utilisé lorsqu’un concessionnaire souhaite obtenir les promotions disponibles lors de la préparation d’un devis pour un client.
curl --location 'https://cloud-api.brp.com/dcp/v4/unit/3JBLGAR41NJ002076/promotions?usage_code=COM_01' \
--header 'Dealer-Number: 0000691690' \
--header 'Authorization: Bearer REPLACE_ME' Obtenir les promotions pour un numéro de modèle
Obtenir les promotions disponibles pour un numéro de modèle. L’appel permet au concessionnaire de voir les promotions pour un modèle d’unité dans son inventaire.
Notez que le registration_date est utilisé dans cet appel pour voir toutes les promotions disponibles après le 1er novembre 2023. Ce type d’appel peut retourner des promotions expirées, il est donc important d’afficher les champs date_until_reserved et date_until_consumed .
curl --location 'https://cloud-api.brp.com/dcp/v4/promotions?usage_code=REC_01®istration_date=2023-11-01&model_no=0002WNA00' \
--header 'Dealer-Number: 0000690095' \
--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 inappropriés.
400 Requête incorrecte
Le code d’état 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 entraîner un code d’état 400 ; les plus courants sont listés dans le tableau ci-dessous.
Réponse | Résolution |
|---|---|
Retourné si le Dealer-Number paramètre d’en-tête est manquant. {
"status": "400",
"id": "rrt-074faba1d0796ac77-c-ea-24396-616154-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 '/invoices' mais n’a pas été trouvé dans la requête."
}
]
}
}
} | Modifiez votre appel API pour ajouter le paramètre Dealer-Number dans l’en-tête. |
Retourné si le numéro de modèle et le numéro de série sont manquants dans la requête. {
"status": "400",
"id": "rrt-023ba21d3844ea361-c-ea-22598-2461748-1.1",
"title": "bad_request",
"meta": {
"service": "98",
"detail": "Aucun numéro de modèle ou numéro de série n’a été fourni. L’un des deux, model_no ou serial_no, doit être fourni."
}
} | Assurez-vous d’inclure un numéro de modèle ou un numéro de série (VIN) dans le chemin de la requête. |
Retourné si les numéros de modèle et de série (VIN) sont fournis. {
"status": "400",
"id": "rrt-08b132083d72c98ab-b-ea-26817-2169562-1.1",
"title": "bad_request",
"meta": {
"service": "98",
"detail": "Un numéro de modèle et un numéro de série ont été fournis. Un seul des deux, model_no ou serial_no, peut être fourni à la fois."
}
} | Fournissez uniquement le numéro de modèle ou le numéro de série. |
Retourné si le numéro de modèle est invalide. {
"status": "400",
"id": "rrt-0d1e94b23f6aa0176-d-ea-28384-5536739-1.1",
"title": "bad_request",
"meta": {
"service": "15",
"detail": "Numéro de modèle invalide : 000AAA00"
}
} | Le concessionnaire a peut-être commis une erreur en saisissant le numéro de modèle. Vous devez signaler l’erreur à l’utilisateur pour lui permettre de réessayer. |
Retourné si le numéro de série (VIN) est invalide. {
"status": "400",
"id": "rrt-08b132083d72c98ab-b-ea-26817-2169562-1.1",
"title": "bad_request",
"meta": {
"service": "98",
"detail": "VIN invalide 2BPSABNA3NV000000"
}
} | Le concessionnaire a peut-être saisi par erreur le numéro de série (VIN). Vous devez signaler l’erreur à l’utilisateur afin qu’il puisse réessayer. |
Retourné si le numéro du concessionnaire est invalide. {
"status": "400",
"id": "rrt-0d1e94b23f6aa0176-d-ea-28384-5536117-1.1",
"title": "bad_request",
"meta": {
"service": "06",
"detail": "Numéro de concessionnaire invalide :0000123456"
}
} | Si le concessionnaire utilise votre DMS, il se peut qu’il ne soit plus concessionnaire BRP. Vérifiez avec lui et désactivez les mises à jour d’inventaire des pièces. Assurez-vous que le numéro du concessionnaire comporte 10 caractères. Si vous enregistrez le numéro du concessionnaire sans le ou les zéros initiaux, ajoutez-les avant d’appeler l’API. L’erreur est également renvoyée si le concessionnaire n’est pas un concessionnaire BRP actif. |
401 Non autorisé
Le code d’erreur 401 Unauthorized est renvoyé lorsque vous essayez d’appeler l’API avec un access_token expiré.
Vous devez obtenir un nouvel access_token en appelant 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 DCP Jira.
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 d’assistance comme décrit dans la section Ouvrir un ticket d'assistance.
404 Non trouvé
Le code d’état 404 Not Found est renvoyé lorsqu’aucune promotion n’est disponible pour le numéro de modèle ou le numéro de série (VIN).
{
"status": "404",
"id": "rrt-023ba21d3844ea361-c-ea-22598-2461228-1.1",
"title": "not_found",
"meta": {
"service": "19",
"detail": "Requested promotion not found."
}
}Exigences DSP
Exigences fonctionnelles
ID | Type | Exigence |
|---|---|---|
1 | Obligatoire | Le concessionnaire doit pouvoir récupérer les promotions d’une unité en utilisant le VIN. |
2 | Obligatoire | Le concessionnaire doit pouvoir récupérer les promotions d’une unité en utilisant le numéro de modèle. |
3 | Obligatoire | Si aucune promotion n’est trouvée, le DSP doit afficher les promotions récupérées ou un message. |
4 | Obligatoire | Le DSP doit afficher les promotions sur un écran similaire à celui présenté dans la section Affichage des promotions. |
Activités de certification
Cette section présente toutes les activités de certification et les validations qui doivent être réalisé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 chez les concessionnaires.
👉 Pour les tests, comme le nombre de promotions dans l’environnement de test est limité, vous devez utiliser des VIN et des numéros de modèle spécifiques pour les concessionnaires canadiens et américains.
👉 Si vous le pouvez, utilisez les numéros de revendeur suivants :
États-Unis : 0000690095
Canada : 0000691690
ID | Test | Résultat attendu |
|---|---|---|
1 | Demander les promotions basées sur un numéro de série (VIN) et en utilisant le REC_01 usage_code. US : RLVDGF114NVN00631 Canada : 3JBUJAX51MK000001 | Les promotions sont récupérées et affichées. |
2 | Demander les promotions basées sur un numéro de modèle et en utilisant le REC_01 usage_code. US : 0006RMB00 Canada : 0002WNA00 | Les promotions sont récupérées et affichées. |
3 | Demander les promotions basées sur un numéro de série (VIN) avec le REC_01 usage_code et en utilisant une date d'enregistrement du 1er janvier 2023. US : RLVDGF114NVN00631 Canada : 3JBUJAX51MK000001 | Les promotions sont récupérées et affichées. |
4 | Demander les promotions pour le numéro de modèle 00029RA00, qui n’a aucune promotion. | Un message s'affiche indiquant qu'il n'y a aucune promotion. |
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 | 2 semaines |
Validation 1 | L'équipe DCP valide que l'API Promotions est appelée. |
Validation 2 | Le DSP fournit des captures d'écran de 5 promotions pour chaque concessionnaire. |
Postman
Cette section décrit ce qui est disponible dans Postman pour explorer l'API.
Environnements
Un environnement Postman est disponible pour tester l’API Promotions. 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 DSP - Promotions contient des exemples d'appels API pour récupérer les promotions disponibles.