API de Cobertura de Garantia de Unidade

30 min

Introdução

A API de Cobertura de Garantia da Unidade permite que o concessionário verifique a cobertura de garantia de uma unidade antes de iniciar o processo de solicitação de garantia. A solicitação é baseada no Número de Identificação do Veículo (VIN) da unidade.

O concessionário pode solicitar o status da cobertura de garantia em qualquer unidade BRP usando o VIN da unidade, mesmo que a unidade não esteja no inventário do concessionário.

A figura abaixo mostra como as informações de status da cobertura de garantia são apresentadas no BOSSWeb. Seu DMS deve ter uma tela semelhante ao BOSSWeb para exibir as informações.

Como mostrado na seção Como Fazer , uma unidade pode ter mais de uma cobertura de garantia.

👉 Se a data atual for antes da coverages.start_date ou depois da coverages.end_date, a cobertura da garantia não está ativa.

Por onde começar? Leia isto primeiro!

Antes de começar a trabalhar nesta API, você precisa ler as seguintes seções, caso ainda não as tenha visto:

Comece Aqui Com Leitura Obrigatória!
Informações Técnicas para informações técnicas gerais sobre a API e os ambientes.
Autenticação e Credenciais para detalhes sobre autenticação e credenciais.
Processo de Certificação para detalhes sobre o processo de certificação e o Jira.
Obtendo Suporte para detalhes sobre como obter ajuda e o Jira.

Resumo de Negócios

Tópico	Descrição
Escopo	Unidade (América do Norte)
Cenários	Módulo de Garantia do DMS: verificar o status de cobertura de garantia da unidade antes de iniciar uma solicitação de garantia
Funcionalidades principais	Status de cobertura de garantia da unidade
Processos de negócio suportados	Solicitação de garantia da unidade
Benefícios para concessionárias	Menos solicitações de garantia recusadas Economia de tempo no gerenciamento de garantias
Benefícios para a BRP	Menos solicitações de garantia recusadas

Informações Técnicas

Características

Tipo de API	Tipo de DSP	Versão DCP	Complexidade
Obter dados do BRP	DMS	V3 - Internacional	Baixa
Enviar dados ao BRP	CRM	V4 - América do Norte	Um pouco mais
Transação com BRP			Um pouco mais

Autenticação

A API está usando Autenticação de Aplicação.

Você precisa de um token de acesso válido antes de chamar esta API ou você deve chamar a API de Autenticação de Aplicativos para obter um.

O token de acesso é válido por 30 minutos! (1799 segundos)

URL Base

Teste	https://qa-cloud-api.brp.com/dcp/<v3 ou v4>
Produção	https://cloud-api.brp.com/dcp/<v3 ou v4>

Recurso: Cobertura da Unidade de Garantia

O recurso Cobertura da Unidade de Garantia é retornado pela API quando o status de cobertura de garantia de uma unidade é solicitado.

Representação 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"
        }
    ]
}

Propriedades

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: "N;V;M" "V" "N"
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

Linhas de Produtos

Chave	Valor	Marca
2WV	Veículos de duas rodas	Can-Am On-Road
3WV	Veículos de três rodas	Can-Am On-Road
ATV	Veículos todo-terreno	Can-Am Off-Road
OE	Motores de popa	Sea-Doo
PTN	Barcos pontão	Sea-Doo
PWC	Embarcações pessoais	Sea-Doo
SNO	Motos de neve	Ski-Doo
SSV	Veículos side-by-side	Can-Am Off-Road

Código do Tipo de Apólice

Código	Descrição
001	PDI
002	Padrão
003	Garantia Estendida Limitada
004	Promoção B.E.S.T.
005	Varejo B.E.S.T.
006	Boa Vontade
007	Autonomia de Boa Vontade
008	PA&A - 12 meses
009	PA&A - 24 meses
010	PA&A - 48 meses
011	PA&A - vitalício
012	Especial com garantia do tipo Padrão
013	Especial com garantia do tipo Estendida Limitada
014	Especial com garantia do tipo B.E.S.T.

Referência da API

Get Warranty Coverage

Get the warranty coverage status for the unit identified by the provided VIN.

GET

/unit/{serial_no}/warranty-coverage

curl --location 'https://qa-cloud-api.brp.com/dcp/v4/unit/5KTWS1311JF538567/warranty-coverage' \
--header 'Dealer-Number: 0000690095' \
--header 'Authorization: Bearer REPLACE_ME'

Como Fazer

Esta seção fornece informações sobre como obter resultados específicos com a API.

Obter Status de Cobertura da Garantia

Obter o status de cobertura de garantia de uma unidade no ambiente de produção.

Obter status de cobertura da garantia

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'

Tratamento de Erros

Esta seção apresenta vários cenários de chamadas inadequadas ou incorretas, que resultam em mensagens de erro e resultados inválidos.

400 Requisição Inválida

O código de status 400 é geralmente observado durante o desenvolvimento e a integração e não deve ser recebido durante operações normais. A resposta retornada contém as informações necessárias para corrigir o problema.

Muitos problemas podem causar um código de status 400; os mais comuns estão listados na tabela abaixo.

Resposta	Resolução
Faltando o número VIN no caminho. { "status": "400", "id": "rrt-074faba1d0796ac77-c-ea-24394-1768654-1", "title": "má_requisição", "meta": { "service": "20", "detail": "Caminho não encontrado." } }	Certifique-se de que o VIN seja adicionado ao caminho.
Faltando o número do revendedor no cabeçalho. { "status": "400", "id": "rrt-07cdd77f98c381924-d-ea-22528-1563912-1", "title": "má_requisição", "meta": { "service": "01", "detail": "falha na validação da requisição", "payload": { "details": [ { "message": "O parâmetro de cabeçalho 'Dealer-Number' é obrigatório no caminho '/unit/{VIN}/warranty-coverage' mas não foi encontrado na requisição.: []" } ] } } }	Adicione o parâmetro de cabeçalho Dealer-Number com um número de revendedor válido.

401 Não Autorizado

O código de erro 401 Não Autorizado é retornado quando você tenta chamar a API com um access_token expirado.

Você precisa obter um novo access_token com uma chamada para a API de Autenticação de Aplicativos.

O código de status de erro 401 Unauthorized também é retornado se você não solicitou acesso à API criando um ticket no Jira do DCP.

Quando você estiver pronto para começar a trabalhar em uma API, deve criar um ticket de certificação no Jira, conforme descrito na seção Atividades de Certificação com o Jira.

Se você já começou a trabalhar em uma API e perdeu o acesso, crie um ticket de suporte conforme descrito na seção Abrir um Ticket de Suporte.

404 Não Encontrado

O código de status 404 Não Encontrado é retornado quando o status de cobertura da garantia não é encontrado para o VIN fornecido.

{
    "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"
    }
}

O concessionário pode ter cometido um erro ao inserir o VIN, ou a unidade não é um produto BRP ou é muito antiga.

Você deve informar o erro ao usuário para que ele tente novamente.

Requisitos DSP

Requisitos Funcionais

ID	Tipo	Requisito
1	Obrigatório	Quando o código de status 404 Não Encontrado for retornado pela API, o erro deve ser exibido na interface do usuário.
2	Obrigatório	O concessionário deve ser capaz de visualizar o status de cobertura da garantia de uma unidade com base no número de série (VIN).

Atividades de Certificação

Esta seção apresenta todas as atividades de certificação e validações que devem ser concluídas para certificar a API.

Garantia de Qualidade

Os testes listados na tabela abaixo devem ser realizados com sucesso no ambiente de teste antes que você possa iniciar a fase piloto do concessionário.

ID	Teste	Resultado Esperado
1	Obter o status da cobertura de garantia para pelo menos 3 destes VINs: YDV00007E921 2BPSULND3NV000007 3JBLGAR24FJ001892 3JBLGAR20LJ000105 2BPSUGLB5LV000533 2BPSUGLA3LV000148 2BXNBDD20KV000616 2BXNBDD24JV000908 3JBLGAR21GJ001530 5KTWS1311JF538567 YDV01537J718 3JB1GAN41MK000737 2BXNBDD21MV001552 2BPSAALA6LV001767	Forneça capturas de tela para cada VIN. As capturas de tela devem mostrar as informações completas do status de cobertura da garantia.

Piloto do Concessionário

A tabela abaixo descreve os parâmetros e validações do piloto do concessionário.

Parâmetro	Valor
Ambiente	Produção
Número de concessionários	1 a 3
Duração	1 semana
Validação 1	Fornecer capturas de tela de pelo menos 5 consultas de cobertura de garantia para cada concessionário. A captura de tela deve mostrar as informações completas do status de cobertura da garantia.

Postman

Esta seção descreve o que está disponível no Postman para explorar a API.

Ambientes

Um ambiente do Postman está disponível para testar a API de Cobertura de Garantia. Este ambiente do Postman contém variáveis usadas pelas consultas e está configurado para se conectar ao ambiente de teste.

Teste - Ambiente DSP

Coleções

A coleção DMS - Cobertura de Garantia inclui exemplos de chamadas de API para recuperar informações de concessionárias.

DMS - Cobertura de Garantia

Registro de Alterações

Revisão 1.0

Added

Primeira versão