API de cobertura de garantía de unidad
Comenzando
La API de Cobertura de Garantía de la Unidad permite al concesionario verificar la cobertura de garantía de una unidad antes de iniciar el proceso de reclamación de garantía. La solicitud se basa en el Número de Identificación del Vehículo (VIN) de la unidad.
El concesionario puede solicitar el estado de cobertura de garantía en cualquier unidad BRP usando el VIN de la unidad, incluso si la unidad no está en el inventario del concesionario.
La figura a continuación muestra cómo se presenta la información del estado de cobertura de garantía en BOSSWeb. Su DMS debe tener una pantalla similar a BOSSWeb para mostrar la información.
Como se muestra en la sección Cómo hacerlo una unidad puede tener más de una cobertura de garantía.
👉 Si la fecha actual es antes de la coverages.start_date o después de la coverages.end_date, la cobertura de la garantía no está activa.
¿Por 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:
Resumen empresarial
Tema | Descripción |
|---|---|
Alcance | Unidad (Norteamérica) |
Escenarios |
|
Funcionalidades principales |
|
Procesos empresariales compatibles |
|
Beneficios para concesionarios |
|
Beneficios para BRP |
|
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 utiliza Autenticación de Aplicaciones.
Necesitas un token de acceso válido antes de llamar a esta API o tienes 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: Cobertura de Unidad de Garantía
El recurso de Cobertura de Unidad de Garantía es devuelto por la API cuando se solicita el estado de cobertura de garantía para una unidad.
Representación JSON
{
"serial_no": "YDV01537J718",
"overall_coverage_start_date": "2018-07-31",
"overall_coverage_end_date": "2021-07-30",
"product_code": "00013JC00",
"product_description": "",
"product_line": "PERSONAL WATERCRAFTS",
"coverages": [
{
"coverage_code": "N;V;M",
"policy_code": "B.E.S.T. Promo - PWC - 24M",
"policy_name": "B.E.S.T. Promo - PWC - 24M",
"policy_type_code": "004",
"promo_code": "06-18-PWC-CA_COV3_FIN_OR_NPFIN",
"promo_descr": "3 YEARS COVERAGE PROMO FINANCING PARTICIPATING OR NOT",
"reference_no": "0004107460",
"months": "24",
"start_date": "2019-07-31",
"end_date": "2021-07-30",
"creation_date": "2022-02-18",
"deductible_amount": 50,
"last_change_date": "2022-07-06T20:29:59Z"
},
{
"coverage_code": "N;V;M",
"policy_code": "Standard - PWC - NA - OS - 12M",
"policy_name": "Standard - PWC - NA - OS - 12M",
"policy_type_code": "002",
"promo_code": "",
"promo_descr": "",
"reference_no": "WC-1491732",
"months": "12",
"start_date": "2018-07-31",
"end_date": "2019-07-30",
"creation_date": "2022-02-18",
"deductible_amount": 0,
"last_change_date": "2022-07-06T20:29:59Z"
}
]
}Propiedades
Property | Type | Definition | Notes |
|---|---|---|---|
serial_no | string | Unit serial number | Max Length: 18 |
overall_coverage_start_date | date | Overall coverage start date, in ISO 8601 format. | yyyy-mm-dd |
overall_coverage_end_date | date | Overall coverage end date, in ISO 8601 format. | yyyy-mm-dd |
product_code | string | Code that uniquely identifies a product. | Max Length:18 |
product_description | string | Description of the product. | Max Length:40 |
product_line | string | A value from the Product Lines table below. | Max Length: 15 |
coverages | array of objects | List of warranty coverages |
|
coverages.coverage_code | string | Warranty coverage code. One to three of the following codes: M - Exhaust Emissions N - Evaporative Emissions V - No Tracking Required If there is more than one code, they are separated with a ";". | Max Length: 6 Examples:
|
coverages.policy_code | string | The policy code usually describes the coverage duration terms. | Max Length: 80 |
coverages.policy_name | string | Value defining the details of a warranty coverage policy. | Max Length: 50 |
coverages.policy_type_code | string | A policy type code from the Policy Type Code table below. | Max Length: 3 |
coverages.promo_code | string | The promotion code. Empty if none was used. | Max Length: 80 |
coverages.promo_description | string | The promotion description. Empty if no promotion was used. | Max Length: 255 |
coverages.reference_no | string | The registration record under which this coverage was created. | Max Length: 50 |
coverages.months | string | Coverage duration of the policy for the given unit, in months. | Max Length: 2 |
coverages.start_date | date | Coverage start date of the policy, in ISO 8601 format. | yyyy-mm-dd |
coverages.end_date | date | Coverage end date of the policy, in ISO 8601 format. | yyyy-mm-dd |
coverages.creation_date | date | Date of creation, in ISO 8601 format. | yyyy-mm-dd |
coverages.deductible_amount | number | Deductible amount. | Format: 16.2 |
coverages.last_change_date | date-time | Last change date of the policy, in ISO 8601 UTC format. | Format: YYYY-MM-DDTHH:MM:SSZ |
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 todoterreno | 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 |
Código de Tipo de Póliza
Código | Descripción |
|---|---|
001 | PDI |
002 | Estándar |
003 | Limitada extendida |
004 | Promo B.E.S.T. |
005 | Venta minorista B.E.S.T. |
006 | Buena voluntad |
007 | Autonomía de buena voluntad |
008 | PA&A - 12 meses |
009 | PA&A - 24 meses |
010 | PA&A - 48 meses |
011 | PA&A - de por vida |
012 | Especial con garantía tipo Estándar |
013 | Especial con garantía tipo Limitada extendida |
014 | Especial con garantía tipo B.E.S.T. |
Referencia de la API
curl --location 'https://qa-cloud-api.brp.com/dcp/v4/unit/5KTWS1311JF538567/warranty-coverage' \
--header 'Dealer-Number: 0000690095' \
--header 'Authorization: Bearer REPLACE_ME'Cómo hacerlo
Esta sección proporciona información sobre cómo obtener resultados específicos con la API.
Obtener el estado de cobertura de la garantía
Get the estado de cobertura de garantía de una unidad en el entorno de producción.
curl --location 'https://cloud-api.brp.com/dcp/v4/unit/2BPSMLJB8JV000048/warranty-coverage?language=fr-CA' \
--header 'Dealer-Number: 0000691690' \
--header 'Authorization: Bearer REPLACE_ME'Manejo de Errores
Esta sección presenta varios escenarios de llamadas incorrectas o inapropiadas que resultan en mensajes de error y resultados incorrectos.
400 Solicitud Incorrecta
El código de estado 400 generalmente se observa 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; los más comunes se enumeran en la tabla a continuación.
Respuesta | Resolución |
|---|---|
Falta el número VIN en la ruta. {
"status": "400",
"id": "rrt-074faba1d0796ac77-c-ea-24394-1768654-1",
"title": "bad_request",
"meta": {
"service": "20",
"detail": "Ruta no encontrada."
}
} | Asegúrese de que el VIN esté agregado a la ruta. |
Falta el número de distribuidor en el encabezado. {
"status": "400",
"id": "rrt-07cdd77f98c381924-d-ea-22528-1563912-1",
"title": "bad_request",
"meta": {
"service": "01",
"detail": "falló la validación de la solicitud",
"payload": {
"details": [
{
"message": "El parámetro de encabezado 'Dealer-Number' es obligatorio en la ruta '/unit/{VIN}/warranty-coverage' pero no se encontró en la solicitud.: []"
}
]
}
}
} | Agregue el parámetro de encabezado Dealer-Number con un número de distribuidor válido. |
401 No autorizado
El código de estado de error 401 No autorizado se devuelve cuando intenta 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 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
El código de estado 404 No Encontrado se devuelve cuando no se encuentra el estado de cobertura de garantía para el VIN proporcionado.
{
"status": "404",
"id": "rrt-07cdd77f98c381924-d-ea-22528-1563968-1.1",
"title": "not_found",
"meta": {
"service": "20",
"detail": "No record was found for the serial number A1B2C3"
}
}El concesionario puede haber cometido un error al ingresar el VIN, o la unidad no es un producto BRP o es demasiado antigua.
Debe informar el error al usuario para permitirle intentarlo nuevamente.
Requisitos DSP
Requisitos Funcionales
ID | Tipo | Requisito |
|---|---|---|
1 | Obligatorio | Cuando el código de estado 404 No Encontrado es devuelto por la API, el error debe mostrarse en la interfaz de usuario. |
2 | Obligatorio | El concesionario debe poder visualizar el estado de la cobertura de garantía de una unidad basándose en el número de serie (VIN). |
Actividades de Certificación
Esta sección presenta todas las actividades de certificación y validaciones que deben completarse para certificar la API.
Aseguramiento de la Calidad
Las pruebas enumeradas en la tabla a continuación deben realizarse correctamente en el entorno de prueba antes de que pueda comenzar la fase piloto del distribuidor.
ID | Prueba | Resultado Esperado |
|---|---|---|
1 | Obtenga el estado de cobertura de la garantía para al menos 3 de estos VIN:
| Proporcione capturas de pantalla para cada VIN. Las capturas deben mostrar la información completa del estado de cobertura de la garantía. |
Piloto del Distribuidor
La siguiente tabla describe los parámetros y validaciones del piloto de concesionarios.
Parámetro | Valor |
|---|---|
Ambiente | Producción |
Número de concesionarios | 1 a 3 |
Duración | 1 semana |
Validación 1 | Proporcionar capturas de pantalla de al menos 5 consultas de cobertura de garantía por cada concesionario. La captura de pantalla debe mostrar la información completa del estado de cobertura de la garantía. |
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 Cobertura de Garantía. Este entorno de Postman contiene variables utilizadas por las consultas y está configurado para conectarse al entorno de prueba.
Colecciones
La colección DMS - Cobertura de Garantía incluye ejemplos de llamadas a la API para recuperar información del distribuidor.