Veículos do serviço cdk drive (versão prévia)
Os Veículos de Serviço de Unidade da CDK associam a identificação, o tipo, o status e as informações do cliente sobre um veículo. A API permitirá que você crie, atualize, consulte e recupere informações do veículo de domínio de serviço na CDK.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – 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 | |
|---|---|
| Publicador | CDK Global |
| Site | https://fortellis.io |
| Política de privacidade | https://fortellis.io/privacy |
| Categorias | Dados |
Unidade CDK – Serviço – Associação de Veículos identificação, tipo, status e informações do cliente sobre um veículo.
O que essa API faz? A API permitirá que você crie, atualize, consulte e recupere informações do veículo de domínio de serviço na UNIDADE CDK.
O Veículo de Público-Alvo pretendido é uma dependência para fluxos de trabalho de ordem de reparo de serviço e compromisso de serviço.
Pré-requisitos
Você precisará do seguinte para continuar
• Para usar o conector, você precisa ser um usuário do Fortellis.
• Você precisa criar uma solução no Fortellis para gerar a ID do cliente e o segredo a serem usados ao chamar as APIs
Casos de uso potenciais
Use a API de Veículos de Serviço CDKDrive 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
- Pesquisar veículos de serviço existentes por ID ou critérios de filtro
Documentação detalhada pode ser encontrada em
https://apidocs.fortellis.io/specs/54b70ee1-ac17-4be2-9314-45c947692c5d
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à 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 |
| Consultar veículos |
Consultar veículos |
| Criar um veículo |
Criar um veículo |
Atualizar um veículo
Atualizar um veículo
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do veículo
|
vehicleId | True | string |
O identificador do veículo |
|
ID da assinatura
|
subscription_id | True | string |
Uma ID de correlação que deve ser retornada ao chamador para indicar o retorno da solicitação determinada. |
|
ID do cliente
|
client_id | True | string |
Uma ID do cliente que deve ser exclusiva para o desenvolvedor/provedor de solução criar a solução. |
|
Segredo de Cliente
|
client_secret | True | string |
Um segredo do cliente que deve ser exclusivo para o desenvolvedor/provedor de soluções que cria a solução. |
|
ID da solicitação
|
Request-Id | string |
Formato – guid. Uma ID de correlação que deve ser retornada ao chamador para indicar o retorno da solicitação determinada |
|
|
Valor da eTag
|
If-Match | True | string |
Torna a solicitação de atualização de recurso condicional. 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 Idenitificação do veículo |
|
|
licensePlateNum
|
licensePlateNum | string |
O número da placa do veículo |
|
|
makeCode
|
makeCode | True | string |
O código de make do veículo |
|
fazer
|
make | string |
O nome da marca do veículo |
|
|
modelCode
|
modelCode | True | string |
O código do modelo do veículo |
|
modelo
|
model | string |
O nome do modelo do veículo |
|
|
modelYear
|
modelYear | True | number |
O ano do modelo do veículo |
|
exteriorColor
|
exteriorColor | string |
A cor exterior do veículo |
|
|
value
|
value | True | number |
O valor da medida |
|
Unidades
|
units | True | string |
As unidades de medida |
|
status
|
status | True | string |
O status 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 |
|
inService
|
inService | True | date |
Data de venda do varejo para o proprietário original, conforme definido pelo RFC 3339, seção 5.6, por exemplo, 2017-07-21 |
|
warrantyExpiration
|
warrantyExpiration | date |
Data de validade do veículo, conforme definido pelo RFC 3339, seção 5.6, por exemplo, 2017-07-21 |
|
|
ownerHref
|
ownerHref | string |
O hiperlink para o recurso de cliente proprietário |
|
|
primaryDriverHref
|
primaryDriverHref | string |
O hiperlink para o recurso de cliente do driver primário |
Retornos
- Corpo
- Vehicle
Consultar um veículo por identificador
Consultar um veículo por identificador
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do veículo
|
vehicleId | True | string |
O identificador do veículo |
|
ID da assinatura
|
subscription_id | True | string |
Uma ID de correlação que deve ser retornada ao chamador para indicar o retorno da solicitação determinada. |
|
ID do cliente
|
client_id | True | string |
Uma ID do cliente que deve ser exclusiva para o desenvolvedor/provedor de solução criar a solução. |
|
Segredo de Cliente
|
client_secret | True | string |
Um segredo do cliente que deve ser exclusivo para o desenvolvedor/provedor de soluções que cria a solução. |
|
ID da solicitação
|
Request-Id | string |
Formato – guid. Uma ID de correlação que deve ser retornada ao chamador para indicar o retorno da solicitação determinada |
Retornos
- Corpo
- Vehicle
Consultar veículos
Consultar veículos
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Vin
|
vin | string |
Filtra veículos por VIN |
|
|
Número da placa de licença
|
licensePlateNum | string |
Filtra veículos por número de placa |
|
|
ID do cliente
|
customerId | string |
Filtra veículos por customerId |
|
|
ID da assinatura
|
subscription_id | True | string |
Uma ID de correlação que deve ser retornada ao chamador para indicar o retorno da solicitação determinada. |
|
ID do cliente
|
client_id | True | string |
Uma ID do cliente que deve ser exclusiva para o desenvolvedor/provedor de solução criar a solução. |
|
Segredo de Cliente
|
client_secret | True | string |
Um segredo do cliente que deve ser exclusivo para o desenvolvedor/provedor de soluções que cria a solução. |
|
ID da solicitação
|
Request-Id | string |
Formato – guid. Uma ID de correlação que deve ser retornada ao chamador para indicar o retorno da solicitação determinada |
Retornos
- Corpo
- VehicleCollection
Criar um veículo
Criar um veículo
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do cliente
|
client_id | True | string |
Uma ID do cliente que deve ser exclusiva para o desenvolvedor/provedor de solução criar a solução. |
|
Segredo de Cliente
|
client_secret | True | string |
Um segredo do cliente que deve ser exclusivo para o desenvolvedor/provedor de soluções que cria a solução. |
|
ID da assinatura
|
subscription_id | True | string |
Uma ID de correlação que deve ser retornada ao chamador para indicar o retorno da solicitação determinada. |
|
ID da solicitação
|
Request-Id | True | string |
Formato – guid. Uma ID de correlação que deve ser retornada ao chamador para indicar o retorno da solicitação determinada |
|
Vin
|
vin | string |
O número de Idenitificação do veículo |
|
|
licensePlateNum
|
licensePlateNum | string |
O número da placa do veículo |
|
|
makeCode
|
makeCode | True | string |
O código de make do veículo |
|
fazer
|
make | string |
O nome da marca do veículo |
|
|
modelCode
|
modelCode | True | string |
O código do modelo do veículo |
|
modelo
|
model | string |
O nome do modelo do veículo |
|
|
modelYear
|
modelYear | True | number |
O ano do modelo do veículo |
|
exteriorColor
|
exteriorColor | string |
A cor exterior do veículo |
|
|
value
|
value | True | number |
O valor da medida |
|
Unidades
|
units | True | string |
As unidades de medida |
|
status
|
status | True | string |
O status 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 |
|
inService
|
inService | True | date |
Data de venda do varejo para o proprietário original, conforme definido pelo RFC 3339, seção 5.6, por exemplo, 2017-07-21 |
|
warrantyExpiration
|
warrantyExpiration | date |
Data de validade do veículo, conforme definido pelo RFC 3339, seção 5.6, por exemplo, 2017-07-21 |
|
|
ownerHref
|
ownerHref | string |
O hiperlink para o recurso de cliente proprietário |
|
|
primaryDriverHref
|
primaryDriverHref | string |
O hiperlink para o recurso de cliente do driver primário |
Retornos
- Corpo
- Vehicle
Definições
Veículo
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
vehicleId
|
vehicleId | string |
O identificador 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 | |
|
status
|
status | string |
O status do veículo é novo, usado ou certificado? |
|
datas
|
dates | Dates | |
|
ownerHref
|
ownerHref | string |
O hiperlink para o recurso de cliente proprietário |
|
primaryDriverHref
|
primaryDriverHref | string |
O hiperlink para o recurso de cliente do driver primário |
|
links
|
links | VehicleLinks |
VehicleIdentification
Identificação do veículo. Pelo menos uma das propriedades de identificação deve ser definida para que a entidade seja válida.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Vin
|
vin | string |
O número de Idenitificação do veículo |
|
licensePlateNum
|
licensePlateNum | string |
O número da placa do veículo |
VehicleLinks
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Detalhes de um link para um recurso
|
self | LinkDescriptionObject |
VehicleCollection
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
items
|
items | array of Vehicle |
VehicleSpecification
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
makeCode
|
makeCode | string |
O código de make do veículo |
|
fazer
|
make | string |
O nome da marca do veículo |
|
modelCode
|
modelCode | string |
O código do modelo do veículo |
|
modelo
|
model | string |
O nome do modelo do veículo |
|
modelYear
|
modelYear | number |
O ano do modelo do veículo |
Medida
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
value
|
value | number |
O valor da medida |
|
Unidades
|
units | string |
As unidades de medida |
Datas
| Nome | 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 |
|
inService
|
inService | date |
Data de venda do varejo para o proprietário original, conforme definido pelo RFC 3339, seção 5.6, por exemplo, 2017-07-21 |
|
warrantyExpiration
|
warrantyExpiration | date |
Data de validade do veículo, conforme definido pelo RFC 3339, seção 5.6, por exemplo, 2017-07-21 |
LinkDescriptionObject
| Nome | 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 para o 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 |