Cliente da unidade CDK (versão prévia)
A API permitirá que você localize, recupere e filtre clientes de serviço na UNIDADE CDK. Dentro da CDK Drive, um cliente é um indivíduo que foi vendido um veículo, é uma perspectiva em um veículo, comprou peças ou teve seu veículo reparado ou atendido através da concessionária e existe em um sistema CRM. Além disso, esse conector permitirá que você crie um registro básico do cliente. Isso ajuda os consultores de serviço a fornecer uma experiência positiva, permitindo que esses fluxos de trabalho sejam vinculados a um cliente.
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 |
SOBRE
A API de Cliente do CDKDrive V1 permite que você pesquise, exiba, crie e atualize os registros do cliente na Unidade cdk.
https://apidocs.fortellis.io/specs/0d488dd1-c609-4618-9061-68be8b61c2a9
Conceitos Principais
Clientes
Um cliente é um indivíduo no CDK Drive DMS que atende a pelo menos um dos seguintes critérios:
- Comprou um veículo (ou é uma perspectiva para comprar um veículo) da concessionária
- Partes adquiridas da concessionária
- Trouxe um veículo para a concessionária para reparos ou serviço
Casos de uso potenciais
Use a API de Cliente do CDKDrive para criar soluções para lidar com situações como:
- Pesquisar um cliente e exibir detalhes do cliente
- Criar ou atualizar informações do cliente
- Atualizar os métodos de contato preferidos de um cliente
- Obter informações do cliente para vincular com veículos com a API de Veículos do Serviço CDKDrive
APIs Relacionadas
A API de Cliente do CDKDrive pode ser usada de forma independente ou com qualquer uma das APIs a seguir.
NEGÓCIOS
Encontre e crie um acordo usando informações sobre o cliente e o veículo que eles estão comprando ou alugando. A API de Cliente do CDKDrive pode ser usada para associar registros de clientes a negócios. API de negócios: obter funcionários da concessionária.
PEDIDOS DE REPARO DO CDKDRIVE
Habilitar fluxos de trabalho de gravação de serviço na unidade cdk. A API de Cliente do CDKDrive pode ser usada para associar registros de clientes a pedidos de reparo.
https://apidocs.fortellis.io/specs/b0f20c99-ed1f-49de-a0e8-6776d2ee0fe3
VEÍCULOS DE SERVIÇO CDKDRIVE
Crie, atualize, consulte e recupere informações do veículo de domínio de serviço na UNIDADE CDK. Você pode vincular clientes a veículos usando a API de Veículos de Serviço CDKDrive.
https://apidocs.fortellis.io/specs/54b70ee1-ac17-4be2-9314-45c947692c5d
INTRODUÇÃO À API DE CLIENTE DO CDKDRIVE
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
Documentação detalhada pode ser encontrada em
https://apidocs.fortellis.io/specs/0d488dd1-c609-4618-9061-68be8b61c2a9
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Atualizar um cliente |
Atualizar um cliente |
| Consultar clientes |
Consultar clientes |
| Consultar um cliente |
Consultar um cliente |
| Criar um cliente |
Criar um cliente |
Atualizar um cliente
Atualizar um cliente
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do cliente
|
customerId | True | string |
O identificador do cliente |
|
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 |
|
|
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. |
|
primeiro
|
first | True | string |
O nome do cliente |
|
meio
|
middle | string |
O nome do meio do cliente |
|
|
último
|
last | True | string |
O sobrenome do cliente |
|
prefix
|
prefix | string |
O prefixo do cliente |
|
|
sufixo
|
suffix | string |
O sufixo do cliente |
|
|
primaryPhone
|
primaryPhone | string |
O número de telefone primário do cliente |
|
|
homePhone
|
homePhone | string |
O número de telefone residencial do cliente |
|
|
mobilePhone
|
mobilePhone | string |
O número de telefone celular do cliente |
|
|
pager
|
pager | string |
O número do pager do cliente |
|
|
pagerAccessCode
|
pagerAccessCode | string |
O código de acesso do pager do cliente |
|
|
homeFax
|
homeFax | string |
O número de fax doméstico do cliente |
|
|
workFax
|
workFax | string |
O número de fax de trabalho do cliente |
|
|
email1
|
email1 | string |
Endereço de email 1 do cliente. Você pode inserir NA para CD ou não aplicável para o cliente recusado se nenhum outro endereço de email estiver presente |
|
|
emailDesc1
|
emailDesc1 | string |
Descrição do endereço de email 1. Conterá NA ou CD se inserido no email1. |
|
|
email2
|
email2 | string |
Endereço de email 2 do cliente |
|
|
emailDesc2
|
emailDesc2 | string |
Descrição do endereço de email 2 |
|
|
email3
|
email3 | string |
Endereço de email 3 do cliente |
|
|
emailDesc3
|
emailDesc3 | string |
Descrição do endereço de email 3 |
|
|
email4
|
email4 | string |
Endereço de email 4 do cliente |
|
|
emailDesc4
|
emailDesc4 | string |
Descrição do endereço de email 4 |
|
|
email5
|
email5 | string |
Endereço de email 5 do cliente |
|
|
emailDesc5
|
emailDesc5 | string |
Descrição do endereço de email 5 |
|
|
email6
|
email6 | string |
Endereço de email 6 do cliente |
|
|
emailDesc6
|
emailDesc6 | string |
Descrição do endereço de email 6 |
|
|
preferredMethod
|
preferredMethod | string |
O método preferencial de contato para o cliente |
|
|
blockPhoneFlag
|
blockPhoneFlag | boolean |
Indica se a publicidade telefônica deve ou não ser telefônica |
|
|
blockEmailFlag
|
blockEmailFlag | boolean |
Indica se a publicidade de email deve ou não ser bloqueada |
|
|
blockMailFlag
|
blockMailFlag | boolean |
Indica se a publicidade de email deve ou não ser bloqueada |
|
|
rua
|
street | string |
Pode ser rua, avenida, estrada, etc. Esse elemento também inclui o número da casa e o número de sala/apartamento/apartamento/andar. |
|
|
city
|
city | string |
Pode ser cidade, vila, cidade, bairro, etc. Esta é a cidade postal e não necessariamente o local de residência ou local de negócios. |
|
|
condado
|
county | string |
Lida com distritos administrativos, como condados dos EUA ou do Reino Unido que não são usados para fins de endereçamento de email. A sub-região não se destina a endereços de entrega. |
|
|
estado
|
state | string |
Estado, província, condado (na Irlanda), Terra (na Alemanha), departement (na França), etc. |
|
|
postalCode
|
postalCode | string |
Código postal. Geralmente em todo o país, mas às vezes específico da cidade (por exemplo, '2' em endereços 'Dublin 2, Irlanda'). |
|
|
country
|
country | string |
O código do país ISO do país |
Retornos
- Corpo
- Customer
Consultar clientes
Consultar clientes
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome
|
name | string |
Filtra clientes por nome |
|
|
Email
|
string |
Filtra clientes por endereço de email |
||
|
Telefone
|
phone | string |
Filtra os clientes por número de telefone |
|
|
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
- CustomerCollection
Consultar um cliente
Consultar um cliente
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do cliente
|
customerId | True | string |
O identificador do cliente |
|
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
- Customer
Criar um cliente
Criar um cliente
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 | string |
Formato – guid. Uma ID de correlação que deve ser retornada ao chamador para indicar o retorno da solicitação determinada |
|
|
primeiro
|
first | True | string |
O nome do cliente |
|
meio
|
middle | string |
O nome do meio do cliente |
|
|
último
|
last | True | string |
O sobrenome do cliente |
|
prefix
|
prefix | string |
O prefixo do cliente |
|
|
sufixo
|
suffix | string |
O sufixo do cliente |
|
|
primaryPhone
|
primaryPhone | string |
O número de telefone primário do cliente |
|
|
homePhone
|
homePhone | string |
O número de telefone residencial do cliente |
|
|
mobilePhone
|
mobilePhone | string |
O número de telefone celular do cliente |
|
|
pager
|
pager | string |
O número do pager do cliente |
|
|
pagerAccessCode
|
pagerAccessCode | string |
O código de acesso do pager do cliente |
|
|
homeFax
|
homeFax | string |
O número de fax doméstico do cliente |
|
|
workFax
|
workFax | string |
O número de fax de trabalho do cliente |
|
|
email1
|
email1 | string |
Endereço de email 1 do cliente. Você pode inserir NA para CD ou não aplicável para o cliente recusado se nenhum outro endereço de email estiver presente |
|
|
emailDesc1
|
emailDesc1 | string |
Descrição do endereço de email 1. Conterá NA ou CD se inserido no email1. |
|
|
email2
|
email2 | string |
Endereço de email 2 do cliente |
|
|
emailDesc2
|
emailDesc2 | string |
Descrição do endereço de email 2 |
|
|
email3
|
email3 | string |
Endereço de email 3 do cliente |
|
|
emailDesc3
|
emailDesc3 | string |
Descrição do endereço de email 3 |
|
|
email4
|
email4 | string |
Endereço de email 4 do cliente |
|
|
emailDesc4
|
emailDesc4 | string |
Descrição do endereço de email 4 |
|
|
email5
|
email5 | string |
Endereço de email 5 do cliente |
|
|
emailDesc5
|
emailDesc5 | string |
Descrição do endereço de email 5 |
|
|
email6
|
email6 | string |
Endereço de email 6 do cliente |
|
|
emailDesc6
|
emailDesc6 | string |
Descrição do endereço de email 6 |
|
|
preferredMethod
|
preferredMethod | string |
O método preferencial de contato para o cliente |
|
|
blockPhoneFlag
|
blockPhoneFlag | boolean |
Indica se a publicidade telefônica deve ou não ser telefônica |
|
|
blockEmailFlag
|
blockEmailFlag | boolean |
Indica se a publicidade de email deve ou não ser bloqueada |
|
|
blockMailFlag
|
blockMailFlag | boolean |
Indica se a publicidade de email deve ou não ser bloqueada |
|
|
rua
|
street | string |
Pode ser rua, avenida, estrada, etc. Esse elemento também inclui o número da casa e o número de sala/apartamento/apartamento/andar. |
|
|
city
|
city | string |
Pode ser cidade, vila, cidade, bairro, etc. Esta é a cidade postal e não necessariamente o local de residência ou local de negócios. |
|
|
condado
|
county | string |
Lida com distritos administrativos, como condados dos EUA ou do Reino Unido que não são usados para fins de endereçamento de email. A sub-região não se destina a endereços de entrega. |
|
|
estado
|
state | string |
Estado, província, condado (na Irlanda), Terra (na Alemanha), departement (na França), etc. |
|
|
postalCode
|
postalCode | string |
Código postal. Geralmente em todo o país, mas às vezes específico da cidade (por exemplo, '2' em endereços 'Dublin 2, Irlanda'). |
|
|
country
|
country | string |
O código do país ISO do país |
Retornos
- Corpo
- Customer
Definições
Customer
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
customerId
|
customerId | string |
O identificador do registro do cliente |
|
nome
|
name | Name | |
|
contactMethods
|
contactMethods | ContactMethods | |
|
postalAddress
|
postalAddress | PostalAddress | |
|
preferredContact
|
preferredContact | string |
O método de contato preferencial |
|
links
|
links | CustomerLinks |
ContactMethods
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
primaryPhone
|
primaryPhone | string |
O número de telefone primário do cliente |
|
homePhone
|
homePhone | string |
O número de telefone residencial do cliente |
|
mobilePhone
|
mobilePhone | string |
O número de telefone celular do cliente |
|
pager
|
pager | string |
O número do pager do cliente |
|
pagerAccessCode
|
pagerAccessCode | string |
O código de acesso do pager do cliente |
|
homeFax
|
homeFax | string |
O número de fax doméstico do cliente |
|
workFax
|
workFax | string |
O número de fax de trabalho do cliente |
|
email1
|
email1 | string |
Endereço de email 1 do cliente. Você pode inserir NA para CD ou não aplicável para o cliente recusado se nenhum outro endereço de email estiver presente |
|
emailDesc1
|
emailDesc1 | string |
Descrição do endereço de email 1. Conterá NA ou CD se inserido no email1. |
|
email2
|
email2 | string |
Endereço de email 2 do cliente |
|
emailDesc2
|
emailDesc2 | string |
Descrição do endereço de email 2 |
|
email3
|
email3 | string |
Endereço de email 3 do cliente |
|
emailDesc3
|
emailDesc3 | string |
Descrição do endereço de email 3 |
|
email4
|
email4 | string |
Endereço de email 4 do cliente |
|
emailDesc4
|
emailDesc4 | string |
Descrição do endereço de email 4 |
|
email5
|
email5 | string |
Endereço de email 5 do cliente |
|
emailDesc5
|
emailDesc5 | string |
Descrição do endereço de email 5 |
|
email6
|
email6 | string |
Endereço de email 6 do cliente |
|
emailDesc6
|
emailDesc6 | string |
Descrição do endereço de email 6 |
|
preferredMethod
|
preferredMethod | string |
O método preferencial de contato para o cliente |
|
blockPhoneFlag
|
blockPhoneFlag | boolean |
Indica se a publicidade telefônica deve ou não ser telefônica |
|
blockEmailFlag
|
blockEmailFlag | boolean |
Indica se a publicidade de email deve ou não ser bloqueada |
|
blockMailFlag
|
blockMailFlag | boolean |
Indica se a publicidade de email deve ou não ser bloqueada |
PostalAddress
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
rua
|
street | string |
Pode ser rua, avenida, estrada, etc. Esse elemento também inclui o número da casa e o número de sala/apartamento/apartamento/andar. |
|
city
|
city | string |
Pode ser cidade, vila, cidade, bairro, etc. Esta é a cidade postal e não necessariamente o local de residência ou local de negócios. |
|
condado
|
county | string |
Lida com distritos administrativos, como condados dos EUA ou do Reino Unido que não são usados para fins de endereçamento de email. A sub-região não se destina a endereços de entrega. |
|
estado
|
state | string |
Estado, província, condado (na Irlanda), Terra (na Alemanha), departement (na França), etc. |
|
postalCode
|
postalCode | string |
Código postal. Geralmente em todo o país, mas às vezes específico da cidade (por exemplo, '2' em endereços 'Dublin 2, Irlanda'). |
|
country
|
country | string |
O código do país ISO do país |
CustomerLinks
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Detalhes de um link para um recurso
|
self | LinkDescriptionObject |
CustomerCollection
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
items
|
items | array of Customer |
Nome
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
primeiro
|
first | string |
O nome do cliente |
|
meio
|
middle | string |
O nome do meio do cliente |
|
último
|
last | string |
O sobrenome do cliente |
|
prefix
|
prefix | string |
O prefixo do cliente |
|
sufixo
|
suffix | string |
O sufixo do cliente |
|
CompanyName
|
companyName | string |
Se o cliente representar uma empresa, o nome da empresa será considerado |
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 por clientes finais |