API de Información DSP
Comenzando
La API de Información DSP proporciona a BRP una lista diaria y actualizada de los clientes de BRP que utilizan su sistema.
Esta lista actualizada permite a BRP gestionar la información de los concesionarios y garantizar la precisión de los datos para programas comerciales clave, incluidos los programas del Sistema de Gestión de Leads (LMS), que sirven a los concesionarios.
❗ ❗ Solo deben enviarse los concesionarios BRP Powersports ❗ ❗
Los otros tipos de concesionarios BRP NO forman parte de DCP y no deben incluirse en la lista de concesionarios.
❗ ❗ Todos los concesionarios BRP activos deben enviarse en la lista de Información DSP, incluso si el intercambio de datos para Inventario de Piezas del Concesionario y Transacciones Minoristas no está habilitado ❗ ❗
¿Dónde empezar? ¡Léeme primero!
Antes de comenzar a trabajar en esta API, debes leer las siguientes secciones si aún no las has revisado:
Gestión de la lista de concesionarios
Para respaldar las numerosas iniciativas comerciales de BRP, DCP debe asociar correctamente a los concesionarios con su DMS. La API de Información DSP ayuda, pero hay casos en los que no es suficiente. Un concesionario puede cambiar su sistema DMS y mantener el anterior por un tiempo. En esta situación, el consentimiento para compartir datos en el DMS antiguo a menudo permanece habilitado, y DCP recibe datos de inventario y transacciones minoristas de ambos DMS.
Información técnica
Características
Tipo de API | Tipo de DSP | Versión DCP | Complejidad |
|---|---|---|---|
Obtener datos de BRP | DMS | V3 - Internacional | Baja |
Enviar datos a BRP | CRM | V4 - Norteamérica | Un poco más |
Transacción con BRP | | | Algo más |
Autenticación
La API está usando Autenticación de la Aplicación.
Necesita un token de acceso válido antes de llamar a esta API, o tiene que llamar a la API de Autenticación de Aplicaciones para obtener uno.
¡El token de acceso es válido por 30 minutos! (1799 segundos)
URL Base
Prueba | https://qa-cloud-api.brp.com/dcp/<v3 o v4> |
|---|---|
Producción | https://cloud-api.brp.com/dcp/<v3 o v4> |
Recurso: Distribuidores
El Distribuidores recurso permite a los DSPs actualizar su lista de distribuidores.
Representación JSON
{
"items":[
{
"dealer_no":"0000699623",
"Data_sharing_consent": true
},
{
"dealer_no":"0000694307",
"Data_sharing_consent": false
}
]
}
Propiedades
Propiedad | Tipo | Definición | Notas |
|---|---|---|---|
items | Lista de Objetos | Lista de distribuidores. Debe contener al menos un distribuidor. | |
dealer_no | Cadena | Código que identifica de manera única a un distribuidor. Debe tener 10 caracteres. Si tiene menos de 10 caracteres, agregue '0' al principio. | Longitud:10 |
data_sharing_consent | Booleano | Indica si el cliente dio su consentimiento para compartir sus datos con BRP a través de ese DMS. El valor es uno de los siguientes:
|
|
Todas las propiedades son obligatorias.
Limitaciones y restricciones
Tamaño de la lista de concesionarios
Para evitar tiempos de espera, la lista de concesionarios no debe contener más de
800 concesionarios.
Comprender la información del DSP
La lista de concesionarios
Sistema centralizado vs. descentralizado
Su sistema puede ser centralizado, por ejemplo, basado en la web, o descentralizado, con un servidor instalado en el concesionario.
La forma en que se llama a la API de información del DSP se basa en el tipo de sistema:
- Centralizado: Usted envía la lista completa de los concesionarios activos todos los días.
- Descentralizado: Cada concesionario activo llama a la API todos los días.
- Tenga en cuenta que la llamada debe hacerse de forma aleatoria entre 00:00 y 06:00 en la zona horaria del concesionario.
👉 Tenga en cuenta que incluso con un sistema descentralizado, podría tener una lista centralizada de concesionarios.
Agregar y eliminar un concesionario
Es esencial actualizar su lista de distribuidores cada vez que un nuevo distribuidor BRP se une a su DMS o CRM, o cuando un distribuidor BRP deja de usar su sistema.
Cuando un distribuidor deja de usar su DSP, deje de enviarlo en los datos de Información del DSP, y será marcado como inactivo de nuestro lado.
En algunos casos, puede tener un distribuidor que use su DSP pero que deje de ser un distribuidor BRP. En este caso, deje de enviarlo en los datos de Información del DSP, y será marcado como inactivo de nuestro lado.
Hemos comenzado a crear tickets de Jira del tipo 'Actualización de Lista de Distribuidores' para informarle cuando BRP agrega un nuevo distribuidor BRP y cuando un distribuidor deja de ser un distribuidor BRP.
👉 Por favor procese estos tickets y notifíquenos en el ticket cuando se haya realizado el cambio.
Referencia de 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
}
]
}'Cómo hacerlo
Esta sección proporciona información sobre cómo obtener resultados específicos con la API.
Enviar lista de distribuidores
Envíe su lista de distribuidores desde un servidor central en el entorno de producción.
❗ ❗ Solo deben enviarse los distribuidores BRP Powersports ❗ ❗
Los otros tipos de distribuidores BRP NO forman parte de DCP y no deben incluirse en la lista de distribuidores.
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
}
]
}'Gestión de errores
Esta sección presenta varios escenarios de llamadas incorrectas que resultan en mensajes de error y resultados inexactos.
207 Multi-Status
El código 207 Multi-Status se devuelve cuando uno de los números de distribuidor enviados en la lista es inválido.
Debe validar su lista de distribuidores y eliminar cualquier número de distribuidor inválido.
Esto puede ocurrir cuando su cliente ya no es un distribuidor BRP.
400 Solicitud incorrecta
El código de estado 400 se encuentra típicamente durante el desarrollo e integración y no debería encontrarse durante las operaciones normales. La respuesta contiene la información necesaria para corregir el problema.
Muchos problemas pueden causar un código 400; los más comunes se encuentran en la tabla a continuación.
Respuesta | Resolución |
|---|---|
Se devuelve si la lista de concesionarios está vacía. {
"status": "400",
"id": "rrt-0bde02a11a182b18f-b-ea-22691-1539844-1",
"title": "solicitud_incorrecta",
"meta": {
"service": "01",
"detail": "falló la validación de la solicitud",
"payload": {
"details": [
{
"message": "[Path '/items'] La matriz es demasiado corta: debe tener al menos 1 elemento pero la instancia tiene 0 elementos: []"
}
]
}
}
} | La lista de concesionarios no puede estar vacía. Revisa tu integración y asegúrate de enviar tu lista de concesionarios. |
Se devuelve si llamas a la API sin la lista de concesionarios. {
"status": "400",
"id": "rrt-0bde02a11a182b18f-b-ea-22692-1540163-1",
"title": "solicitud_incorrecta",
"meta": {
"service": "01",
"detail": "falló la validación de la solicitud",
"payload": {
"details": [
{
"message": "El objeto tiene propiedades obligatorias faltantes ([\"items\"]): []"
}
]
}
}
} | La carga útil de la solicitud debe contener la lista de concesionarios. |
Se devuelve si a un concesionario le falta el indicador de intercambio de datos. {
"status": "400",
"id": "rrt-0bde02a11a182b18f-b-ea-22692-1540393-1",
"title": "solicitud_incorrecta",
"meta": {
"service": "01",
"detail": "falló la validación de la solicitud",
"payload": {
"details": [
{
"message": "[Path '/items/0'] Al objeto le faltan propiedades obligatorias ([\"data_sharing_consent\"]): []"
}
]
}
}
} | Cuando se llama desde tu DMS, la lista de concesionarios debe contener el indicador de intercambio de datos. El indicador es opcional cuando se llama desde tu CRM. |
Se devuelve si hay una propiedad no válida en la lista de concesionarios. {
"status": "400",
"id": "rrt-0bde02a11a182b18f-b-ea-22691-1540493-1",
"title": "solicitud_incorrecta",
"meta": {
"service": "01",
"detail": "falló la validación de la solicitud",
"payload": {
"details": [
{
"message": "[Path '/items/0'] El objeto tiene propiedades que no están permitidas por el esquema: [\"invalid_property\"]: []"
}
]
}
}
} | Consulta el formato de carga JSON anterior para ver las propiedades válidas. |
401 No autorizado
El código de estado de error 401 Unauthorized se devuelve cuando intentas llamar a la API con un access_token expirado.
Debes obtener un nuevo access_token con una llamada a la API de Autenticación de Aplicaciones.
El código de estado de error 401 Unauthorized también se devuelve si no solicitaste acceso a la API creando un ticket en el DCP Jira.
Cuando estés listo para comenzar a trabajar en una API, debes crear un ticket de certificación en Jira, como se describe en la sección Actividades de Certificación con Jira.
Si ya comenzaste a trabajar en una API y perdiste el acceso, crea un ticket de soporte como se describe en la sección Abrir un ticket de soporte.
404 No Encontrado
La API de Información DSP devuelve un estado 404 Not Found cuando tu DSP aún no ha sido registrado en el sistema backend de BRP.
En la respuesta de la API, verá el nombre de su DSP y el tipo de DSP (DMS o CRM) en el errors objeto, en la propiedad 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"
}
]
}
}
}❗ Cuando reciba un estado '404 Not Found', abra un ticket en el Jira de DCP.
Requisitos del DSP
Requisitos funcionales
Lista de distribuidores
ID | Tipo | Requisito |
|---|---|---|
1 | Obligatorio | Su lista de concesionarios debe ser actualizada automáticamente todos los días
|
2 | Obligatorio | Si un concesionario deja de usar su DMS/CRM, debe eliminarlo de su lista. |
3 | Obligatorio | Solo los concesionarios de BRP Powersports están incluidos en la lista. |
4 | Obligatorio | Cuando un concesionario de BRP Powersports comienza a usar su DMS, debe agregarlo a la lista y notificar a DCP. Consulte la sección |
Actividades de Certificación
Esta sección describe todas las actividades de certificación y validaciones requeridas para certificar la API.
Aseguramiento de la calidad
Las pruebas enumeradas en la tabla a continuación deben completarse correctamente en el entorno de prueba antes de que pueda comenzar la fase piloto del distribuidor.
Lista de distribuidores
ID | Prueba | Resultado esperado |
|---|---|---|
1 | Envía tu lista de distribuidores y proporciona tu lista de distribuidores en un archivo | El equipo DCP verifica que tu lista de distribuidores se guarde en el sistema backend y coincida con la lista que proporcionaste. La lista de distribuidores proporcionada debe incluir el valor del indicador de intercambio de datos para cada distribuidor. |
2 | Actualiza automáticamente tu lista de distribuidores todos los días durante 3 días | El equipo DCP verifica que tu lista de distribuidores se guarde en el sistema backend diariamente. |
Piloto de distribuidores
La tabla a continuación describe los parámetros del piloto de distribuidores y sus validaciones correspondientes.
Lista de distribuidores
Parámetro | Valor |
|---|---|
Entorno | Producción |
Número de concesionarios | Todos tus concesionarios |
Duración | 2 semanas |
Validación 1 | El equipo de DCP verifica diariamente que tu lista de concesionarios esté guardada en el sistema backend. |
Validación 2 | Debes proporcionar tu lista de concesionarios en un archivo dos veces durante el período piloto. El equipo de DCP verifica que la lista guardada en el sistema backend coincida con la lista que proporcionaste. |
Validación 3 | Verifica que solo los concesionarios de Powersports sean enviados a la lista. |
Postman
Esta sección describe lo que está disponible en Postman para explorar la API.
Entornos
Un entorno de Postman está disponible para probar la API de Información DSP. Este entorno de Postman contiene variables utilizadas por las consultas y está configurado para conectarse al entorno de prueba.
Colecciones
La colección DSP - Información DSP incluye ejemplos de llamadas API para actualizar su lista de distribuidores.