API de Concessionárias
Introdução
A API de Concessionárias fornece as informações mais recentes sobre uma concessionária BRP. Você usa essas informações para várias funções, como configurações e pedidos de peças. A API abrange particularidades regionais que influenciam os parâmetros da concessionária, como idioma e disponibilidade de métodos de envio.
Se a concessionária estiver ativa, todas as suas informações estarão disponíveis. Você receberá uma mensagem de erro se a concessionária estiver inativa ou se o número incorreto for usado para chamar a API.
As seguintes informações são retornadas pela API:
- Informações da concessionária
- Informações do parceiro
- Informações sobre métodos de envio
- Linhas de produtos
- Data da última atualização
A API NÃO retorna as seguintes informações:
- Website
- Número de telefone
- Atributos de vendas
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:
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 para o BRP | CRM | V4 - América do Norte | Um pouco mais |
Transação com o BRP | | | Um tanto 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 precisa 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: Concessionárias
O recurso de concessionária fornece informações básicas sobre a concessionária, parceiro da concessionária para informações de envio e faturamento, e métodos de envio disponíveis. Ele inclui apenas concessionárias de varejo: concessionárias somente de serviço ou aluguel não estão incluídas no serviço.
Representação 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"
}
}Propriedades
❗ Os campos em azul são enviados somente pela versão V4 da API de Concessionárias ❗
Propriedade | Tipo | Definição | Notas |
|---|---|---|---|
dealer_no | string | Número do concessionário. | Comprimento:10 |
dealer_name | string | Nome comercial do concessionário. | Comprimento Máx.:80 |
legal_name | string | O nome legal do cliente para fins financeiros. | Comprimento Máx.:80 |
address | object | Endereço do concessionário |
|
address.street | string | Endereço da rua | Comprimento Máx.:60 |
address.city | string | Cidade | Comprimento Máx.:40 |
address.state | string | Código que identifica de forma exclusiva uma província/estado em um país, no formato ISO 3166-2 (2ª parte). | Comprimento Máx.:3 |
address.country | string | Código que identifica de forma exclusiva um país no formato ISO 3166-1. | Comprimento Máx.:2 |
address.postal_code | string | Código postal do cliente. | Comprimento Máx.:10 |
language | string | Idioma de comunicação do cliente no código de idioma ISO (ISO-639-1) | Formato XX |
partners | lista de objetos | Informações dos parceiros |
|
partners.partner_type | string | Código que identifica os tipos de parceiros. Um de:
| Comprimento Máx.:2 |
partners.partner_no | string | Número do cliente parceiro. | Comprimento Máx.:10 |
partners.partner_name | string | Nome comercial do parceiro. | Comprimento Máx.:35 |
partners.address | object | Endereço do parceiro. |
|
partners.address.street | string | Endereço da rua (1ª linha) | Comprimento Máx.:60 |
partners.address.city | string | Cidade | Comprimento Máx.:40 |
partners.address.state | string | Código que identifica de forma exclusiva uma província/estado em um país, no formato ISO 3166-2. | Comprimento Máx.:3 |
partners.address.country | string | Código que identifica de forma exclusiva um país no formato ISO 3166-1. | Comprimento Máx.:2 |
partners.address. postal_code | string | Código postal do parceiro. | Comprimento Máx.:10 |
shipping_methods | lista de objeto | Informações sobre os métodos de envio disponíveis para este cliente. |
|
shipping_methods .shipping_method | string | Código que identifica de forma exclusiva o método de envio no qual o pedido pode ser entregue. A lista de valores válidos é diferente para cada concessionário, com base na localização do mesmo. | Comprimento Máx.:2 |
shipping_methods .shipping_method_descr | string | Descrição do método de envio | Comprimento Máx.:20 |
product_lines | lista de string | Código que identifica de forma exclusiva uma Linha de Produto. | Comprimento Máx.:3 |
ev_qualification_level | string | O nível de qualificação do concessionário para veículo elétrico. Consulte a tabela abaixo. | Comprimento: 2 |
business_hours | lista de string | Uma matriz de strings com os dias e horas de funcionamento da concessionária. A concessionária está fechada se as horas forem "00:00-00:00". | |
service_hours | lista de string | Uma matriz de strings com os dias e horas de funcionamento do departamento de serviço. O departamento está fechado se as horas forem "00:00-00:00". | |
sales_attributes | object | Informações sobre as zonas de vendas. | |
sales_attributes. sales_territory_code | string | Veja a seção Códigos de Território de Vendas abaixo. | Comprimento: 3 |
sales_attributes. sales_district | string | Veja a seção Distrito de Vendas abaixo. | Comprimento: 6 |
sales_attributes. sales_office | string | Veja a seção Escritório de Vendas abaixo. | Comprimento: 4 |
sales_attributes. sales_group | string | Veja a seção Grupo de Vendas abaixo. | Comprimento: 3 |
Tipos de Parceiros
Código | Valor | Descrição |
|---|---|---|
SP | Comprador | Define o parceiro do qual as unidades e/ou PA&A são encomendadas e que pode executar todas as outras funções. O Comprador é quem faz o pedido de venda |
SH | Destinatário | Define o parceiro para o qual as unidades e/ou PA&A são enviadas apenas. O Destinatário é aquele para quem as mercadorias são enviadas |
BP | Faturamento | Define o parceiro para o qual as unidades e/ou PA&A são faturadas apenas. O Parceiro de Faturamento é aquele para quem as faturas são emitidas |
Métodos de Envio - América do Norte
Código V3 | Código V4 | Descrição | Uso |
|---|---|---|---|
01 | S1 | Ground Acelerado | Atualização de primeiro nível a partir do envio doméstico padrão:
|
02 | S2 | Veículo Parado | Envio mais rápido disponível. Comumente usado quando atrasos de envio são críticos (situações de veículo parado):
|
03 | S3 | Veículo Parado Sábado | Mesmo que Veículo Parado, com a capacidade de ser recebido no sábado. |
Métodos de Envio - Internacional
Organização de Vendas | Código V3 | Descrição |
|---|---|---|
6030 - Escandinávia | 50 | itella |
6030 - Escandinávia | 51 | posten_logistik |
6030 - Escandinávia | 52 | terrestre |
6030 - Escandinávia | 53 | aéreo |
6030 - Escandinávia | 54 | terrestre |
6030 - Escandinávia | 55 | aéreo |
6030 - Escandinávia | 59 | terrestre |
6030 - Escandinávia | 60 | aéreo |
6050 - Europa (emea) | 30 | regular |
6050 - Europa (emea) | 33 | urgente |
7080 - Ásia-Pacífico (apac) | 38 | regular |
7080 - Ásia-Pacífico (apac) | 39 | urgente |
7080 - Ásia-Pacífico (apac) | 40 | regular |
7080 - Ásia-Pacífico (apac) | 82 | estoque |
7080 - Ásia-Pacífico (apac) | 90 | estoque |
8070 - México | 92 | regular |
8070 - México | 93 | aéreo |
8070 - México | 94 | urgente |
8075 - Brasil | 63 | aereo_azul_cargo |
8075 - Brasil | 77 | sedex_correios |
8075 - Brasil | 78 | padrao_rodoviario |
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 pontoon | Sea-Doo |
PWC | Embarcações pessoais | Sea-Doo |
SNO | Snowmobiles | Ski-Doo |
SSV | Veículos side-by-side | Can-Am Off-Road |
Nível de Qualificação de Veículo Elétrico (EV)
O concessionário deve ser qualificado para vender e oferecer suporte aos produtos de veículos elétricos.
❗ Existem outras considerações e regras relacionadas à capacidade do concessionário de solicitar e manter veículos elétricos e peças que estão fora do escopo desta documentação. Estas informações são fornecidas para lhe dar uma ideia do nível de qualificação.
Os concessionários saberão seu nível de qualificação e o que podem ou não fazer ❗
Nível de Qualificação | Nome | Descrição |
|---|---|---|
E0 ou vazio | Não Qualificado | O concessionário não pode encomendar peças e unidades de VE. |
E1 | Acesso | O concessionário não pode encomendar peças e unidades de VE. |
E2 | Qualificado | O concessionário pode encomendar peças e unidades com limitações e não pode fazer reclamações de garantia. |
E3 | Especialista | O concessionário pode encomendar quaisquer peças e unidades e pode fazer reclamações de garantia. |
Códigos de Território de Vendas
O Código de Território de Vendas liga o cliente ao material. É usado principalmente internamente para restringir a lista de modelos que um cliente pode ver.
Código | Valor | Região | Definição |
|---|---|---|---|
1 | Canadá | NA | Dealer Direct e Distribuidores no Grupo de Vendas NAA. |
3 | EUA Leste | NA | Dealer Direct no Grupo de Vendas NAB. |
4 | EUA Central | NA | Dealer Direct no Grupo de Vendas NAC. |
5 | EUA Oeste | NA | Dealer Direct no Grupo de Vendas NAD. |
301 | SCAND Revendedores - PWS | EMEA | Dealer Direct no Escritório de Vendas EA01 - Norte da Europa |
302 | SCAND Conta Especial - PWS | EMEA | Conta especial no Escritório de Vendas EA01 - Norte da Europa. |
501 | WEMEA Revendedores - PWS | EMEA | Dealer Direct no Escritório de Vendas EA03 - Europa Ocidental, Oriente Médio e África |
504 | Rússia - PWS | EMEA | Dealer Direct e Distribuidores no Escritório de Vendas EA04 - Rússia |
700 | México - Revendedores | LATAM | Dealer Direct no Escritório de Vendas LA02 - México. |
750 | Brasil - Revendedores | LATAM | Dealer Direct no Escritório de Vendas LA02 - Brasil. |
800 | AUS - Melbourne | APAC | Dealer Direct recebendo produtos do Centro de Distribuição de Melbourne (Local de Armazenamento P002) na Austrália - Escritórios de Vendas AP01 |
801 | AUS - Brisbane | APAC | Dealer Direct recebendo produtos do Centro de Distribuição de Brisbane (Local de Armazenamento P003) na Austrália - Escritórios de Vendas AP01 |
802 | AUS - Sydney | APAC | Dealer Direct recebendo produtos do Centro de Distribuição de Sydney (Local de Armazenamento 2001) Austrália - Escritórios de Vendas AP01 |
810 | NZ - Auckland | APAC | Dealer Direct recebendo produtos do Centro de Distribuição de Auckland (Local de Armazenamento 2001) na Nova Zelândia - Escritórios de Vendas AP05. |
811 | NZ - Christchurch | APAC | Dealer Direct recebendo produto do Centro de Distribuição de Christchurch (Local de Armazenamento P012) na Nova Zelândia - Escritórios de Vendas AP05. |
Distrito de Vendas
O Distrito de Vendas representa a entidade global com uma relação comercial com o cliente. Um distrito de vendas é uma estrutura independente
Código | Descrição | Explicações |
|---|---|---|
NA0001 | América do Norte | Região da América do Norte (EUA e Canadá) |
EA0001 | EMEA | Representa as regiões Europa, Oriente Médio e África |
AP0001 | APAC | Representa a região Ásia-Pacífico |
LA0001 | LATAM | Representa a região da América Latina |
Escritório de Vendas
O Escritório de Vendas representa uma área geográfica menor dentro de cada estrutura global. Um escritório de vendas é atribuído a uma área de vendas.
Código | Valor | Descrição |
|---|---|---|
NA01 | Canadá | Associado à região da América do Norte e representa o Canadá. |
NA02 | EUA | Associado à região da América do Norte e representa os Estados Unidos. |
NA98 | Outros NA | Associado a grupos específicos de clientes da América do Norte que não requerem um escritório de vendas para negócios. |
Grupo de Vendas
O Grupo de Vendas representa um agrupamento de países dentro da área geográfica. Pode ser um país ou um grupo de países. Um grupo de vendas é atribuído a um escritório de vendas.
Código | Valor | Descrição |
|---|---|---|
NAA | Canadá | Associado à sub-região do Canadá e representa o Canadá. |
NAB | US Leste | Associado à Sub-Região dos EUA e representa a porção Leste dos EUA. Aqui estão os estados incluídos: Alabama (AL), Connecticut (CT), Distrito de Colúmbia (DC), Delaware (DE), Flórida (FL), Geórgia (GA), Massachusetts (MA), Maryland (MD), Maine (ME), Carolina do Norte (NC), New Hampshire (NH), Nova Jérsei (NJ), Nova Iorque (NY), Pensilvânia (PA), Rhode Island (RI), Carolina do Sul (SC), Virgínia (VA), Vermont (VT) e Virgínia Ocidental (WV) |
NAC | US Central | Associado à Sub-Região dos EUA e representa a porção Central dos EUA. Aqui estão os estados incluídos: Arkansas (AR), Iowa (IA), Illinois (IL), Indiana (IN), Kansas (KS), Kentucky (KY), Louisiana (LA), Michigan (MI), Minnesota (MN), Missouri (MO), Mississippi (MS), Dakota do Norte (ND), Nebraska (NE), Ohio (OH), Dakota do Sul (SD), Tennessee (TN) e Wisconsin (WI) |
NAD | US Oeste | Associado à Sub-Região dos EUA e representa a porção Oeste dos EUA. Aqui estão os estados incluídos: Alasca (AK), Arizona (AZ), Califórnia (CA), Colorado (CO), Havaí (HI), Idaho (ID), Montana (MT), Novo México (NM), Nevada (NV), Oklahoma (OK), Oregon (OR), Texas (TX), Utah (UT), Washington (WA) e Wyoming (WY) |
NAX | Outro NA | Associado a grupos específicos de clientes que não requerem um grupo de vendas para negócios. |
EAA | Finlândia | Associado à Sub-Região da Escandinávia e representa todo o país Finlândia. |
EAB | Noruega | Associado à Sub-Região da Escandinávia e representa todo o país Noruega. |
EAC | Suécia | Associado à Sub-Região da Escandinávia e representa todo o país Suécia. |
EAD | Escandinávia - Dist | Associado à sub-região Escandinava, que representa o distribuidor da Escandinávia. |
EAE | Rússia | Associado à Sub-Região da Rússia e representa a Rússia. |
EAF | Áustria | Associado à Sub-Região WEMEA & EMEA Dlr D e representa todo o país Áustria |
EAG | Benelux | Associado à Sub-Região WEMEA & EMEA Dlr D e representa Bélgica, Holanda e Luxemburgo. |
EAH | França | Associado à Sub-Região WEMEA & EMEA Dlr D e representa França. |
EAI | Alemanha | Associado à Sub-Região WEMEA & EMEA Dlr D e representa Alemanha. |
EAJ | Itália | Associado à Sub-Região WEMEA & EMEA Dlr D e representa Itália. |
EAK | Espanha | Associado à Sub-Região WEMEA & EMEA Dlr D e representa Espanha. |
EAL | Reino Unido | Associado à Sub-Região WEMEA & EMEA Dlr D e representa Inglaterra, Escócia e Irlanda. |
EAM | Dist EUR Ex-DC | Associado à Sub-Região WEMEA & EMEA Dist Ex-DC e representa Distribuidores que recebem produtos do Centro de Distribuição em moeda EUR |
EAN | Dist EUR Ex-Manuf | Associado à Sub-Região WEMEA & EMEA Dist Ex-Manuf e representa Distribuidores que recebem produtos da Fábrica em moeda EUR. |
EAO | Dist USD Ex-DC | Associado à Sub-Região WEMEA & EMEA Dist Ex-DC e representa Distribuidores que recebem produtos do Centro de Distribuição em moeda USD. |
EAP | Dist USD Ex-Manuf | Associado à Sub-Região WEMEA & EMEA Dist Ex-Manuf e representa Distribuidores que recebem produtos da Fábrica em moeda USD. |
APA | Austrália | Associado à Sub-Região ANZ e representa a Austrália. |
APB | Nova Zelândia | Associado à Sub-Região ANZ e representa a Nova Zelândia. |
APC | EAPI | Associado à Sub-Região EAPI |
APD | Japão | Associado à Sub-Região do Japão e representa o Japão. |
APE | China | Associado à Sub-Região China e representa a China. |
LAA | Argentina | Associado à Sub-Região de Distribuidores LAM e representa a Argentina. |
LAB | CSC | Associado à Sub-Região de Distribuidores LAM e representa o Caribe, América Central e América do Sul. |
LAE | México | Associado à Sub-Região do México e representa o México. |
LAF | Brasil | Associado à Sub-Região do Brasil e representa o Brasil. |
LAX | Outro LATAM | Associado a Grupos Específicos de Clientes que não exigem um Grupo de Vendas para negócios. |
Limitações e Restrições
Tipo de Revendedor Devolvido
Apenas os revendedores de varejo são retornados. Outros tipos de revendedores, como serviço e aluguel, não são retornados pela API, e o código de status “não encontrado” é retornado.
Referência da API
curl --location 'https://qa-cloud-api.brp.com/dcp/v4/dealer/0000695370?language=fi-FI' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' Tabelas de Referência
Idiomas
Idioma no código de idioma ISO (ISO-639-1 + ISO 3166-1)
Formato: xx-XX
xx: código de idioma em minúsculas
XX: código do país em maiúsculas
Valores de código de idioma suportados
Código | Idioma |
|---|---|
de | Alemão |
en | Inglês |
es | Espanhol |
fi | Finlandês |
fr | Francês |
it | Italiano |
nl | Holandês |
no | Norueguês |
pt | Português (Brasil) |
sv | Sueco |
Como Fazer
Esta seção fornece informações sobre como obter resultados específicos com a API.
Obter Concessionário com Idioma Padrão (EN)
Esta consulta solicita as informações do concessionário usando o número do concessionário sem precisar especificar o idioma.
curl --location 'https://qa-cloud-api.brp.com/dcp/v4/dealer/0000690009' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' Obter Informações do Concessionário em um Idioma Específico
Esta consulta solicita informações sobre o concessionário usando o número do concessionário e um idioma.
Exceção: Se a informação não estiver disponível no idioma solicitado, a informação será retornada em inglês.
curl --location 'https://qa-cloud-api.brp.com/dcp/v4/dealer/0000695370?language=fi-FI' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \Tratamento de Erros
Esta seção apresenta vários cenários de chamadas inadequadas ou incorretas, que resultam em mensagens de erro e resultados impróprios.
400 Solicitação Inválida
O código de status 400 é geralmente visto durante o desenvolvimento e 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, e os mais comuns estão listados na tabela abaixo.
Resposta | Resolução |
|---|---|
Retornado se o campo de número do revendedor estiver em branco. {
"status": "400",
"id": "rrt-074faba1d0796ac77-c-ea-24396-1520447-1",
"title": "bad_request",
"meta": {
"service": "00",
"detail": "Caminho não encontrado."
}
} | O problema é que o caminho da consulta não fornece um número de revendedor. Você deve fornecer um número de revendedor. |
Retornado se o formato de idioma não for válido. {
"status": "400",
"id": "rrt-06c1b7ac7365beb8f-d-ea-22696-1239306-1",
"title": "bad_request",
"meta": {
"service": "01",
"detail": "falha na validação da solicitação",
"payload": {
"details": [
{
"message": "ECMA 262 regex \"^[a-z]{2}-[A-Z]{2}$\" não corresponde à string de entrada \"ab-ABC\": []"
}
]
}
}
} | O formato de idioma válido é o seguinte Formato: xx-XX xx: código de idioma em minúsculas XX: código de país em maiúsculas Um formato de idioma válido deve ser inserido para produzir uma resposta adequada. |
Retornado se o parâmetro for inválido {
"status": "400",
"id": "rrt-00a574511a562afb5-b-ea-22208-2505617-1",
"title": "bad_request",
"meta": {
"service": "01",
"detail": "falha na validação da solicitação",
"payload": {
"details": [
{
"message": "parâmetro de consulta inesperado : lang: []"
}
]
}
}
} | Lang é um parâmetro inválido. O parâmetro language deve ser usado para obter uma resposta válida. |
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 erro 401 Não Autorizado 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 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 número do concessionário não é encontrado.
{
"status": "404",
"id": "rrt-074faba1d0796ac77-c-ea-24397-1607550-1.1",
"title": "not_found",
"meta": {
"service": "06",
"detail": "Dealer 1234567890 not found."
}
}Um número de concessionário correto deve ser inserido para que a API retorne uma resposta adequada. Para que um número de concessionário seja correto, ele deve estar presente na lista de concessionários.
Um número de concessionário deve ter 10 caracteres e não conter quaisquer letras.
Se o número de concessionário tiver menos de 10 caracteres, prefixe-o com '0'.
Requisitos DSP
Requisitos Funcionais
ID | Tipo | Notas |
|---|---|---|
1 | Obrigatório | As informações do concessionário devem ser atualizadas diariamente e devem ser usadas para outras chamadas e funções da API DCP. 👉 Veja o Requisito Funcional ID 4 abaixo. Por exemplo, os métodos de envio permitidos do concessionário e as linhas de produtos permitidas devem ser recuperados das informações do concessionário. |
2 | Obrigatório | A atualização das informações do concessionário deve ser automática, sem ação manual do concessionário. |
3 | Obrigatório | Se você solicitar as informações de um concessionário e receber o código de status 403 Not Found, entre em contato com a equipe DCP em [email protected]. O concessionário pode não ser mais um concessionário BRP e pode ter se tornado inativo. |
4 | Opcional | Se não for prático chamar a API Dealers diariamente e salvar as informações dos concessionários, seu DMS pode chamar a API Dealers para recuperar as informações quando necessário. Por exemplo, a API Dealers pode ser chamada quando o concessionário entra na tela de Pedido de Peças para atualizar os métodos de envio permitidos e as linhas de produtos permitidas. |
Atividades de Certificação
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.
Esses testes são realizados usando o seu e o ambiente de teste da API DCP (QA).
Os testes são ligeiramente diferentes entre as versões V3 e V4 do DCP. Para a V3, são utilizados distribuidores internacionais.
Para a V4, são utilizados distribuidores norte-americanos.
Garantia de Qualidade para V3
ID | Teste | Resultado Esperado |
|---|---|---|
1 | Obter as informações para o número de revendedor 0000701580, um revendedor espanhol. | Exibir as informações do revendedor, incluindo os métodos de envio e linhas de produto, no mínimo. As informações podem ser exibidas na interface do usuário, em um banco de dados ou em um arquivo de log. As descrições dos métodos de envio devem estar em inglês. |
2 | Obter as informações para o número de revendedor 0000706567, um revendedor alemão, com o idioma de-DE. | Exibir as informações do revendedor, incluindo os métodos de envio e linhas de produto, no mínimo. As informações podem ser exibidas na interface do usuário, em um banco de dados ou em um arquivo de log. As descrições dos métodos de envio devem estar em alemão. |
3 | Obter as informações para o número de revendedor 0000123456, um revendedor inválido. | Mostrar o log de erro e como o status 404 Não Encontrado é tratado na aplicação. |
4 | Atualização diária automática. | Mostrar evidências de que a API de Revendedores é chamada automaticamente todos os dias. |
Garantia de Qualidade para V4
ID | Teste | Resultado Esperado |
|---|---|---|
1 | Obter as informações para o revendedor número 0000691756, um revendedor canadense, com o idioma fr-CA. | Exibir as informações do revendedor, incluindo os métodos de envio e as linhas de produtos, no mínimo. As informações podem ser exibidas na interface do usuário, em um banco de dados ou em um arquivo de log. As descrições dos métodos de envio devem estar em francês. |
2 | Obter as informações para o revendedor número 0000690009, um revendedor dos EUA. | Exibir as informações do revendedor, incluindo os métodos de envio e as linhas de produtos, no mínimo. As informações podem ser exibidas na interface do usuário, em um banco de dados ou em um arquivo de log. As descrições dos métodos de envio devem estar em inglês. |
3 | Obter as informações para o revendedor número 0000123456, um revendedor inválido | Mostrar o log de erro e como o status 404 Não Encontrado é tratado na aplicação. |
4 | Atualização automática diária. | Mostrar evidências de que a API de Revendedores é chamada automaticamente todos os dias. |
Piloto do Revendedor
A tabela abaixo descreve os parâmetros e validações do piloto do revendedor.
Parâmetro | Valor |
|---|---|
Ambiente | Produção |
Número de concessionárias | 1 a 3 |
Duração | 1 semana |
Validação 1 | O DCP verifica que a API de Concessionárias é chamada todos os dias para cada concessionária no piloto |
Validação 2 | O DCP verifica que as informações da concessionária, principalmente os métodos de envio e as linhas de produtos, estão disponíveis no DMS. |
Postman
Esta seção descreve o que está disponível no Postman para explorar a API.
Ambientes
Um ambiente Postman está disponível para testar a API de Revendedores. Este ambiente Postman contém variáveis usadas pelas consultas e está configurado para se conectar ao ambiente de teste.
Coleções
A coleção DMS - Dealers contém exemplos de chamadas de API para recuperar informações de concessionárias.