API d'informations DSP
Commencer
L’API d’informations DSP fournit à BRP une liste quotidienne et à jour des clients BRP utilisant votre système.
Cette liste à jour permet à BRP de gérer les informations des concessionnaires et d’assurer l’exactitude des données pour les programmes d’affaires clés, y compris les programmes du Système de gestion des prospects (LMS), qui servent les concessionnaires.
❗ ❗ Seuls les concessionnaires BRP Powersports doivent être envoyés ❗ ❗
Les autres types de concessionnaires BRP ne font PAS partie de DCP et ne doivent pas être inclus dans la liste des concessionnaires.
❗ ❗ Tous les concessionnaires BRP actifs doivent être envoyés dans la liste d'informations DSP, même si le partage de données pour l’inventaire des pièces des concessionnaires et les transactions au détail n’est pas activé ❗ ❗
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.
Gestion de la liste des concessionnaires
Afin de soutenir les nombreuses initiatives commerciales de BRP, DCP doit associer correctement les concessionnaires à leur DMS. L’API d’information DSP aide, mais certains cas nécessitent davantage. Un concessionnaire peut changer de système DMS et conserver l’ancien pendant un certain temps. Dans cette situation, le consentement de partage de données dans l’ancien DMS reste souvent activé, et DCP reçoit les données d’inventaire et les transactions de vente au détail provenant des deux DMS.
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 l’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 Concessionnaires permet aux DSP de mettre à jour leur liste de concessionnaires.
Représentation JSON
{
"items":[
{
"dealer_no":"0000699623",
"Data_sharing_consent": true
},
{
"dealer_no":"0000694307",
"Data_sharing_consent": false
}
]
}
Propriétés
Propriété | Type | Définition | Notes |
|---|---|---|---|
articles | Liste d’objets | Liste de concessionnaires. Elle doit contenir au moins un concessionnaire. | |
dealer_no | Chaîne | Code qui identifie de manière unique un concessionnaire. Doit comporter 10 caractères. S’il comporte moins de 10 caractères, ajouter '0' au début. | Longueur:10 |
data_sharing_consent | Booléen | Indique si le client a consenti à partager ses données avec BRP via ce DMS. La valeur est l’une des suivantes :
|
|
Toutes les propriétés sont obligatoires.
Limitations et contraintes
Taille de la liste des concessionnaires
Pour éviter les dépassements de délai, la liste des concessionnaires ne doit contenir aucun
plus de 800 concessionnaires.
Comprendre les informations DSP
La liste des concessionnaires
Système centralisé vs décentralisé
Votre système peut être centralisé, par exemple basé sur le web, ou décentralisé, avec un serveur installé chez le concessionnaire.
La façon dont l’API d’informations DSP est appelée dépend du type de système :
- Centralisé : vous envoyez la liste complète des concessionnaires actifs chaque jour.
- Décentralisé : chaque concessionnaire actif appelle l’API chaque jour.
- Notez que l’appel doit être effectué de manière aléatoire entre 00:00 et 06:00 dans le fuseau horaire du concessionnaire.
👉 Notez que même avec un système décentralisé, vous pouvez avoir une liste centralisée de concessionnaires.
Ajouter et supprimer un concessionnaire
Il est essentiel de mettre à jour votre liste de concessionnaires chaque fois qu’un nouveau concessionnaire BRP rejoint votre DMS ou CRM, ou lorsqu’un concessionnaire BRP cesse d’utiliser votre système.
Lorsqu’un concessionnaire cesse d’utiliser votre DSP, arrêtez de l’inclure dans les données d’information DSP, et il sera marqué comme inactif de notre côté.
Dans certains cas, un concessionnaire utilisant votre DSP peut cesser d’être un concessionnaire BRP. Dans ce cas, arrêtez de l’inclure dans les données d’information DSP, et il sera marqué comme inactif de notre côté.
Nous avons commencé à créer des tickets Jira de type 'Mise à jour de la liste des concessionnaires' pour vous informer lorsque BRP ajoute un nouveau concessionnaire BRP et lorsqu’un concessionnaire cesse d’être un concessionnaire BRP.
👉 Veuillez traiter ces tickets et nous informer dans le ticket lorsque le changement a été effectué.
Référence de l'API
curl --location 'https://cloud-api.brp.com/dcp/v4/dsp/dealers' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
--data '{
"items":[
{
"dealer_no":"0000692157",
"data_sharing_consent":true
},
{
"dealer_no":"0000690373",
"data_sharing_consent":true
}
]
}'Guide pratique
Cette section fournit des informations sur la façon d'obtenir des résultats spécifiques avec l'API.
Envoyer la liste des concessionnaires
Envoyez votre liste de concessionnaires depuis un serveur central dans l’environnement de production.
❗ ❗ Seuls les concessionnaires BRP Powersports doivent être envoyés ❗ ❗
Les autres types de concessionnaires BRP ne font PAS partie de DCP et ne doivent pas être inclus dans la liste des concessionnaires.
curl --location 'https://cloud-api.brp.com/dcp/v4/dsp/dealers' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
--data '{
"items": [
{
"dealer_no": "0000690005",
"data_sharing_consent": true
},
{
"dealer_no": "0000690020",
"data_sharing_consent": true
},
{
"dealer_no": "0000690012",
"data_sharing_consent": false
},
{
"dealer_no": "0000690009",
"data_sharing_consent": true
},
{
"dealer_no": "0000690025",
"data_sharing_consent": true
},
{
"dealer_no": "0000690026",
"data_sharing_consent": false
},
{
"dealer_no": "0000690032",
"data_sharing_consent": true
}
]
}'Gestion des erreurs
Cette section présente divers scénarios d’appels incorrects qui entraînent des messages d’erreur et des résultats inexacts.
207 Multi-Statut
Le code 207 Multi-Statut est renvoyé lorsqu’un des numéros de concessionnaire envoyés dans la liste est invalide.
Vous devez valider votre liste de concessionnaires et retirer tout numéro invalide.
Cela peut se produire lorsque votre client n’est plus un concessionnaire BRP.
400 Mauvaise requête
Le code 400 est généralement rencontré lors du développement et de l’intégration et ne devrait pas se produire lors des 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 400 ; les plus courants sont présentés dans le tableau ci-dessous.
Réponse | Résolution |
|---|---|
Renvoyé si la liste des concessionnaires est vide. {
"status": "400",
"id": "rrt-0bde02a11a182b18f-b-ea-22691-1539844-1",
"title": "bad_request",
"meta": {
"service": "01",
"detail": "échec de la validation de la requête",
"payload": {
"details": [
{
"message": "[Chemin '/items'] Le tableau est trop court : il doit contenir au moins 1 élément mais l'instance en contient 0 : []"
}
]
}
}
} | La liste des concessionnaires ne peut pas être vide. Vérifiez votre intégration et assurez-vous d’envoyer votre liste de concessionnaires. |
Renvoyé si vous appelez l’API sans la liste des concessionnaires. {
"status": "400",
"id": "rrt-0bde02a11a182b18f-b-ea-22692-1540163-1",
"title": "bad_request",
"meta": {
"service": "01",
"detail": "échec de la validation de la requête",
"payload": {
"details": [
{
"message": "L’objet présente des propriétés obligatoires manquantes ([\"items\"]): []"
}
]
}
}
} | Le payload de la requête doit contenir la liste des concessionnaires. |
Renvoyé si un élément de la liste des concessionnaires ne contient pas l'indicateur de partage des données. {
"status": "400",
"id": "rrt-0bde02a11a182b18f-b-ea-22692-1540393-1",
"title": "bad_request",
"meta": {
"service": "01",
"detail": "échec de la validation de la requête",
"payload": {
"details": [
{
"message": "[Chemin '/items/0'] L’objet présente des propriétés obligatoires manquantes ([\"data_sharing_consent\"]): []"
}
]
}
}
} | Lorsqu’elle est appelée depuis votre DMS, la liste des concessionnaires doit contenir l’indicateur de partage des données. L’indicateur est facultatif lorsqu’elle est appelée depuis votre CRM. |
Renvoyé s'il existe une propriété invalide dans la liste des concessionnaires. {
"status": "400",
"id": "rrt-0bde02a11a182b18f-b-ea-22691-1540493-1",
"title": "bad_request",
"meta": {
"service": "01",
"detail": "échec de la validation de la requête",
"payload": {
"details": [
{
"message": "[Chemin '/items/0'] L’instance de l’objet contient des propriétés non autorisées par le schéma : [\"invalid_property\"]: []"
}
]
}
}
} | Vérifiez le format du payload JSON ci-dessus pour connaître les propriétés valides. |
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 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 que vous avez perdu l’accès, créez un ticket de support comme décrit dans la section Ouvrir un ticket de support.
404 Introuvable
L’API d’information DSP renvoie un statut 404 Not Found lorsque votre DSP n’a pas encore été enregistré dans le système backend de BRP.
Dans la réponse de l'API, vous verrez le nom de votre DSP et le type de DSP (DMS ou CRM) dans l'objet errors , dans la propriété detail.
{
"status": "404",
"id": "rrt-095670f08a456e78c-d-ea-22270-46269273-1.1",
"title": "not_found",
"meta": {
"service": "03",
"detail": "Backend error",
"payload": {
"errors": [
{
"code": "Not Found",
"title": "DSP name entered is invalid or inactive.",
"detail": "DSP name entered is invalid or inactive: <DSP NAME> for type DMS"
}
]
}
}
}❗ Lorsque vous recevez un statut '404 Not Found', veuillez ouvrir un ticket dans le Jira de DCP.
Exigences DSP
Exigences fonctionnelles
Liste des concessionnaires
ID | Type | Exigence |
|---|---|---|
1 | Obligatoire | Votre liste de concessionnaires doit être automatiquement mise à jour chaque jour
|
2 | Obligatoire | Si un concessionnaire cesse d'utiliser votre DMS/CRM, vous devez le retirer de votre liste. |
3 | Obligatoire | Seuls les concessionnaires BRP Powersports sont inclus dans la liste. |
4 | Obligatoire | Lorsqu’un concessionnaire BRP Powersports commence à utiliser votre DMS, vous devez l’ajouter à la liste et en informer le DCP. Voir la section |
Activités de certification
Cette section décrit toutes les activités de certification et les validations nécessaires pour certifier l'API.
Assurance Qualité
Les tests énuméré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.
Liste des concessionnaires
ID | Test | Résultat attendu |
|---|---|---|
1 | Envoyez votre liste de concessionnaires et fournissez votre liste de concessionnaires dans un fichier | L'équipe DCP vérifie que votre liste de concessionnaires est enregistrée dans le système backend et correspond à la liste que vous avez fournie. La liste de concessionnaires fournie doit inclure la valeur du paramètre de partage de données pour chaque concessionnaire. |
2 | Mettez automatiquement à jour votre liste de concessionnaires chaque jour pendant 3 jours | L'équipe DCP vérifie que votre liste de concessionnaires est enregistrée quotidiennement dans le système backend. |
Pilote concessionnaire
Le tableau ci-dessous présente les paramètres du pilote concessionnaire et leurs validations correspondantes.
Liste des concessionnaires
Paramètre | Valeur |
|---|---|
Environnement | Production |
Nombre de concessionnaires | Tous vos concessionnaires |
Durée | 2 semaines |
Validation 1 | L’équipe DCP vérifie quotidiennement que votre liste de concessionnaires est enregistrée dans le système backend. |
Validation 2 | Vous devez fournir votre liste de concessionnaires dans un fichier deux fois durant la période pilote des concessionnaires. L’équipe DCP vérifie que la liste enregistrée dans le système backend correspond à celle que vous avez fournie. |
Validation 3 | Vérifiez que seuls les concessionnaires Powersports sont envoyés dans la liste. |
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 d’information DSP. 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 DSP - DSP Information inclut des exemples d’appels API pour mettre à jour votre liste de concessionnaires.