Partilhar via

CDK Drive Cliente (Pré-visualização)

A API permitirá que você encontre, recupere e filtre clientes de serviço no CDK Drive. Dentro da CDK Drive, um cliente é um indivíduo que foi vendido um veículo, é um prospect 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 de 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.

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
Email 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

SOBRE NÓS

A CDKDrive Customer API V1 permite pesquisar, visualizar, criar e atualizar registros de clientes no CDK Drive.

https://apidocs.fortellis.io/specs/0d488dd1-c609-4618-9061-68be8b61c2a9

Conceitos-chave

Clientes

Um cliente é um indivíduo no CDK Drive DMS que atende a pelo menos um dos seguintes critérios:

  1. Comprou um veículo (ou é um potencial comprador de um veículo) na concessionária
  2. Peças compradas na concessionária
  3. Trouxe um veículo para a concessionária para reparos ou serviços

Casos de uso potenciais

Use a API do Cliente CDKDrive para criar soluções para lidar com situações como:

  1. Pesquise um cliente e exiba os detalhes do cliente
  2. Criar ou atualizar informações do cliente
  3. Atualizar os métodos de contato preferidos de um cliente
  4. Obtenha informações do cliente para vincular com veículos com a API de veículos de serviço CDKDrive

APIs relacionadas

A API do Cliente CDKDrive pode ser usada independentemente ou com qualquer uma das seguintes APIs.

PROMOÇÕES

Encontre e crie um negócio usando informações sobre o cliente e o veículo que ele está comprando ou alugando. A API do Cliente CDKDrive pode ser usada para associar registros de clientes a negócios. API de ofertas: Obtenha funcionários da concessionária.

  1. https://apidocs-dev.fortellis.io/specs/91145f3f-2dd7-43fa-a63d-08908ef9e2e7

ORDENS DE REPARO CDKDRIVE

Habilite fluxos de trabalho de gravação de serviço na unidade CDK. A API do Cliente 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 do domínio do serviço no CDK Drive. Você pode vincular clientes a veículos usando a API CDKDrive Service Vehicles.

https://apidocs.fortellis.io/specs/54b70ee1-ac17-4be2-9314-45c947692c5d

INTRODUÇÃO À API DO CLIENTE CDKDRIVE

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

A documentação detalhada pode ser encontrada em

https://apidocs.fortellis.io/specs/0d488dd1-c609-4618-9061-68be8b61c2a9

Limites de Limitação

Name Chamadas Período de Renovação
Chamadas de 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

ID da Operação:
updateCustomer

Atualizar um cliente

Parâmetros

Name Chave Necessário Tipo Description
ID do Cliente
 customerId True string

O identificador do cliente
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
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.
primeiro
 first True string

O primeiro nome do cliente
médio
 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
primárioTelefone
 primaryPhone string

O número de telefone principal do cliente
homeTelefone
 homePhone string

O número de telefone residencial do cliente
telemóvel
 mobilePhone string

O número de telemóvel 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
e-mail1
 email1 string

Endereço de e-mail 1 do cliente. Você pode inserir NA para Não Aplicável ou CD para Cliente Recusado se nenhum outro endereço de e-mail estiver presente
emailDesc1
 emailDesc1 string

Endereço de e-mail 1 descrição. Irá conter NA ou CD se inserido no e-mail1.
E-mail2
 email2 string

Endereço de e-mail 2 do cliente
emailDesc2
 emailDesc2 string

Endereço de e-mail 2 Descrição
e-mail3
 email3 string

Endereço de e-mail 3 do cliente
emailDesc3
 emailDesc3 string

Endereço de e-mail 3 Descrição
e-mail4
 email4 string

Endereço de e-mail 4 do cliente
e-mailDesc4
 emailDesc4 string

Endereço de e-mail 4 Descrição
e-mail5
 email5 string

Endereço de e-mail 5 do cliente
e-mailDesc5
 emailDesc5 string

Endereço de e-mail 5 Descrição
e-mail6
 email6 string

Endereço de e-mail 6 do cliente
e-mailDesc6
 emailDesc6 string

Endereço de e-mail 6 Descrição
Método preferido
 preferredMethod string

O método preferido de contato para o cliente
blockPhoneFlag
 blockPhoneFlag boolean

Indica se deve ou não telefonar para publicidade por telefone
blockEmailFlag
 blockEmailFlag boolean

Indica se a publicidade por e-mail deve ou não ser bloqueada
blockMailFlag
 blockMailFlag boolean

Indica se a publicidade de e-mail deve ou não ser bloqueada
rua
 street string

Pode ser rua, avenida, estrada, etc. Este elemento também inclui o número da casa e o número do quarto/apartamento/apartamento/andar.
city
 city string

Pode ser cidade, aldeia, vila, bairro, etc. Esta é a cidade postal e não necessariamente o local de residência ou local de negócios.
concelho
 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 correio. A sub-região não se destina a endereços de entrega.
state
 state string

Um estado, província, condado (na Irlanda), Land (na Alemanha), departamento (em França), etc.
postalCode
 postalCode string

Código postal. Geralmente em todo o país, mas por vezes específico da cidade (por exemplo, «2» nos endereços «Dublin 2, Irlanda»).
country
 country string

O código ISO do país

Devoluções

Body
Customer

Consultar clientes

ID da Operação:
queryCustomers

Consultar clientes

Parâmetros

Name Chave Necessário Tipo Description
Nome
 name string

Filtra os clientes por nome
Email
 email string

Filtra os clientes por endereço de e-mail
Telemóvel
 phone string

Filtra os clientes por número de telefone
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
CustomerCollection

Consultar um cliente

ID da Operação:
queryCustomerById

Consultar um cliente

Parâmetros

Name Chave Necessário Tipo Description
ID do Cliente
 customerId True string

O identificador do cliente
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
Customer

Criar um cliente

ID da Operação:
createCustomer

Criar um cliente

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 string

Formato - guid. Um ID de correlação que deve ser devolvido ao chamador para indicar o retorno da solicitação fornecida
primeiro
 first True string

O primeiro nome do cliente
médio
 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
primárioTelefone
 primaryPhone string

O número de telefone principal do cliente
homeTelefone
 homePhone string

O número de telefone residencial do cliente
telemóvel
 mobilePhone string

O número de telemóvel 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
e-mail1
 email1 string

Endereço de e-mail 1 do cliente. Você pode inserir NA para Não Aplicável ou CD para Cliente Recusado se nenhum outro endereço de e-mail estiver presente
emailDesc1
 emailDesc1 string

Endereço de e-mail 1 descrição. Irá conter NA ou CD se inserido no e-mail1.
E-mail2
 email2 string

Endereço de e-mail 2 do cliente
emailDesc2
 emailDesc2 string

Endereço de e-mail 2 Descrição
e-mail3
 email3 string

Endereço de e-mail 3 do cliente
emailDesc3
 emailDesc3 string

Endereço de e-mail 3 Descrição
e-mail4
 email4 string

Endereço de e-mail 4 do cliente
e-mailDesc4
 emailDesc4 string

Endereço de e-mail 4 Descrição
e-mail5
 email5 string

Endereço de e-mail 5 do cliente
e-mailDesc5
 emailDesc5 string

Endereço de e-mail 5 Descrição
e-mail6
 email6 string

Endereço de e-mail 6 do cliente
e-mailDesc6
 emailDesc6 string

Endereço de e-mail 6 Descrição
Método preferido
 preferredMethod string

O método preferido de contato para o cliente
blockPhoneFlag
 blockPhoneFlag boolean

Indica se deve ou não telefonar para publicidade por telefone
blockEmailFlag
 blockEmailFlag boolean

Indica se a publicidade por e-mail deve ou não ser bloqueada
blockMailFlag
 blockMailFlag boolean

Indica se a publicidade de e-mail deve ou não ser bloqueada
rua
 street string

Pode ser rua, avenida, estrada, etc. Este elemento também inclui o número da casa e o número do quarto/apartamento/apartamento/andar.
city
 city string

Pode ser cidade, aldeia, vila, bairro, etc. Esta é a cidade postal e não necessariamente o local de residência ou local de negócios.
concelho
 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 correio. A sub-região não se destina a endereços de entrega.
state
 state string

Um estado, província, condado (na Irlanda), Land (na Alemanha), departamento (em França), etc.
postalCode
 postalCode string

Código postal. Geralmente em todo o país, mas por vezes específico da cidade (por exemplo, «2» nos endereços «Dublin 2, Irlanda»).
country
 country string

O código ISO do país

Devoluções

Body
Customer

Definições

Cliente

Name Caminho Tipo Description
ID do cliente
 customerId string

O identificador do registro do cliente
nome
 name Name
contactMethods
 contactMethods ContactMethods
endereço postal
 postalAddress PostalAddress
preferencialContato
 preferredContact string

O método de contacto preferido
links
 links CustomerLinks

Métodos de Contato

Name Caminho Tipo Description
primárioTelefone
 primaryPhone string

O número de telefone principal do cliente
homeTelefone
 homePhone string

O número de telefone residencial do cliente
telemóvel
 mobilePhone string

O número de telemóvel 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
e-mail1
 email1 string

Endereço de e-mail 1 do cliente. Você pode inserir NA para Não Aplicável ou CD para Cliente Recusado se nenhum outro endereço de e-mail estiver presente
emailDesc1
 emailDesc1 string

Endereço de e-mail 1 descrição. Irá conter NA ou CD se inserido no e-mail1.
E-mail2
 email2 string

Endereço de e-mail 2 do cliente
emailDesc2
 emailDesc2 string

Endereço de e-mail 2 Descrição
e-mail3
 email3 string

Endereço de e-mail 3 do cliente
emailDesc3
 emailDesc3 string

Endereço de e-mail 3 Descrição
e-mail4
 email4 string

Endereço de e-mail 4 do cliente
e-mailDesc4
 emailDesc4 string

Endereço de e-mail 4 Descrição
e-mail5
 email5 string

Endereço de e-mail 5 do cliente
e-mailDesc5
 emailDesc5 string

Endereço de e-mail 5 Descrição
e-mail6
 email6 string

Endereço de e-mail 6 do cliente
e-mailDesc6
 emailDesc6 string

Endereço de e-mail 6 Descrição
Método preferido
 preferredMethod string

O método preferido de contato para o cliente
blockPhoneFlag
 blockPhoneFlag boolean

Indica se deve ou não telefonar para publicidade por telefone
blockEmailFlag
 blockEmailFlag boolean

Indica se a publicidade por e-mail deve ou não ser bloqueada
blockMailFlag
 blockMailFlag boolean

Indica se a publicidade de e-mail deve ou não ser bloqueada

Endereço postal

Name Caminho Tipo Description
rua
 street string

Pode ser rua, avenida, estrada, etc. Este elemento também inclui o número da casa e o número do quarto/apartamento/apartamento/andar.
city
 city string

Pode ser cidade, aldeia, vila, bairro, etc. Esta é a cidade postal e não necessariamente o local de residência ou local de negócios.
concelho
 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 correio. A sub-região não se destina a endereços de entrega.
state
 state string

Um estado, província, condado (na Irlanda), Land (na Alemanha), departamento (em França), etc.
postalCode
 postalCode string

Código postal. Geralmente em todo o país, mas por vezes específico da cidade (por exemplo, «2» nos endereços «Dublin 2, Irlanda»).
country
 country string

O código ISO do país

Ligações de Clientes

Name Caminho Tipo Description
Detalhes de um link para um recurso
 self LinkDescriptionObject

CustomerCollection

Name Caminho Tipo Description
items
 items array of Customer

Nome

Name Caminho Tipo Description
primeiro
 first string

O primeiro nome do cliente
médio
 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

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