CDK Drive Veículos de Serviço (Pré-visualização)
CDK Drive Service Vehicles Associates identificação, tipo, status e informações do cliente sobre um veículo. A API permitirá que você crie, atualize, consulte e recupere informações do veículo do domínio do serviço no CDK.
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regiões |
|---|---|---|
| Estúdio Copiloto | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicações Lógicas | Standard | Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Aplicações Power | Premium | Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Automatize o poder | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | CDK Global |
| URL | https://serviceconnect.support.cdk.com |
| mbd_support@cdk.com |
| Metadados do conector | |
|---|---|
| Editora | CDK Global |
| Sítio Web | https://fortellis.io |
| Política de privacidade | https://fortellis.io/privacy |
| Categorias | Data |
CDK Drive - Serviço - Identificação de Veículos Associados, tipo, status e informações do cliente sobre um veículo.
O que faz esta API? A API permitirá que você crie, atualize, consulte e recupere informações do veículo do domínio do serviço no CDK Drive.
O Veículo de Público-Alvo é uma dependência dos fluxos de trabalho de Compromisso de Serviço e Ordem de Reparo de Serviço.
Pre-requisites
Você precisará do seguinte para prosseguir
• Para usar o conector, você precisa ser um usuário Fortellis.
• Você precisa criar uma solução no Fortellis para gerar ID do cliente e segredo para ser usado ao chamar as APIs
Casos de uso potenciais
Use a API CDKDrive Service Vehicles para criar soluções para lidar com situações como:
- Criar ou atualizar informações do veículo de serviço
- Vincular um cliente a um veículo de serviço
- Pesquisa de veículos de serviço existentes por critérios de identificação ou filtro
A documentação detalhada pode ser encontrada em
https://apidocs.fortellis.io/specs/54b70ee1-ac17-4be2-9314-45c947692c5d
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Atualizar um veículo |
Atualizar um veículo |
| Consultar um veículo por identificador |
Consultar um veículo por identificador |
| Criar um veículo |
Criar um veículo |
| Veículos de consulta |
Veículos de consulta |
Atualizar um veículo
Atualizar um veículo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Identificação do veículo
|
vehicleId | True | string |
O identificador do veículo |
|
ID da Subscrição
|
subscription_id | True | string |
Um ID de correlação que deve ser devolvido ao chamador para indicar o retorno da solicitação fornecida. |
|
ID de Cliente
|
client_id | True | string |
Um ID de cliente que deve ser exclusivo para o desenvolvedor/provedor de soluções que está criando a solução. |
|
Segredo do Cliente
|
client_secret | True | string |
Um segredo do cliente que deve ser exclusivo para o desenvolvedor/provedor de soluções que está criando a solução. |
|
ID do pedido
|
Request-Id | string |
Formato - guid. Um ID de correlação que deve ser devolvido ao chamador para indicar o retorno da solicitação fornecida |
|
|
Valor eTag
|
If-Match | True | string |
Condiciona a solicitação de atualização de recursos. O valor da soma de verificação apresentado com If-Match deve corresponder ao valor ETag atual do recurso. |
|
Vin
|
vin | string |
O número de identificação do veículo |
|
|
licensePlateNum
|
licensePlateNum | string |
O número da matrícula do veículo |
|
|
makeCode [en]
|
makeCode | True | string |
O código da marca do veículo |
|
fazer
|
make | string |
O nome do veículo |
|
|
Código do modelo
|
modelCode | True | string |
O código do modelo do veículo |
|
modelo
|
model | string |
O nome do modelo do veículo |
|
|
ano-modelo
|
modelYear | True | number |
O ano do modelo do veículo |
|
exteriorColor
|
exteriorColor | string |
A cor exterior do veículo |
|
|
valor
|
value | True | number |
O valor de medição |
|
unidades
|
units | True | string |
As unidades de medida |
|
estado
|
status | True | string |
O estado do veículo é novo, usado ou certificado? |
|
entregue
|
delivered | True | date |
Data de entrega do veículo ao seu proprietário atual, conforme definido pelo RFC 3339, seção 5.6, por exemplo, 2017-07-21 |
|
em Serviço
|
inService | True | date |
Data de venda a retalho ao proprietário original, conforme definido pela RFC 3339, secção 5.6, por exemplo, 2017-07-21 |
|
garantiaExpiração
|
warrantyExpiration | date |
Data de validade da garantia do veículo, conforme definido pela RFC 3339, seção 5.6, por exemplo, 2017-07-21 |
|
|
proprietárioHref
|
ownerHref | string |
O hiperlink para o recurso do cliente proprietário |
|
|
primárioDriverHref
|
primaryDriverHref | string |
O hiperlink para o recurso do cliente do driver primário |
Devoluções
- Body
- Vehicle
Consultar um veículo por identificador
Consultar um veículo por identificador
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Identificação do veículo
|
vehicleId | True | string |
O identificador do veículo |
|
ID da Subscrição
|
subscription_id | True | string |
Um ID de correlação que deve ser devolvido ao chamador para indicar o retorno da solicitação fornecida. |
|
ID de Cliente
|
client_id | True | string |
Um ID de cliente que deve ser exclusivo para o desenvolvedor/provedor de soluções que está criando a solução. |
|
Segredo do Cliente
|
client_secret | True | string |
Um segredo do cliente que deve ser exclusivo para o desenvolvedor/provedor de soluções que está criando a solução. |
|
ID do pedido
|
Request-Id | string |
Formato - guid. Um ID de correlação que deve ser devolvido ao chamador para indicar o retorno da solicitação fornecida |
Devoluções
- Body
- Vehicle
Criar um veículo
Criar um veículo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de Cliente
|
client_id | True | string |
Um ID de cliente que deve ser exclusivo para o desenvolvedor/provedor de soluções que está criando a solução. |
|
Segredo do Cliente
|
client_secret | True | string |
Um segredo do cliente que deve ser exclusivo para o desenvolvedor/provedor de soluções que está criando a solução. |
|
ID da Subscrição
|
subscription_id | True | string |
Um ID de correlação que deve ser devolvido ao chamador para indicar o retorno da solicitação fornecida. |
|
ID do pedido
|
Request-Id | True | string |
Formato - guid. Um ID de correlação que deve ser devolvido ao chamador para indicar o retorno da solicitação fornecida |
|
Vin
|
vin | string |
O número de identificação do veículo |
|
|
licensePlateNum
|
licensePlateNum | string |
O número da matrícula do veículo |
|
|
makeCode [en]
|
makeCode | True | string |
O código da marca do veículo |
|
fazer
|
make | string |
O nome do veículo |
|
|
Código do modelo
|
modelCode | True | string |
O código do modelo do veículo |
|
modelo
|
model | string |
O nome do modelo do veículo |
|
|
ano-modelo
|
modelYear | True | number |
O ano do modelo do veículo |
|
exteriorColor
|
exteriorColor | string |
A cor exterior do veículo |
|
|
valor
|
value | True | number |
O valor de medição |
|
unidades
|
units | True | string |
As unidades de medida |
|
estado
|
status | True | string |
O estado do veículo é novo, usado ou certificado? |
|
entregue
|
delivered | True | date |
Data de entrega do veículo ao seu proprietário atual, conforme definido pelo RFC 3339, seção 5.6, por exemplo, 2017-07-21 |
|
em Serviço
|
inService | True | date |
Data de venda a retalho ao proprietário original, conforme definido pela RFC 3339, secção 5.6, por exemplo, 2017-07-21 |
|
garantiaExpiração
|
warrantyExpiration | date |
Data de validade da garantia do veículo, conforme definido pela RFC 3339, seção 5.6, por exemplo, 2017-07-21 |
|
|
proprietárioHref
|
ownerHref | string |
O hiperlink para o recurso do cliente proprietário |
|
|
primárioDriverHref
|
primaryDriverHref | string |
O hiperlink para o recurso do cliente do driver primário |
Devoluções
- Body
- Vehicle
Veículos de consulta
Veículos de consulta
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Vin
|
vin | string |
Filtra veículos por VIN |
|
|
Número da matrícula
|
licensePlateNum | string |
Filtra veículos por número de matrícula |
|
|
ID do Cliente
|
customerId | string |
Filtra veículos por customerId |
|
|
ID da Subscrição
|
subscription_id | True | string |
Um ID de correlação que deve ser devolvido ao chamador para indicar o retorno da solicitação fornecida. |
|
ID de Cliente
|
client_id | True | string |
Um ID de cliente que deve ser exclusivo para o desenvolvedor/provedor de soluções que está criando a solução. |
|
Segredo do Cliente
|
client_secret | True | string |
Um segredo do cliente que deve ser exclusivo para o desenvolvedor/provedor de soluções que está criando a solução. |
|
ID do pedido
|
Request-Id | string |
Formato - guid. Um ID de correlação que deve ser devolvido ao chamador para indicar o retorno da solicitação fornecida |
Devoluções
- Body
- VehicleCollection
Definições
Veículo
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
identificação do veículo
|
vehicleId | string |
O negador do registro do veículo |
|
identificação
|
identification | VehicleIdentification |
Identificação do veículo. Pelo menos uma das propriedades de identificação deve ser definida para que a entidade seja válida. |
|
especificação
|
specification | VehicleSpecification | |
|
exteriorColor
|
exteriorColor | string |
A cor exterior do veículo |
|
quilometragem
|
mileage | Measurement | |
|
estado
|
status | string |
O estado do veículo é novo, usado ou certificado? |
|
Datas
|
dates | Dates | |
|
proprietárioHref
|
ownerHref | string |
O hiperlink para o recurso do cliente proprietário |
|
primárioDriverHref
|
primaryDriverHref | string |
O hiperlink para o recurso do cliente do driver primário |
|
links
|
links | VehicleLinks |
Identificação do Veículo
Identificação do veículo. Pelo menos uma das propriedades de identificação deve ser definida para que a entidade seja válida.
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Vin
|
vin | string |
O número de identificação do veículo |
|
licensePlateNum
|
licensePlateNum | string |
O número da matrícula do veículo |
VeículosLinks
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Detalhes de um link para um recurso
|
self | LinkDescriptionObject |
VehicleCollection
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
items
|
items | array of Vehicle |
Especificação do veículo
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
makeCode [en]
|
makeCode | string |
O código da marca do veículo |
|
fazer
|
make | string |
O nome do veículo |
|
Código do modelo
|
modelCode | string |
O código do modelo do veículo |
|
modelo
|
model | string |
O nome do modelo do veículo |
|
ano-modelo
|
modelYear | number |
O ano do modelo do veículo |
Measurement
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
valor
|
value | number |
O valor de medição |
|
unidades
|
units | string |
As unidades de medida |
Dates
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
entregue
|
delivered | date |
Data de entrega do veículo ao seu proprietário atual, conforme definido pelo RFC 3339, seção 5.6, por exemplo, 2017-07-21 |
|
em Serviço
|
inService | date |
Data de venda a retalho ao proprietário original, conforme definido pela RFC 3339, secção 5.6, por exemplo, 2017-07-21 |
|
garantiaExpiração
|
warrantyExpiration | date |
Data de validade da garantia do veículo, conforme definido pela RFC 3339, seção 5.6, por exemplo, 2017-07-21 |
LinkDescriptionObject
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
HREF
|
href | string |
O URI de destino |
|
método
|
method | string |
O verbo HTTP que DEVE ser usado para fazer uma solicitação ao destino do link |
|
title
|
title | string |
A propriedade title fornece um título para o link e é uma ferramenta de documentação útil para facilitar a compreensão pelos clientes finais |