API des concessionnaires
Pour commencer
L’API Dealers vous fournit les informations les plus récentes sur un concessionnaire BRP. Vous utilisez ces informations de concessionnaire pour plusieurs fonctionnalités, comme les configurations et les commandes de pièces. L’API tient compte des particularités régionales qui influencent les paramètres du concessionnaire, telles que la langue et la disponibilité des méthodes d’expédition.
Si le concessionnaire est actif, toutes ses informations sont disponibles. Vous recevrez un message d’erreur si le concessionnaire est inactif ou si un mauvais numéro de concessionnaire est utilisé pour appeler l’API.
Les informations suivantes sont renvoyées par l’API :
- Informations sur le concessionnaire
- Informations sur le partenaire
- Informations sur les méthodes d’expédition
- Lignes de produits
- Date de dernière mise à jour
L'API ne renvoie PAS les informations suivantes :
- Site web
- Numéro de téléphone
- Attributs de vente
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 plus de détails sur l'authentification et les identifiants.
Informations techniques
Caractéristiques
Type d'API | Type 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 | | | Un 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/<v3 ou v4> |
|---|---|
Production | https://cloud-api.brp.com/dcp/<v3 ou v4> |
Ressource : Concessionnaires
La ressource concessionnaire fournit des informations de base sur le concessionnaire, le partenaire du concessionnaire pour les informations de livraison et de facturation, ainsi que les méthodes d’expédition disponibles. Elle inclut uniquement les concessionnaires au détail : les concessionnaires de service uniquement ou de location ne sont pas inclus dans le service.
Représentation JSON
{
"dealer_no": "0000704758",
"dealer_name": "PAULSENS POWER SPORTS, INC.",
"legal_name": "PAULSENS POWER SPORTS, INC.",
"address": {
"street": "200 57TH STREET NORTH",
"city": "GREAT FALLS",
"state": "MT",
"country": "US",
"postal_code": "59405-1530"
},
"language": "EN",
"partners": [
{
"partner_type": "BP",
"partner_no": "0000704758",
"partner_name": "PAULSENS POWER SPORTS, INC.",
"address": {
"street": "200 57TH STREET NORTH",
"city": "GREAT FALLS",
"state": "MT",
"country": "US",
"postal_code": "59405-1530"
}
},
{
"partner_type": "SH",
"partner_no": "0000704758",
"partner_name": "PAULSENS POWER SPORTS, INC.",
"address": {
"street": "200 57TH STREET NORTH",
"city": "GREAT FALLS",
"state": "MT",
"country": "US",
"postal_code": "59405-1530"
}
}
],
"shipping_methods": [
{
"shipping_method": "S1",
"shipping_method_descr": "Expedited Ground"
},
{
"shipping_method": "S2",
"shipping_method_descr": "Vehicle Down"
},
{
"shipping_method": "S3",
"shipping_method_descr": "Veh. Down Saturday"
}
],
"product_lines": [
"SNO",
"PWC",
"ATV",
"SSV",
"2WV"
],
"ev_qualification_level": "E2",
"business_hours": [
"Mon: 09:00-18:00",
"Tue: 09:00-18:00",
"Wed: 09:00-18:00",
"Thu: 09:00-18:00",
"Fri: 09:00-18:00",
"Sat: 09:00-15:00",
"Sun: 00:00-00:00"
],
"service_hours": [
"Mon: 00:00-00:00",
"Tue: 00:00-00:00",
"Wed: 00:00-00:00",
"Thu: 00:00-00:00",
"Fri: 00:00-00:00",
"Sat: 00:00-00:00",
"Sun: 00:00-00:00"
],
"sales_attributes": {
"sales_territory_code": "",
"sales_district": "NA0001",
"sales_office": "NA02",
"sales_group": "NAD"
}
}Propriétés
❗ Les champs en bleu sont envoyés uniquement par la version V4 de l’API Dealers ❗
Property | Type | Definition | Notes |
|---|---|---|---|
dealer_no | string | Dealer number. | Length:10 |
dealer_name | string | Dealer commercial name. | Max Length:80 |
legal_name | string | The legal name of the customer for financial purposes. | Max Length:80 |
address | object | Address of the dealer |
|
address.street | string | Street address | Max Length:60 |
address.city | string | City address | Max Length:40 |
address.state | string | Code that uniquely identifies a province/state in a country, in ISO 3166-2 (2nd part) format. | Max Length:3 |
address.country | string | Code that uniquely identifies a country, in ISO 3166-1 format. | Max Length:2 |
address.postal_code | string | Postal code of the customer. | Max Length:10 |
language | string | Communication language of the customer in ISO language code (ISO-639-1) | Format XX |
partners | list of objects | Partners information |
|
partners.partner_type | string | Code that identifies the partner types. One of:
| Max Length:2 |
partners.partner_no | string | Partner customer number. | Max Length:10 |
partners.partner_name | string | Partner commercial name. | Max Length:35 |
partners.address | object | Address of the partner. |
|
partners.address.street | string | Street address (1st line) | Max Length:60 |
partners.address.city | string | City address | Max Length:40 |
partners.address.state | string | Code that uniquely identifies a province/state in a country, in ISO 3166-2 format. | Max Length:3 |
partners.address.country | string | Code that uniquely identifies a country, in ISO 3166-1 format. | Max Length:2 |
partners.address. postal_code | string | Postal code of the partner. | Max Length:10 |
shipping_methods | list of object | Information on shipping methods that are available to this customer. |
|
shipping_methods .shipping_method | string | Code that uniquely identifies the shipping method in which the sales order can be delivered. The list of valid values is different for each dealer, based on the localization of the dealer. | Max Length:2 |
shipping_methods .shipping_method_descr | string | Shipping method description | Max Length:20 |
product_lines | list of string | Code that uniquely identifies a Product Line. | Max Length:3 |
ev_qualification_level | string | The dealer qualification level for the electric vehicle. See the table below. | Length: 2 |
business_hours | list of string | An array of strings with the days and hours the dealership is opened. The dealership is closed if the hours are "00:00-00:00". | |
service_hours | list of string | An array of strings with the dealership service department's days and hours is opened. The dealership service department is closed if the hours are "00:00-00:00". | |
sales_attributes | object | Information on the sales zones. | |
sales_attributes. sales_territory_code | string | See the Sales Territory Codes section below. | Length: 3 |
sales_attributes. sales_district | string | See the Sales District section below. | Length: 6 |
sales_attributes. sales_office | string | See the Sales Office section below. | Length: 4 |
sales_attributes. sales_group | string | See the Sales Group section below. | Length: 3 |
Types de partenaires
Code | Valeur | Description |
|---|---|---|
SP | Client principal | Définit le partenaire auprès duquel les unités et/ou PA&A sont commandées et qui peut effectuer toutes les autres fonctions. Le client principal est celui qui passe la commande. |
SH | Destinataire | Définit le partenaire vers lequel les unités et/ou PA&A sont uniquement expédiées. Le destinataire est celui à qui les marchandises sont envoyées. |
BP | Facturé à | Définit le partenaire auquel les unités et/ou PA&A sont uniquement facturées. Le destinataire de la facture est celui à qui les factures sont envoyées. |
Méthodes d'expédition - Amérique du Nord
Code V3 | Code V4 | Description | Utilisation |
|---|---|---|---|
01 | S1 | Sol Express | Mise à niveau de premier niveau à partir du service domestique standard :
|
02 | S2 | Véhicule immobilisé | Expédition la plus rapide disponible. Couramment utilisée lorsque les retards d’expédition sont critiques (scénarios de véhicule immobilisé) :
|
03 | S3 | Véhicule immobilisé sam. | Identique à « Véhicule immobilisé » mais avec possibilité de réception le samedi. |
Méthodes d'expédition - International
Organisation commerciale | Code V3 | Description |
|---|---|---|
6030 - Scandinavie | 50 | itella |
6030 - Scandinavie | 51 | posten_logistik |
6030 - Scandinavie | 52 | terrestre |
6030 - Scandinavie | 53 | air |
6030 - Scandinavie | 54 | terrestre |
6030 - Scandinavie | 55 | air |
6030 - Scandinavie | 59 | terrestre |
6030 - Scandinavie | 60 | air |
6050 - Europe (EMEA) | 30 | régulier |
6050 - Europe (EMEA) | 33 | urgent |
7080 - Asie-Pacifique (APAC) | 38 | régulier |
7080 - Asie-Pacifique (APAC) | 39 | urgent |
7080 - Asie-Pacifique (APAC) | 40 | régulier |
7080 - Asie-Pacifique (APAC) | 82 | stock |
7080 - Asie-Pacifique (APAC) | 90 | stock |
8070 - Mexique | 92 | régulier |
8070 - Mexique | 93 | air |
8070 - Mexique | 94 | urgent |
8075 - Brésil | 63 | aereo_azul_cargo |
8075 - Brésil | 77 | sedex_correios |
8075 - Brésil | 78 | padrao_rodoviario |
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 |
Niveau de qualification des véhicules électriques (VE)
Le concessionnaire doit être qualifié pour vendre et assurer le support des produits de véhicules électriques.
❗ Il existe d’autres considérations et règles liées à la capacité du concessionnaire à commander et à entretenir les véhicules électriques et les pièces, qui ne sont pas couvertes par cette documentation. Ces informations sont fournies pour vous donner une idée du niveau de qualification.
Les concessionnaires connaîtront leur niveau de qualification et ce qu’ils peuvent ou ne peuvent pas faire ❗
Niveau de qualification | Nom | Description |
|---|---|---|
E0 ou vide | Non qualifié | Le concessionnaire ne peut pas commander de pièces et unités EV. |
E1 | Accès | Le concessionnaire ne peut pas commander de pièces et unités EV. |
E2 | Qualifié | Le concessionnaire peut commander des pièces et unités avec des limitations et ne peut pas faire de réclamations de garantie. |
E3 | Expert | Le concessionnaire peut commander toutes les pièces et unités et peut faire des réclamations de garantie. |
Codes de territoire de vente
Le Code de territoire de vente relie le client et le matériel. Il est principalement utilisé en interne pour restreindre la liste des modèles qu’un client peut voir.
Code | Value | Region | Definition |
|---|---|---|---|
1 | Canada | NA | Dealer Direct & Distributors in Sales Group NAA. |
3 | US East | NA | Dealer Direct in Sales Group NAB. |
4 | US Central | NA | Dealer Direct in Sales Group NAC. |
5 | US West | NA | Dealer Direct inSales Group NAD. |
301 | SCAND Dealers - PWS | EMEA | Dealer Direct in Sales Office EA01 - Northern Europe |
302 | SCAND Special Account - PWS | EMEA | Special account in Sales Office EA01 - Northern Europe. |
501 | WEMEA Dealers - PWS | EMEA | Dealer Direct in Sales Office EA03 - Western Europe, Middle East and Africa |
504 | Russia - PWS | EMEA | Dealer Direct & Distributors in Sales Office EA04 - Russia country |
700 | Mexico - Dealers | LATAM | Dealer Direct in Sales Office LA02 - Mexico county. |
750 | Brazil - Dealers | LATAM | Dealer Direct in Sales Office LA02 - Brazil county. |
800 | AUS - Melbourne | APAC | Dealer Direct receiving products from Melbourne Distribution Center (Storage Location P002) in Australia - Sales Offices AP01 |
801 | AUS - Brisbane | APAC | Dealer Direct receiving products from Brisbane Distribution Center (Storage Location P003) in Australia - Sales Offices AP01 |
802 | AUS - Sydney | APAC | Dealer Direct receiving products from Sydney Distribution Center (Storage Location 2001) Australia - Sales Offices AP01 |
810 | NZ - Auckland | APAC | Dealer Direct receiving products from Auckland Distribution Center (Storage Location 2001) in New Zealand - Sales Offices AP05. |
811 | NZ - Christchurch | APAC | Dealer Direct receiving product from Christchurch Distribution Center (Storage Location P012) in New Zealand - Sales Offices AP05. |
District des ventes
Le District de vente représente l'entité globale ayant une relation commerciale avec le client. Un district de vente est une structure autonome
Code | Description | Explications |
|---|---|---|
NA0001 | Amérique du Nord | Région Amérique du Nord (États-Unis et Canada) |
EA0001 | EMEA | Représente la région Europe, Moyen-Orient et Afrique |
AP0001 | APAC | Représente la région Asie-Pacifique |
LA0001 | LATAM | Représente la région Amérique latine |
Bureau de vente
Le bureau de vente représente une zone géographique plus petite au sein de chaque structure globale. Un bureau de vente est attribué à une zone de vente.
Code | Valeur | Description |
|---|---|---|
NA01 | Canada | Associé à la région nord-américaine et représente le Canada. |
NA02 | États-Unis | Associé à la région nord-américaine et représente les États-Unis. |
NA98 | Autres NA | Associé aux groupes de clients nord-américains spécifiques qui ne nécessitent pas de bureau de vente. |
EA01 | Scandinavie | Associé à la région EMEA et représente l’Europe du Nord. |
EA02 | Russie | Associé à la région EMEA et représente l’ensemble du pays russe. |
EA03 | WEMEA | Associé à la région EMEA et représente l’Europe de l’Ouest, le Moyen-Orient et l’Afrique pour PAA. |
EA04 | EMEA Dlr D | Associé à la région EMEA et représente Dealer Direct pour FG/Units. |
EA05 | EMEA Dist Ex-DC | Associé à la région EMEA et représente les distributeurs recevant des produits du centre de distribution pour FG/Units. |
EA06 | EMEA Dist Ex-Manuf | Associé à la région EMEA et représente les distributeurs recevant des produits de l’usine pour FG/Units. |
AP01 | Australie | Associé à la région APAC et représente l’Australie. |
AP02 | EAPI | Associé à la région APAC et représente les îles émergentes d’Asie-Pacifique. |
AP03 | Japon | Associé à la région APAC et représente le Japon. |
AP04 | Chine | Associé à la région APAC et représente la Chine. |
AP05 | Nouvelle-Zélande | Associé à la région APAC et représente la Nouvelle-Zélande. |
LA01 | CSC | Associé à la région LATAM et représente l’Amérique centrale, l’Amérique du Sud et les Caraïbes. |
LA02 | Mexique | Associé à la région LATAM et représente le Mexique. |
LA03 | Brésil | Associé à la région LATAM et représente l’ensemble du pays brésilien. |
LA98 | Autres LATAM | Associé à la région LATAM, groupes de clients spécifiques ne nécessitant pas de bureau de vente. |
Groupe de vente
Le Groupe de vente représente un regroupement de pays au sein de la zone géographique. Il peut s'agir d'un pays ou d'un groupe de pays. Un groupe de vente est attribué à un bureau de vente.
Code | Value | Description |
|---|---|---|
NAA | Canada | Associated with the Canada Sub region and represents Canada. |
NAB | US East | Associated to the US Sub Region and represents the East portion of the US country. Here are the US states included: Alabama (AL), Connecticut (CT), District of Columbia (DC), Delaware (DE), Florida (FL), Georgia (GA), Massachusetts (MA), Maryland (MD), Maine (ME), North Carolina (NC), New Hampshire (NH), New Jersey (NJ), New York (NY), Pennsylvania (PA), Rhode Island (RI), South Carolina (SC), Virginia (VA), Vermont (VT) and West Virginia (WV) |
NAC | US Central | Associated with the US Sub Region and represents the Central portion of the US country. Here are the US states included: Arkansas (AR), Iowa (IA), Illinois (IL), Indiana (IN), Kansas (KS), Kentucky (KY), Louisiana (LA), Michigan (MI), Minnesota (MN), Missouri (MO), Mississippi (MS), North Dakota (ND), Nebraska (NE), Ohio (OH), South Dakota (SD), Tennessee (TN) and Wisconsin (WI) |
NAD | US West | Associated with the US Sub Region and represents the western portion of the US country. Here are the US states included: Alaska (AK), Arizona (AZ), California (CA), Colorado (CO), Hawaii (HI), Idaho (ID), Montana (MT), New Mexico (NM), Nevada (NV), Oklahoma (OK), Oregon (OR), Texas (TX), Utah (UT), Washington (WA) and Wyoming (WY) |
NAX | Other NA | Associated with specific customer groups that do not require a sales group for business. |
EAA | Finland | Associated with the Scandinavia Sub Region and represents the complete Finland country. |
EAB | Norway | Associated with the Scandinavia Sub Region and represents the complete Norway country. |
EAC | Sweden | Associated with the Scandinavia Sub Region and represents the complete Sweden country. |
EAD | Scandinavia- Dist | Associated with the Scandinavian sub-region, which represents the distributor of Scandinavia. |
EAE | Russia | Associated with the Russia Sub Region and represents Russia. |
EAF | Austria | Associated with the WEMEA & EMEA Dlr D Sub Region and represents the complete Austria country |
EAG | Benelux | Associated with the WEMEA & EMEA Dlr D Sub Region and represents Belgium, Netherlands, and Luxembourg. |
EAH | France | Associated with the WEMEA & EMEA Dlr D Sub Region and represents France. |
EAI | Germany | Associated with the WEMEA & EMEA Dlr D Sub Region and represents Germany. |
EAJ | Italy | Associated with the WEMEA & EMEA Dlr D Sub Region and represents Italy. |
EAK | Spain | Associated with the WEMEA & EMEA Dlr D Sub Region and represents Spain. |
EAL | United Kingdom | Associated with the WEMEA & EMEA Dlr D Sub Region and represents England, Scotland, and Ireland. |
EAM | Dist EUR Ex-DC | Associated with the WEMEA & EMEA Dist Ex-DC Sub Region and represents Distributors receiving products from the Distribution Center in EUR currency |
EAN | Dist EUR Ex-Manuf | Associated with the WEMEA & EMEA Dist Ex-Manuf Sub Region and represents Distributors receiving products from the Manufacturing Plant in EUR currency. |
EAO | Dist USD Ex-DC | Associated with WEMEA & EMEA Dist Ex-DC Sub Region, it represents distributors receiving products from the distribution center in USD currency. |
EAP | Dist USD Ex-Manuf | Associated with the WEMEA & EMEA Dist Ex-Manuf Sub Region and represents Distributors receiving products from the Manufacturing Plant in USD currency. |
APA | Australia | Associated with the ANZ Sub Region and represents Australia. |
APB | New Zealand | Associated with the ANZ Sub Region and represents New Zealand. |
APC | EAPI | Associated with the EAPI Sub-Region |
APD | Japan | Associated with the Japan Sub Region and represents Japan. |
APE | China | Associated to China Sub Region and represents China. |
LAA | Argentina | Associated with the LAM Distributors Sub Region and represents Argentina. |
LAB | CSC | Associated with the LAM Distributors Sub Region and represents the Caribbean, Central America & South America. |
LAE | Mexico | Associated with the Mexico Sub Region and represents Mexico. |
LAF | Brazil | Associated with the Brazil Sub Region and represents Brazil. |
LAX | Other LATAM | Associated with the Specific Customer Groups that do not require a Sales Group for business. |
Limitations et contraintes
Type de concessionnaire renvoyé
Seuls les concessionnaires de détail sont renvoyés. Les autres types de concessionnaires, comme les services et la location, ne sont pas renvoyés par l'API, et le code d'état « non trouvé » est renvoyé.
Référence de l'API
curl --location 'https://qa-cloud-api.brp.com/dcp/v4/dealer/0000695370?language=fi-FI' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' 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 pays en majuscules
Valeurs de code 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 un concessionnaire avec la langue par défaut (EN)
Cette requête demande les informations du concessionnaire en utilisant le numéro du concessionnaire sans avoir à spécifier la langue.
curl --location 'https://qa-cloud-api.brp.com/dcp/v4/dealer/0000690009' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' Obtenir les informations du concessionnaire dans une langue spécifique
Cette requête demande des informations sur le concessionnaire en utilisant son numéro et une langue.
Exception : Si l'information n'est pas disponible dans la langue demandée, elle est renvoyée en anglais.
curl --location 'https://qa-cloud-api.brp.com/dcp/v4/dealer/0000695370?language=fi-FI' \
--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 inappropriés.
400 Mauvaise requête
Le code d’état 400 apparaît généralement lors du développement et de l’intégration et ne devrait pas être reçu pendant les 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, et les plus courants sont répertoriés dans le tableau ci-dessous.
Réponse | Résolution |
|---|---|
Renvoyé si le champ du numéro de concessionnaire est vide. {
"status": "400",
"id": "rrt-074faba1d0796ac77-c-ea-24396-1520447-1",
"title": "bad_request",
"meta": {
"service": "00",
"detail": "Path not found."
}
} | Le problème est que le chemin de requête ne fournit pas de numéro de concessionnaire. Vous devez fournir un numéro de concessionnaire. |
Renvoyé si le format de langue n'est pas valide. {
"status": "400",
"id": "rrt-06c1b7ac7365beb8f-d-ea-22696-1239306-1",
"title": "bad_request",
"meta": {
"service": "01",
"detail": "request validation failed",
"payload": {
"details": [
{
"message": "ECMA 262 regex \"^[a-z]{2}-[A-Z]{2}$\" does not match input string \"ab-ABC\": []"
}
]
}
}
} | Le format de langue valide est le suivant Format : xx-XX xx : code de langue en minuscules XX : code du pays en majuscules Un format de langue valide doit être saisi afin de produire une réponse correcte. |
Renvoyé si le paramètre est invalide {
"status": "400",
"id": "rrt-00a574511a562afb5-b-ea-22208-2505617-1",
"title": "bad_request",
"meta": {
"service": "01",
"detail": "request validation failed",
"payload": {
"details": [
{
"message": "query parameter is unexpected : lang: []"
}
]
}
}
} | Lang est un paramètre invalide. Le paramètre language doit être utilisé afin d’obtenir une réponse valide. |
401 Non Autorisé
Le code d’erreur 401 Non Autorisé est renvoyé lorsque vous essayez d’appeler l’API avec un access_token expiré.
Vous devez obtenir un nouveau access_token en effectuant un appel à l’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 numéro du concessionnaire est introuvable.
{
"status": "404",
"id": "rrt-074faba1d0796ac77-c-ea-24397-1607550-1.1",
"title": "not_found",
"meta": {
"service": "06",
"detail": "Dealer 1234567890 not found."
}
}Un numéro de concessionnaire correct doit être saisi pour que l’API renvoie une réponse appropriée. Pour être correct, un numéro de concessionnaire doit figurer dans la liste des concessionnaires.
Un numéro de concessionnaire doit comporter 10 caractères et ne contient aucune lettre.
Si le numéro de concessionnaire comporte moins de 10 caractères, ajoutez un préfixe '0'.
Exigences DSP
Exigences fonctionnelles
ID | Type | Notes |
|---|---|---|
1 | Obligatoire | Les informations du concessionnaire doivent être mises à jour quotidiennement et utilisées pour d'autres appels et fonctions de l'API DCP. 👉 Voir l’exigence fonctionnelle ID 4 ci‑dessous. Par exemple, les modes d’expédition autorisés du concessionnaire et les gammes de produits autorisées doivent être récupérés à partir des informations du concessionnaire. |
2 | Obligatoire | La mise à jour des informations du concessionnaire doit être automatique, sans action manuelle de la part du concessionnaire. |
3 | Obligatoire | Si vous demandez les informations d’un concessionnaire et obtenez le code d’état 403 Not Found, contactez l’équipe DCP à [email protected]. Le concessionnaire peut ne plus être un concessionnaire BRP et peut devenir inactif. |
4 | Optionnel | S’il n’est pas pratique d’appeler l’API Dealers quotidiennement et d’enregistrer les informations des concessionnaires, votre DMS peut appeler l’API Dealers pour récupérer ces informations au besoin. Par exemple, l’API Dealers peut être appelée lorsque le concessionnaire accède à l’écran de commande de pièces pour mettre à jour les méthodes d’expédition autorisées et les gammes de produits autorisées. |
Activités de certification
Les tests listé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 avec les concessionnaires.
Ces tests sont effectués en utilisant vos environnements de test et ceux de l’API DCP (QA).
Les tests sont légèrement différents entre les versions V3 et V4 du DCP. Pour la V3, des concessionnaires internationaux sont utilisés.
Pour la V4, des concessionnaires nord-américains sont utilisés.
Assurance qualité pour V3
ID | Test | Résultat attendu |
|---|---|---|
1 | Obtenir les informations pour le revendeur numéro 0000701580, un revendeur espagnol. | Afficher les informations du revendeur, y compris au minimum les méthodes d’expédition et les lignes de produits. Les informations peuvent être affichées dans l’interface utilisateur, une base de données ou un fichier journal. Les descriptions des méthodes d’expédition doivent être en anglais. |
2 | Obtenir les informations pour le revendeur numéro 0000706567, un revendeur allemand, avec la langue de-DE. | Afficher les informations du revendeur, y compris au minimum les méthodes d’expédition et les lignes de produits. Les informations peuvent être affichées dans l’interface utilisateur, une base de données ou un fichier journal. Les descriptions des méthodes d’expédition doivent être en allemand. |
3 | Obtenir les informations pour le revendeur numéro 0000123456, un revendeur invalide. | Afficher le journal d’erreurs et la manière dont le statut 404 Not Found est géré dans l’application. |
4 | Mise à jour quotidienne automatique. | Montrer la preuve que l’API Dealers est appelée automatiquement chaque jour. |
Assurance qualité pour V4
ID | Test | Résultat attendu |
|---|---|---|
1 | Obtenir les informations pour le concessionnaire numéro 0000691756, un concessionnaire canadien, avec la langue fr-CA. | Afficher les informations du concessionnaire, incluant au minimum les méthodes d’expédition et les gammes de produits. Les informations peuvent être affichées dans l’interface utilisateur, une base de données ou un fichier journal. Les descriptions des méthodes d’expédition doivent être en français. |
2 | Obtenir les informations pour le concessionnaire numéro 0000690009, un concessionnaire américain. | Afficher les informations du concessionnaire, incluant au minimum les méthodes d’expédition et les gammes de produits. Les informations peuvent être affichées dans l’interface utilisateur, une base de données ou un fichier journal. Les descriptions des méthodes d’expédition doivent être en anglais. |
3 | Obtenir les informations pour le concessionnaire numéro 0000123456, un concessionnaire invalide | Afficher le journal d’erreurs et comment le statut 404 Non trouvé est géré dans l’application. |
4 | Mise à jour quotidienne automatique. | Montrer la preuve que l’API des concessionnaires est appelée automatiquement chaque jour. |
Pilote distributeur
Le tableau ci-dessous décrit les paramètres et les validations du pilote distributeur.
Paramètre | Valeur |
|---|---|
Environnement | Production |
Nombre de distributeurs | 1 à 3 |
Durée | 1 semaine |
Validation 1 | DCP vérifie que l’API Dealers est appelée chaque jour pour chaque distributeur du pilote |
Validation 2 | DCP vérifie que les informations du distributeur, principalement les modes d’expédition et les gammes de produits, sont disponibles dans le DMS. |
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 Dealers. 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 - Concessionnaires contient des exemples d’appels API pour récupérer des informations sur les concessionnaires.