API de distribuidores

43 min

Comenzando

La API de Concesionarios le proporciona la información más reciente sobre un concesionario BRP. Usted utiliza esta información del concesionario para varias funciones, como configuraciones y pedidos de piezas. La API cubre particularidades regionales que influyen en los parámetros del concesionario, como el idioma y la disponibilidad de métodos de envío.

Si el concesionario está activo, toda su información está disponible. Recibirá un mensaje de error si el concesionario está inactivo o si se utiliza un número de concesionario incorrecto para llamar a la API.

La API devuelve la siguiente información:

Información del concesionario

Información del socio

Información de métodos de envío

Líneas de productos

Fecha de la última actualización

La API NO devuelve la siguiente información:

Sitio web

Correo electrónico

Número de teléfono

Atributos de ventas

¿Dónde empezar? ¡Léeme primero!

Antes de empezar a trabajar con esta API, debes leer las siguientes secciones si aún no las has revisado:

¡Comienza aquí con la lectura obligatoria!
Información Técnica para información técnica general sobre la API y los entornos.
Autenticación y Credenciales para detalles sobre autenticación y credenciales.
Proceso de Certificación para detalles sobre el proceso de certificación y Jira.
Obteniendo Apoyo para detalles sobre cómo obtener ayuda y Jira.

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 Aplicaciones.

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 or v4>
Producción	https://cloud-api.brp.com/dcp/<v3 or v4>

Recurso: Concesionarios

El recurso de concesionario proporciona información básica sobre el concesionario, el socio del concesionario para información de envío y facturación, y los métodos de envío disponibles. Incluye solo concesionarios minoristas: los concesionarios únicamente de servicio o de alquiler no están incluidos en el servicio.

Representación 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"
    }
}

Propiedades

❗ Los campos en azul se envían solo por la versión V4 de la API de Concesionarios ❗

Propiedad	Tipo	Definición	Notas
dealer_no	string	Número de concesionario.	Longitud:10
dealer_name	string	Nombre comercial del concesionario.	Longitud máxima:80
legal_name	string	Nombre legal del cliente para fines financieros.	Longitud máxima:80
address	object	Dirección del concesionario
address.street	string	Dirección (calle)	Longitud máxima:60
address.city	string	Ciudad	Longitud máxima:40
address.state	string	Código que identifica de manera única una provincia/estado en un país, en formato ISO 3166-2 (segunda parte).	Longitud máxima:3
address.country	string	Código que identifica de manera única un país, en formato ISO 3166-1.	Longitud máxima:2
address.postal_code	string	Código postal del cliente.	Longitud máxima:10
language	string	Idioma de comunicación del cliente según código ISO (ISO-639-1)	Formato XX
partners	lista de objetos	Información de socios
partners.partner_type	string	Código que identifica los tipos de socios. Uno de: BP SH SP	Longitud máxima:2
partners.partner_no	string	Número de cliente del socio.	Longitud máxima:10
partners.partner_name	string	Nombre comercial del socio.	Longitud máxima:35
partners.address	object	Dirección del socio.
partners.address.street	string	Dirección (calle) - 1ª línea	Longitud máxima:60
partners.address.city	string	Ciudad	Longitud máxima:40
partners.address.state	string	Código que identifica de manera única una provincia/estado en un país, en formato ISO 3166-2.	Longitud máxima:3
partners.address.country	string	Código que identifica de manera única un país, en formato ISO 3166-1.	Longitud máxima:2
partners.address. postal_code	string	Código postal del socio.	Longitud máxima:10
shipping_methods	lista de objetos	Información sobre los métodos de envío disponibles para este cliente.
shipping_methods .shipping_method	string	Código que identifica de manera única el método de envío mediante el cual se puede entregar la orden de venta. La lista de valores válidos es diferente para cada concesionario, dependiendo de su localización.	Longitud máxima:2
shipping_methods .shipping_method_descr	string	Descripción del método de envío	Longitud máxima:20
product_lines	lista de string	Código que identifica de manera única una línea de producto.	Longitud máxima:3
ev_qualification_level	string	Nivel de calificación del concesionario para el vehículo eléctrico. Consulte la tabla a continuación.	Longitud: 2
business_hours	lista de string	Una matriz de cadenas con los días y horas en que el concesionario está abierto. El concesionario está cerrado si las horas son "00:00-00:00".
service_hours	lista de string	Una matriz de cadenas con los días y horas en que el departamento de servicio del concesionario está abierto. El departamento de servicio está cerrado si las horas son "00:00-00:00".
sales_attributes	object	Información sobre las zonas de ventas.
sales_attributes. sales_territory_code	string	Ver la sección Códigos de Territorio de Ventas a continuación.	Longitud: 3
sales_attributes. sales_district	string	Ver la sección Distrito de Ventas a continuación.	Longitud: 6
sales_attributes. sales_office	string	Ver la sección Oficina de Ventas a continuación.	Longitud: 4
sales_attributes. sales_group	string	Ver la sección Grupo de Ventas a continuación.	Longitud: 3

Tipos de socios

Código	Valor	Descripción
SP	Cliente comprador	Define el socio del cual se ordenan las unidades y/o PA&A y puede realizar todas las demás funciones. El Cliente Comprador es quien realiza el pedido de ventas.
SH	Destinatario	Define el socio al cual se envían únicamente las unidades y/o PA&A. El Destinatario es quien recibe las mercancías.
BP	Cliente facturado	Define el socio al cual se facturan únicamente las unidades y/o PA&A. El Cliente Facturado es quien recibe las facturas.

Métodos de envío - Norteamérica

Código V3	Código V4	Descripción	Uso
01	S1	Terrestre Acelerado	Actualización de primer nivel desde el servicio estándar nacional: Servicio de Envío: Envío terrestre estándar. Normalmente paquetes terrestres/LTL. Se cobran tarifas de manejo de carga a los clientes.
02	S2	Vehículo Fuera de Servicio	El envío más rápido disponible. Comúnmente usado cuando los retrasos son críticos (escenarios de vehículo fuera de servicio): Servicio de Envío: lo más rápido posible, a menudo llamado Exprés (Purolator) o Next Day Air (UPS). Opción de actualización desde el Método de Envío 01/S1. Se cobran tarifas de manejo de carga a los clientes.
03	S3	Vehículo Fuera de Servicio Sábado	Igual que Vehículo Fuera de Servicio con la capacidad de recibirse en sábado.

Métodos de envío - Internacional

Organización de Ventas	Código V3	Descripción
6030 - Escandinavia	50	itella
6030 - Escandinavia	51	posten_logistik
6030 - Escandinavia	52	terrestre
6030 - Escandinavia	53	aéreo
6030 - Escandinavia	54	terrestre
6030 - Escandinavia	55	aéreo
6030 - Escandinavia	59	terrestre
6030 - Escandinavia	60	aéreo
6050 - Europa (emea)	30	regular
6050 - Europa (emea)	33	urgente
7080 - Asia-Pacífico (apac)	38	regular
7080 - Asia-Pacífico (apac)	39	urgente
7080 - Asia-Pacífico (apac)	40	regular
7080 - Asia-Pacífico (apac)	82	stock
7080 - Asia-Pacífico (apac)	90	stock
8070 - México	92	regular
8070 - México	93	aéreo
8070 - México	94	urgente
8075 - Brasil	63	aéreo_azul_cargo
8075 - Brasil	77	sedex_correios
8075 - Brasil	78	padrão_rodoviário

Líneas de productos

Clave	Valor	Marca
2WV	Vehículos de dos ruedas	Can-Am On-Road
3WV	Vehículos de tres ruedas	Can-Am On-Road
ATV	Vehículos todo terreno	Can-Am Off-Road
OE	Motores fuera de borda	Sea-Doo
PTN	Barcos pontón	Sea-Doo
PWC	Motocicletas acuáticas personales	Sea-Doo
SNO	Motos de nieve	Ski-Doo
SSV	Vehículos side-by-side	Can-Am Off-Road

Nivel de Calificación de Vehículos Eléctricos (EV)

El concesionario debe estar cualificado para vender y brindar soporte a los productos de vehículos eléctricos.

❗ Existen otras consideraciones y reglas relacionadas con la capacidad del concesionario para solicitar y mantener vehículos eléctricos y repuestos que están fuera del alcance de esta documentación. Esta información se proporciona para darte una idea del nivel de cualificación.

Los concesionarios conocerán su nivel de cualificación y lo que pueden y no pueden hacer ❗

Nivel de calificación	Nombre	Descripción
E0 o vacío	No calificado	El concesionario no puede pedir piezas y unidades de vehículos eléctricos.
E1	Acceso	El concesionario no puede pedir piezas y unidades de vehículos eléctricos.
E2	Calificado	El concesionario puede pedir piezas y unidades con limitaciones y no puede realizar reclamaciones de garantía.
E3	Experto	El concesionario puede pedir cualquier pieza y unidad y puede realizar reclamaciones de garantía.

Códigos de Territorio de Ventas

El Código de Territorio de Ventas vincula al cliente y al material. Se utiliza principalmente de forma interna para restringir la lista de modelos que un cliente puede ver.

Código	Valor	Región	Definición
1	Canadá	NA	Distribuidor Directo y Distribuidores en el Grupo de Ventas NAA.
3	EE. UU. Este	NA	Distribuidor Directo en el Grupo de Ventas NAB.
4	EE. UU. Centro	NA	Distribuidor Directo en el Grupo de Ventas NAC.
5	EE. UU. Oeste	NA	Distribuidor Directo en el Grupo de Ventas NAD.
301	Distribuidores SCAND - PWS	EMEA	Distribuidor Directo en la Oficina de Ventas EA01 - Europa del Norte
302	Cuenta Especial SCAND - PWS	EMEA	Cuenta especial en la Oficina de Ventas EA01 - Europa del Norte.
501	Distribuidores WEMEA - PWS	EMEA	Distribuidor Directo en la Oficina de Ventas EA03 - Europa Occidental, Medio Oriente y África
504	Rusia - PWS	EMEA	Distribuidor Directo y Distribuidores en la Oficina de Ventas EA04 - País Rusia
700	México - Distribuidores	LATAM	Distribuidor Directo en la Oficina de Ventas LA02 - País México.
750	Brasil - Distribuidores	LATAM	Distribuidor Directo en la Oficina de Ventas LA02 - País Brasil.
800	AUS - Melbourne	APAC	Distribuidor Directo que recibe productos del Centro de Distribución de Melbourne (Ubicación de Almacén P002) en Australia - Oficinas de Ventas AP01
801	AUS - Brisbane	APAC	Distribuidor Directo que recibe productos del Centro de Distribución de Brisbane (Ubicación de Almacén P003) en Australia - Oficinas de Ventas AP01
802	AUS - Sídney	APAC	Distribuidor Directo que recibe productos del Centro de Distribución de Sídney (Ubicación de Almacén 2001) en Australia - Oficinas de Ventas AP01
810	NZ - Auckland	APAC	Distribuidor Directo que recibe productos del Centro de Distribución de Auckland (Ubicación de Almacén 2001) en Nueva Zelanda - Oficinas de Ventas AP05.
811	NZ - Christchurch	APAC	Distribuidor Directo que recibe productos del Centro de Distribución de Christchurch (Ubicación de Almacén P012) en Nueva Zelanda - Oficinas de Ventas AP05.

Distrito de Ventas

El Distrito de Ventas representa la entidad global con una relación comercial con el cliente. Un distrito de ventas es una estructura independiente

Código	Descripción	Explicaciones
NA0001	Norteamérica	Región de Norteamérica (EE. UU. y Canadá)
EA0001	EMEA	Representa la región de Europa, Oriente Medio y África
AP0001	APAC	Representa la región de Asia-Pacífico
LA0001	LATAM	Representa la región de Latinoamérica

Oficina de Ventas

La Oficina de Ventas representa un área geográfica más pequeña dentro de cada estructura global. Una oficina de ventas está asignada a un área de ventas.

Código	Valor	Descripción
NA01	Canadá	Asociado con la región de Norteamérica y representa a Canadá.
NA02	EE. UU.	Asociado con la región de Norteamérica y representa a los Estados Unidos.
NA98	Otro NA	Asociado con grupos de clientes específicos de Norteamérica que no requieren una oficina de ventas para hacer negocios.
EA01	Escandinavia	Asociado con la región EMEA y representa a Europa del Norte
EA02	Rusia	Asociado con la región EMEA y representa a todo el país de Rusia
EA03	WEMEA	Asociado con la región EMEA y representa a Europa Occidental, Oriente Medio y África para PAA
EA04	EMEA Dlr D	Asociado con la región EMEA y representa Distribuidor Directo para FG/Unidades
EA05	EMEA Dist Ex-DC	Asociado con la región EMEA y representa Distribuidores que reciben productos desde el Centro de Distribución para FG/Unidades
EA06	EMEA Dist Ex-Manuf	Asociado con la región EMEA y representa Distribuidores que reciben productos desde la planta de manufactura para FG/Unidades.
AP01	Australia	Asociado con la región APAC y representa a Australia.
AP02	EAPI	Asociado con la región APAC y representa a las Islas Emergentes del Asia Pacífico.
AP03	Japón	Asociado con la región APAC y representa a Japón.
AP04	China	Asociado con la región APAC y representa a China.
AP05	Nueva Zelanda	Asociado con la región APAC y representa a Nueva Zelanda.
LA01	CSC	Asociado con la región LATAM y representa a Centroamérica, Sudamérica y el Caribe.
LA02	México	Asociado con la región LATAM y representa a México.
LA03	Brasil	Asociado con la región LATAM y representa a todo el país de Brasil
LA98	Otro LATAM	Asociado con la región LATAM; ciertos grupos de clientes no requieren una oficina de ventas para hacer negocios.

Grupo de Ventas

El Grupo de Ventas representa una agrupación de países dentro del área geográfica. Puede ser un país o un grupo de países. A un grupo de ventas se le asigna una oficina de ventas.

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.

Limitaciones y restricciones

Tipo de distribuidor devuelto

Solo se devuelven los distribuidores minoristas. Otros tipos de distribuidores, como los de servicio y alquiler, no son devueltos por la API y se devuelve el código de estado “no encontrado”.

Referencia de API

Get a Dealer

Get a dealer information.

GET

/dealer/{dealer_no}

curl --location 'https://qa-cloud-api.brp.com/dcp/v4/dealer/0000695370?language=fi-FI' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Tablas de referencia

Idiomas

Idioma en código de idioma ISO (ISO-639-1 + ISO 3166-1)

Formato: xx-XX

xx: código de idioma en minúsculas

XX: código de país en mayúsculas

Valores de código de idioma admitidos

Código	Idioma
de	Alemán
en	Inglés
es	Español
fi	Finés
fr	Francés
it	Italiano
nl	Neerlandés
no	Noruego
pt	Portugués (Brasil)
sv	Sueco

Cómo hacerlo

Esta sección proporciona información sobre cómo obtener resultados específicos con la API.

Obtener distribuidor con el idioma predeterminado (EN)

Esta consulta solicita la información del distribuidor utilizando el número de distribuidor sin tener que especificar el idioma.

Get Dealer with Default Language (EN)

curl --location 'https://qa-cloud-api.brp.com/dcp/v4/dealer/0000690009' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Obtener información del concesionario en un idioma específico

Esta consulta solicita información sobre el concesionario usando el número de concesionario y un idioma.

Excepción: Si la información no está disponible en el idioma solicitado, la información se devuelve en inglés.

Get Dealer information in a specific language

curl --location 'https://qa-cloud-api.brp.com/dcp/v4/dealer/0000695370?language=fi-FI' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \

Manejo de errores

Esta sección presenta varios escenarios de llamadas incorrectas o erróneas, que dan como resultado mensajes de error y resultados incorrectos.

400 Solicitud Incorrecta

El código de estado 400 se observa generalmente durante el desarrollo y la integración y no debería recibirse durante las operaciones normales. La respuesta devuelta contiene la información necesaria para corregir el problema.

Muchos problemas pueden causar un código de estado 400, y los más comunes se enumeran en la tabla a continuación.

Respuesta	Resolución
Se devuelve si el campo del número de concesionario está vacío. { "status": "400", "id": "rrt-074faba1d0796ac77-c-ea-24396-1520447-1", "title": "bad_request", "meta": { "service": "00", "detail": "Ruta no encontrada." } }	El problema es que la ruta de la consulta no proporciona un número de concesionario. Debe proporcionar un número de concesionario.
Se devuelve si el formato del idioma no es válido. { "status": "400", "id": "rrt-06c1b7ac7365beb8f-d-ea-22696-1239306-1", "title": "bad_request", "meta": { "service": "01", "detail": "falló la validación de la solicitud", "payload": { "details": [ { "message": "La expresión regular ECMA 262 \"^[a-z]{2}-[A-Z]{2}$\" no coincide con la cadena de entrada \"ab-ABC\": []" } ] } } }	El formato válido del idioma es el siguiente Formato: xx-XX xx: código de idioma en minúsculas XX: código de país en mayúsculas Debe introducirse un formato de idioma válido para producir una respuesta adecuada.
Se devuelve si el parámetro no es válido { "status": "400", "id": "rrt-00a574511a562afb5-b-ea-22208-2505617-1", "title": "bad_request", "meta": { "service": "01", "detail": "falló la validación de la solicitud", "payload": { "details": [ { "message": "el parámetro de consulta es inesperado : lang: []" } ] } } }	Lang es un parámetro no válido. Debe utilizarse el parámetro language para obtener una respuesta válida.

401 No Autorizado

El código de estado de error 401 No Autorizado se devuelve cuando intentas llamar a la API con un access_token expirado.

Tienes que obtener un nuevo access_token con una llamada a la API de Autenticación de Aplicaciones.

El código de estado de error 401 No Autorizado también se devuelve si no solicitaste acceso a la API creando un ticket en el Jira de DCP.

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 acceso, crea un ticket de soporte como se describe en la sección Abrir un Ticket de Soporte.

404 No Encontrado

El código de estado 404 No Encontrado se devuelve cuando no se encuentra el número de distribuidor.

{
    "status": "404",
    "id": "rrt-074faba1d0796ac77-c-ea-24397-1607550-1.1",
    "title": "not_found",
    "meta": {
        "service": "06",
        "detail": "Dealer 1234567890 not found."
    }
}

Debe introducirse un número de distribuidor correcto para que la API devuelva una respuesta adecuada. Para que un número de distribuidor sea correcto, debe encontrarse en la lista de distribuidores.

Un número de distribuidor debe tener 10 caracteres y no contiene ninguna letra.

Si el número de distribuidor tiene menos de 10 caracteres, antepóngale '0'.

Requisitos DSP

Requisitos Funcionales

ID	Tipo	Notas
1	Obligatorio	La información del concesionario debe actualizarse diariamente y debe utilizarse para otras llamadas y funciones de la API DCP. 👉 Vea el Requisito Funcional ID 4 a continuación. Por ejemplo, los métodos de envío permitidos del concesionario y las líneas de productos permitidas deben obtenerse de la información del concesionario.
2	Obligatorio	La actualización de la información del concesionario debe ser automática, sin acción manual por parte del concesionario.
3	Obligatorio	Si solicita la información de un concesionario y obtiene el código de estado 403 Not Found, comuníquese con el equipo de DCP en [email protected]. El concesionario puede que ya no sea un concesionario BRP y puede volverse inactivo.
4	Opcional	Si no es práctico llamar a la API de Concesionarios diariamente y guardar la información de los concesionarios, su DMS puede llamar a la API de Concesionarios para recuperar la información cuando sea necesario. Por ejemplo, la API de Concesionarios puede llamarse cuando el concesionario entra en la pantalla de Pedido de Piezas para actualizar los métodos de envío permitidos y las líneas de productos permitidas.

Actividades de certificación

Las pruebas enumeradas en la tabla a continuación deben completarse exitosamente en el entorno de prueba antes de que pueda comenzar la fase piloto del concesionario.

Estas pruebas se realizan utilizando sus entornos de prueba y los entornos de prueba de la API de DCP (QA).

Las pruebas son ligeramente diferentes entre las versiones V3 y V4 de DCP. Para V3, se utilizan distribuidores internacionales.

Para V4, se utilizan distribuidores de Norteamérica.

Garantía de calidad para V3

ID	Prueba	Resultado esperado
1	Obtener la información del concesionario número 0000701580, un concesionario español.	Mostrar la información del concesionario, incluyendo los métodos de envío y las líneas de productos, como mínimo. La información puede mostrarse en la interfaz de usuario, una base de datos o un archivo de registro. Las descripciones de los métodos de envío deben estar en inglés.
2	Obtener la información del concesionario número 0000706567, un concesionario alemán, con el idioma de-DE.	Mostrar la información del concesionario, incluyendo los métodos de envío y las líneas de productos, como mínimo. La información puede mostrarse en la interfaz de usuario, una base de datos o un archivo de registro. Las descripciones de los métodos de envío deben estar en alemán.
3	Obtener la información del concesionario número 0000123456, un concesionario no válido.	Mostrar el registro de errores y cómo se gestiona el estado 404 No Encontrado en la aplicación.
4	Actualización diaria automática.	Mostrar evidencia de que la API de Concesionarios se llama automáticamente todos los días.

Aseguramiento de la calidad para V4

ID	Prueba	Resultado esperado
1	Obtener la información para el distribuidor número 0000691756, un distribuidor canadiense, con el idioma fr-CA.	Mostrar la información del distribuidor, incluyendo los métodos de envío y las líneas de productos, como mínimo. La información puede mostrarse en la interfaz de usuario, una base de datos o un archivo de registro. Las descripciones de los métodos de envío deben estar en francés.
2	Obtener la información para el distribuidor número 0000690009, un distribuidor de EE. UU.	Mostrar la información del distribuidor, incluyendo los métodos de envío y las líneas de productos, como mínimo. La información puede mostrarse en la interfaz de usuario, una base de datos o un archivo de registro. Las descripciones de los métodos de envío deben estar en inglés.
3	Obtener la información para el distribuidor número 0000123456, un distribuidor no válido	Mostrar el registro de errores y cómo se maneja el estado 404 No Encontrado en la aplicación.
4	Actualización diaria automática.	Mostrar evidencia de que la API de Distribuidores se llama automáticamente todos los días.

Piloto de Concesionario

La tabla a continuación describe los parámetros y las validaciones del piloto de concesionario.

Parámetro	Valor
Entorno	Producción
Número de distribuidores	1 a 3
Duración	1 semana
Validación 1	DCP verifica que la API de Distribuidores se llame todos los días para cada distribuidor en el piloto
Validación 2	DCP verifica que la información del distribuidor, principalmente los métodos de envío y las líneas de productos, esté disponible en el DMS.

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 Concesionarios. Este entorno de Postman contiene variables utilizadas por las consultas y está configurado para conectarse al entorno de prueba.

Prueba - Entorno DSP

Colecciones

La colección DMS - Dealers contiene ejemplos de llamadas API para obtener información de concesionarios.

DMS - Dealers

Registro de Cambios de la API

Revisión 1.2

Added

Se añadieron campos (nivel de calificación de Vehículo Eléctrico (EV), horas comerciales y de servicio, e información de la zona de ventas) en la versión V4 de la API.

Revisión 1.1

Fixed

Se alineó la estructura de la respuesta del mensaje de error con el estándar descrito en la sección de Información Técnica.

Revisión 1.0