Partager via

Client du lecteur CDK (préversion)

L’API vous permet de rechercher, récupérer et filtrer les clients du service dans le lecteur CDK. Dans CDK Drive, un client est un individu qui a été vendu un véhicule, est une perspective sur un véhicule, a acheté des pièces ou a été réparé ou a été réparé par le biais du concessionnaire et existe dans un système CRM. De plus, ce connecteur vous permet de créer un enregistrement client de base. Cela aide les conseillers de service à offrir une expérience positive en permettant à ces flux de travail d’être liés à un client.

Ce connecteur est disponible dans les produits et régions suivants :

Service classe Régions
Copilot Studio Premium Toutes les régions Power Automate , à l’exception des éléments suivants :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Applications logiques Norme Toutes les régions Logic Apps , à l’exception des suivantes :
     - Régions Azure Government
     - Régions Azure Chine
     - Us Department of Defense (DoD)
Power Apps Premium Toutes les régions Power Apps , à l’exception des suivantes :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Power Automate Premium Toutes les régions Power Automate , à l’exception des éléments suivants :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Contact
Nom CDK Global
URL https://serviceconnect.support.cdk.com
Messagerie électronique mbd_support@cdk.com
Métadonnées du connecteur
Éditeur CDK Global
Site internet https://fortellis.io
Politique de confidentialité https://fortellis.io/privacy
Catégories Data

ENVIRON

L’API client CDKDrive V1 vous permet de rechercher, d’afficher, de créer et de mettre à jour les enregistrements client dans le lecteur CDK.

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

Concepts clés

Clientèle

Un client est un individu du lecteur CDK DMS qui répond au moins à l’un des critères suivants :

  1. Acheté un véhicule (ou est une perspective d’acheter un véhicule) auprès du concessionnaire
  2. Pièces achetées auprès du concessionnaire
  3. A amené un véhicule chez le concessionnaire pour réparations ou service

Cas d’usage potentiels

Utilisez l’API client CDKDrive pour créer des solutions pour gérer des situations telles que :

  1. Rechercher un client et afficher les détails du client
  2. Créer ou mettre à jour des informations client
  3. Mettre à jour les méthodes de contact préférées d’un client
  4. Obtenir des informations sur le client pour établir un lien avec les véhicules avec l’API CDKDrive Service Vehicles

API connexes

L’API client CDKDrive peut être utilisée indépendamment ou avec l’une des API suivantes.

OFFRES

Recherchez et créez une transaction à l’aide d’informations sur le client et le véhicule qu’ils achètent ou louent. L’API client CDKDrive peut être utilisée pour associer des enregistrements clients aux transactions. API Transactions : Obtenir des employés de concessionnaires.

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

COMMANDES DE RÉPARATION CDKDRIVE

Activez les flux de travail d’écriture de service sur le lecteur CDK. L’API client CDKDrive peut être utilisée pour associer des enregistrements client aux commandes de réparation.

https://apidocs.fortellis.io/specs/b0f20c99-ed1f-49de-a0e8-6776d2ee0fe3

VÉHICULES DE SERVICE CDKDRIVE

Créez, mettez à jour, interrogez et récupérez les informations du véhicule de domaine de service dans cdK Drive. Vous pouvez lier des clients à des véhicules à l’aide de l’API CDKDrive Service Vehicles.

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

PRISE EN MAIN DE L’API CLIENT CDKDRIVE

Conditions préalables

Vous aurez besoin des éléments suivants pour continuer

• Pour utiliser le connecteur, vous devez être un utilisateur Fortellis.

• Vous devez créer une solution dans Fortellis pour générer l’ID client et le secret à utiliser lors de l’appel des API

Vous trouverez une documentation détaillée à l’adresse

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

Limitations

Nom Appels Période de renouvellement
Appels d’API par connexion 100 60 secondes

Actions

Créer un client

Créer un client
Interroger les clients

Interroger les clients
Interroger un client

Interroger un client
Mettre à jour un client

Mettre à jour un client

Créer un client

ID d’opération :
createCustomer

Créer un client

Paramètres

Nom Clé Obligatoire Type Description
ID client
 client_id True string

ID client qui doit être unique au fournisseur de développement/solution qui crée la solution.
Clé secrète client
 client_secret True string

Clé secrète client qui doit être unique au fournisseur de développement/solution qui crée la solution.
ID d’abonnement
 subscription_id True string

ID de corrélation qui doit être retourné à l’appelant pour indiquer le retour de la demande donnée.
ID de demande
 Request-Id string

Format - guid. ID de corrélation qui doit être retourné à l’appelant pour indiquer le retour de la demande donnée
premier
 first True string

Prénom du client
milieu
 middle string

Le prénom du client
last
 last True string

Nom du client
prefix
 prefix string

Préfixe du client
suffixe
 suffix string

Suffixe du client
primaryPhone
 primaryPhone string

Numéro de téléphone principal du client
HomePhone
 homePhone string

Numéro de téléphone domestique du client
mobilePhone
 mobilePhone string

Numéro de téléphone mobile du client
téléavertisseur
 pager string

Numéro du pagineur du client
pagerAccessCode
 pagerAccessCode string

Code d’accès du pagineur du client
homeFax
 homeFax string

Numéro de télécopie d’accueil du client
workFax
 workFax string

Numéro de télécopie professionnel du client
email1
 email1 string

Adresse e-mail 1 du client. Vous pouvez entrer NA pour non applicable ou CD pour le client refusé si aucune autre adresse e-mail n’est présente
emailDesc1
 emailDesc1 string

Description de l’adresse e-mail 1. Contient na ou CD s’il est entré par e-mail1.
email2
 email2 string

Adresse e-mail 2 du client
emailDesc2
 emailDesc2 string

Description de l’adresse e-mail 2
email3
 email3 string

Adresse e-mail 3 du client
emailDesc3
 emailDesc3 string

Description de l’adresse e-mail 3
email4
 email4 string

Adresse e-mail 4 du client
emailDesc4
 emailDesc4 string

Description de l’adresse e-mail 4
email5
 email5 string

Adresse e-mail 5 du client
emailDesc5
 emailDesc5 string

Description de l’adresse e-mail 5
email6
 email6 string

Adresse e-mail 6 du client
emailDesc6
 emailDesc6 string

Description de l’adresse e-mail 6
preferredMethod
 preferredMethod string

Méthode de contact par défaut pour le client
blockPhoneFlag
 blockPhoneFlag boolean

Indique si la publicité par téléphone est ou non
blockEmailFlag
 blockEmailFlag boolean

Indique s’il faut bloquer ou non la publicité par courrier électronique
blockMailFlag
 blockMailFlag boolean

Indique s’il faut bloquer ou non la publicité par courrier électronique
street
 street string

Peut être rue, avenue, route, etc. Cet élément inclut également le numéro de maison et la chambre/appartement/appartement/numéro d’étage.
city
 city string

Il peut s’agir de la ville, du village, de la ville, de l’arrondissement, etc. C’est la ville postale et pas nécessairement le lieu de résidence ou de lieu d’affaires.
comté
 county string

Gère les districts administratifs tels que les comtés des États-Unis ou des États-Unis qui ne sont pas utilisés à des fins d’adressage de courrier. La sous-région n’est pas destinée aux adresses de livraison.
état
 state string

État, province, comté (en Irlande), Land (en Allemagne), départ (en France), etc.
postalCode
 postalCode string

Code postal. Généralement à l’échelle du pays, mais parfois spécifique à la ville (par exemple, « 2 » dans les adresses « Dublin 2, Irlande »).
country
 country string

Code de pays ISO du pays

Retours

Corps
Customer

Interroger les clients

ID d’opération :
queryCustomers

Interroger les clients

Paramètres

Nom Clé Obligatoire Type Description
Nom
 name string

Filtre les clients par nom
Messagerie électronique
 email string

Filtre les clients par adresse e-mail
Téléphone
 phone string

Filtre les clients par numéro de téléphone
ID d’abonnement
 subscription_id True string

ID de corrélation qui doit être retourné à l’appelant pour indiquer le retour de la demande donnée.
ID client
 client_id True string

ID client qui doit être unique au fournisseur de développement/solution qui crée la solution.
Clé secrète client
 client_secret True string

Clé secrète client qui doit être unique au fournisseur de développement/solution qui crée la solution.
ID de demande
 Request-Id string

Format - guid. ID de corrélation qui doit être retourné à l’appelant pour indiquer le retour de la demande donnée

Retours

Corps
CustomerCollection

Interroger un client

ID d’opération :
queryCustomerById

Interroger un client

Paramètres

Nom Clé Obligatoire Type Description
ID client
 customerId True string

Identificateur du client
ID d’abonnement
 subscription_id True string

ID de corrélation qui doit être retourné à l’appelant pour indiquer le retour de la demande donnée.
ID client
 client_id True string

ID client qui doit être unique au fournisseur de développement/solution qui crée la solution.
Clé secrète client
 client_secret True string

Clé secrète client qui doit être unique au fournisseur de développement/solution qui crée la solution.
ID de demande
 Request-Id string

Format - guid. ID de corrélation qui doit être retourné à l’appelant pour indiquer le retour de la demande donnée

Retours

Corps
Customer

Mettre à jour un client

ID d’opération :
updateCustomer

Mettre à jour un client

Paramètres

Nom Clé Obligatoire Type Description
ID client
 customerId True string

Identificateur du client
ID d’abonnement
 subscription_id True string

ID de corrélation qui doit être retourné à l’appelant pour indiquer le retour de la demande donnée.
ID client
 client_id True string

ID client qui doit être unique au fournisseur de développement/solution qui crée la solution.
Clé secrète client
 client_secret True string

Clé secrète client qui doit être unique au fournisseur de développement/solution qui crée la solution.
ID de demande
 Request-Id string

Format - guid. ID de corrélation qui doit être retourné à l’appelant pour indiquer le retour de la demande donnée
eTag
 If-Match True string

Rend la demande de mise à jour des ressources conditionnelle. La valeur de somme de contrôle présentée avec If-Match doit correspondre à la valeur ETag actuelle de la ressource.
premier
 first True string

Prénom du client
milieu
 middle string

Le prénom du client
last
 last True string

Nom du client
prefix
 prefix string

Préfixe du client
suffixe
 suffix string

Suffixe du client
primaryPhone
 primaryPhone string

Numéro de téléphone principal du client
HomePhone
 homePhone string

Numéro de téléphone domestique du client
mobilePhone
 mobilePhone string

Numéro de téléphone mobile du client
téléavertisseur
 pager string

Numéro du pagineur du client
pagerAccessCode
 pagerAccessCode string

Code d’accès du pagineur du client
homeFax
 homeFax string

Numéro de télécopie d’accueil du client
workFax
 workFax string

Numéro de télécopie professionnel du client
email1
 email1 string

Adresse e-mail 1 du client. Vous pouvez entrer NA pour non applicable ou CD pour le client refusé si aucune autre adresse e-mail n’est présente
emailDesc1
 emailDesc1 string

Description de l’adresse e-mail 1. Contient na ou CD s’il est entré par e-mail1.
email2
 email2 string

Adresse e-mail 2 du client
emailDesc2
 emailDesc2 string

Description de l’adresse e-mail 2
email3
 email3 string

Adresse e-mail 3 du client
emailDesc3
 emailDesc3 string

Description de l’adresse e-mail 3
email4
 email4 string

Adresse e-mail 4 du client
emailDesc4
 emailDesc4 string

Description de l’adresse e-mail 4
email5
 email5 string

Adresse e-mail 5 du client
emailDesc5
 emailDesc5 string

Description de l’adresse e-mail 5
email6
 email6 string

Adresse e-mail 6 du client
emailDesc6
 emailDesc6 string

Description de l’adresse e-mail 6
preferredMethod
 preferredMethod string

Méthode de contact par défaut pour le client
blockPhoneFlag
 blockPhoneFlag boolean

Indique si la publicité par téléphone est ou non
blockEmailFlag
 blockEmailFlag boolean

Indique s’il faut bloquer ou non la publicité par courrier électronique
blockMailFlag
 blockMailFlag boolean

Indique s’il faut bloquer ou non la publicité par courrier électronique
street
 street string

Peut être rue, avenue, route, etc. Cet élément inclut également le numéro de maison et la chambre/appartement/appartement/numéro d’étage.
city
 city string

Il peut s’agir de la ville, du village, de la ville, de l’arrondissement, etc. C’est la ville postale et pas nécessairement le lieu de résidence ou de lieu d’affaires.
comté
 county string

Gère les districts administratifs tels que les comtés des États-Unis ou des États-Unis qui ne sont pas utilisés à des fins d’adressage de courrier. La sous-région n’est pas destinée aux adresses de livraison.
état
 state string

État, province, comté (en Irlande), Land (en Allemagne), départ (en France), etc.
postalCode
 postalCode string

Code postal. Généralement à l’échelle du pays, mais parfois spécifique à la ville (par exemple, « 2 » dans les adresses « Dublin 2, Irlande »).
country
 country string

Code de pays ISO du pays

Retours

Corps
Customer

Définitions

Client

Nom Chemin d’accès Type Description
customerId
 customerId string

Identificateur de l’enregistrement client
nom
 name Name
contactMethods
 contactMethods ContactMethods
postalAddress
 postalAddress PostalAddress
preferredContact
 preferredContact string

Méthode de contact préférée
links
 links CustomerLinks

ContactMethods

Nom Chemin d’accès Type Description
primaryPhone
 primaryPhone string

Numéro de téléphone principal du client
HomePhone
 homePhone string

Numéro de téléphone domestique du client
mobilePhone
 mobilePhone string

Numéro de téléphone mobile du client
téléavertisseur
 pager string

Numéro du pagineur du client
pagerAccessCode
 pagerAccessCode string

Code d’accès du pagineur du client
homeFax
 homeFax string

Numéro de télécopie d’accueil du client
workFax
 workFax string

Numéro de télécopie professionnel du client
email1
 email1 string

Adresse e-mail 1 du client. Vous pouvez entrer NA pour non applicable ou CD pour le client refusé si aucune autre adresse e-mail n’est présente
emailDesc1
 emailDesc1 string

Description de l’adresse e-mail 1. Contient na ou CD s’il est entré par e-mail1.
email2
 email2 string

Adresse e-mail 2 du client
emailDesc2
 emailDesc2 string

Description de l’adresse e-mail 2
email3
 email3 string

Adresse e-mail 3 du client
emailDesc3
 emailDesc3 string

Description de l’adresse e-mail 3
email4
 email4 string

Adresse e-mail 4 du client
emailDesc4
 emailDesc4 string

Description de l’adresse e-mail 4
email5
 email5 string

Adresse e-mail 5 du client
emailDesc5
 emailDesc5 string

Description de l’adresse e-mail 5
email6
 email6 string

Adresse e-mail 6 du client
emailDesc6
 emailDesc6 string

Description de l’adresse e-mail 6
preferredMethod
 preferredMethod string

Méthode de contact par défaut pour le client
blockPhoneFlag
 blockPhoneFlag boolean

Indique si la publicité par téléphone est ou non
blockEmailFlag
 blockEmailFlag boolean

Indique s’il faut bloquer ou non la publicité par courrier électronique
blockMailFlag
 blockMailFlag boolean

Indique s’il faut bloquer ou non la publicité par courrier électronique

PostalAddress

Nom Chemin d’accès Type Description
street
 street string

Peut être rue, avenue, route, etc. Cet élément inclut également le numéro de maison et la chambre/appartement/appartement/numéro d’étage.
city
 city string

Il peut s’agir de la ville, du village, de la ville, de l’arrondissement, etc. C’est la ville postale et pas nécessairement le lieu de résidence ou de lieu d’affaires.
comté
 county string

Gère les districts administratifs tels que les comtés des États-Unis ou des États-Unis qui ne sont pas utilisés à des fins d’adressage de courrier. La sous-région n’est pas destinée aux adresses de livraison.
état
 state string

État, province, comté (en Irlande), Land (en Allemagne), départ (en France), etc.
postalCode
 postalCode string

Code postal. Généralement à l’échelle du pays, mais parfois spécifique à la ville (par exemple, « 2 » dans les adresses « Dublin 2, Irlande »).
country
 country string

Code de pays ISO du pays
Nom Chemin d’accès Type Description
Détails d’un lien vers une ressource
 self LinkDescriptionObject

CustomerCollection

Nom Chemin d’accès Type Description
items
 items array of Customer

Nom

Nom Chemin d’accès Type Description
premier
 first string

Prénom du client
milieu
 middle string

Le prénom du client
last
 last string

Nom du client
prefix
 prefix string

Préfixe du client
suffixe
 suffix string

Suffixe du client
companyName
 companyName string

Si le client représente une entreprise, le nom de la société sera considéré comme étant

LinkDescriptionObject

Nom Chemin d’accès Type Description
href
 href string

URI cible
method
 method string

Verbe HTTP qui DOIT être utilisé pour effectuer une requête à la cible du lien
title
 title string

La propriété title fournit un titre pour le lien et est un outil de documentation utile pour faciliter la compréhension par les clients finaux