CDK Drive Customer (プレビュー)
この API を使用すると、CDK Drive でサービスの顧客を検索、取得、およびフィルター処理できます。 CDK ドライブ内では、顧客とは、車両を販売した人、車両の見込み客、部品を購入した人、または販売店を通じて車両を修理または修理し、CRM システムに存在する個人です。 さらに、このコネクタを使用すると、基本的な顧客レコードを作成できます。 これにより、サービス アドバイザーは、これらのワークフローを顧客に関連付けることで、肯定的なエクスペリエンスを提供できます。
このコネクタは、次の製品とリージョンで使用できます。
| サービス | クラス | リージョン |
|---|---|---|
| コピロット スタジオ | Premium | 次を除くすべての Power Automate リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| ロジック アプリ | Standard | 次を除くすべての Logic Apps リージョン : - Azure Government リージョン - Azure China リージョン - 米国国防総省 (DoD) |
| Power Apps | Premium | 次を除くすべての Power Apps リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| Power Automate | Premium | 次を除くすべての Power Automate リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| お問い合わせ | |
|---|---|
| 名前 | CDK グローバル |
| URL | https://serviceconnect.support.cdk.com |
| mbd_support@cdk.com |
| コネクタ メタデータ | |
|---|---|
| Publisher | CDK グローバル |
| Website | https://fortellis.io |
| プライバシー ポリシー | https://fortellis.io/privacy |
| カテゴリ | データ |
に関しては
CDKDrive Customer API V1 を使用すると、CDK ドライブ内の顧客レコードを検索、表示、作成、更新できます。
https://apidocs.fortellis.io/specs/0d488dd1-c609-4618-9061-68be8b61c2a9
主要概念
顧客
お客様は、CDK ドライブ DMS の個人であり、次の条件の少なくとも 1 つを満たしています。
- ディーラーから車両を購入 (または車両を購入する見込み)
- 販売店から購入した部品
- 修理またはサービスのためにディーラーに車両を持ち込んだ
潜在的なユース ケース
CDKDrive Customer API を使用して、次のような状況を処理するソリューションを作成します。
- 顧客を検索して顧客の詳細を表示する
- 顧客情報を作成または更新する
- 顧客の優先する連絡方法を更新する
- CDKDrive Service Vehicles API を使用して車両とリンクするための顧客情報を取得する
関連する API
CDKDrive Customer API は、独立して、または次のいずれかの API で使用できます。
取引
購入またはリースしている顧客と車両に関する情報を使用して、取引を検索して作成します。 CDKDrive Customer API を使用して、顧客レコードを取引に関連付けることができます。 Deals API: ディーラーの従業員を取得します。
CDKDRIVE 修理注文
CDK ドライブでサービス書き込みワークフローを有効にします。 CDKDrive Customer API を使用して、顧客レコードを修理注文に関連付けることができます。
https://apidocs.fortellis.io/specs/b0f20c99-ed1f-49de-a0e8-6776d2ee0fe3
CDKDRIVE サービス 車両
CDK ドライブでサービス ドメイン車両情報を作成、更新、クエリ、取得します。 CDKDrive Service Vehicles API を使用して、顧客を車両にリンクできます。
https://apidocs.fortellis.io/specs/54b70ee1-ac17-4be2-9314-45c947692c5d
CDKDRIVE CUSTOMER API の概要
前提条件
続行するには、次のものが必要です
• コネクタを使用するには、Fortellis ユーザーである必要があります。
• API の呼び出し中に使用するクライアント ID とシークレットを生成するには、Fortellis でソリューションを作成する必要があります
詳細なドキュメントについては、〘〘
https://apidocs.fortellis.io/specs/0d488dd1-c609-4618-9061-68be8b61c2a9
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| 顧客にクエリを実行する |
顧客にクエリを実行する |
| 顧客にクエリを実行する |
顧客にクエリを実行する |
| 顧客の作成 |
顧客の作成 |
| 顧客を更新する |
顧客を更新する |
顧客にクエリを実行する
顧客にクエリを実行する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
顧客 ID
|
customerId | True | string |
顧客識別子 |
|
サブスクリプション ID
|
subscription_id | True | string |
指定された要求の戻り値を示すために呼び出し元に返される関連付け ID。 |
|
クライアント ID
|
client_id | True | string |
ソリューションを構築する開発者/ソリューション プロバイダーに固有のクライアント ID。 |
|
クライアント シークレット
|
client_secret | True | string |
ソリューションを構築する開発者/ソリューション プロバイダーに固有のクライアント シークレット。 |
|
要求 ID
|
Request-Id | string |
書式 - guid。 指定された要求の戻り値を示すために呼び出し元に返される関連付け ID |
戻り値
- Body
- Customer
顧客にクエリを実行する
顧客にクエリを実行する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
名前
|
name | string |
名前で顧客をフィルター処理する |
|
|
Email
|
string |
メール アドレスで顧客をフィルター処理する |
||
|
電話
|
phone | string |
電話番号で顧客をフィルター処理する |
|
|
サブスクリプション ID
|
subscription_id | True | string |
指定された要求の戻り値を示すために呼び出し元に返される関連付け ID。 |
|
クライアント ID
|
client_id | True | string |
ソリューションを構築する開発者/ソリューション プロバイダーに固有のクライアント ID。 |
|
クライアント シークレット
|
client_secret | True | string |
ソリューションを構築する開発者/ソリューション プロバイダーに固有のクライアント シークレット。 |
|
要求 ID
|
Request-Id | string |
書式 - guid。 指定された要求の戻り値を示すために呼び出し元に返される関連付け ID |
戻り値
- Body
- CustomerCollection
顧客の作成
顧客の作成
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
クライアント ID
|
client_id | True | string |
ソリューションを構築する開発者/ソリューション プロバイダーに固有のクライアント ID。 |
|
クライアント シークレット
|
client_secret | True | string |
ソリューションを構築する開発者/ソリューション プロバイダーに固有のクライアント シークレット。 |
|
サブスクリプション ID
|
subscription_id | True | string |
指定された要求の戻り値を示すために呼び出し元に返される関連付け ID。 |
|
要求 ID
|
Request-Id | string |
書式 - guid。 指定された要求の戻り値を示すために呼び出し元に返される関連付け ID |
|
|
first
|
first | True | string |
顧客の名 |
|
中央
|
middle | string |
顧客のミドル ネーム |
|
|
last
|
last | True | string |
顧客の姓 |
|
prefix
|
prefix | string |
顧客のプレフィックス |
|
|
接尾辞
|
suffix | string |
顧客のサフィックス |
|
|
primaryPhone
|
primaryPhone | string |
顧客のプライマリ電話番号 |
|
|
homePhone
|
homePhone | string |
顧客の自宅電話番号 |
|
|
mobilePhone
|
mobilePhone | string |
顧客の携帯電話番号 |
|
|
ポケットベル
|
pager | string |
顧客のポケットベル番号 |
|
|
pagerAccessCode
|
pagerAccessCode | string |
顧客のポケットベル アクセス コード |
|
|
homeFax
|
homeFax | string |
顧客の自宅 FAX 番号 |
|
|
workFax
|
workFax | string |
顧客の勤務先 FAX 番号 |
|
|
email1
|
email1 | string |
顧客のメール アドレス 1。 他の電子メール アドレスが存在しない場合は、該当しない場合は NA、顧客拒否の場合は CD を入力できます |
|
|
emailDesc1
|
emailDesc1 | string |
電子メール アドレス 1 の説明。 電子メール 1 に入力した場合、NA または CD が含まれます。 |
|
|
email2
|
email2 | string |
顧客のメール アドレス 2 |
|
|
emailDesc2
|
emailDesc2 | string |
メール アドレス 2 の説明 |
|
|
email3
|
email3 | string |
顧客のメール アドレス 3 |
|
|
emailDesc3
|
emailDesc3 | string |
電子メール アドレス 3 の説明 |
|
|
email4
|
email4 | string |
顧客のメール アドレス 4 |
|
|
emailDesc4
|
emailDesc4 | string |
電子メール アドレス 4 の説明 |
|
|
email5
|
email5 | string |
顧客のメール アドレス 5 |
|
|
emailDesc5
|
emailDesc5 | string |
電子メール アドレス 5 の説明 |
|
|
email6
|
email6 | string |
顧客の電子メール アドレス 6 |
|
|
emailDesc6
|
emailDesc6 | string |
電子メール アドレス 6 の説明 |
|
|
preferredMethod
|
preferredMethod | string |
お客様の優先する連絡方法 |
|
|
blockPhoneFlag
|
blockPhoneFlag | boolean |
電話による電話広告を行うかどうかを示します |
|
|
blockEmailFlag
|
blockEmailFlag | boolean |
電子メールの広告をブロックするかどうかを示します |
|
|
blockMailFlag
|
blockMailFlag | boolean |
メール広告をブロックするかどうかを示します |
|
|
街路
|
street | string |
通り、大通り、道路などです。この要素には、家の番号と部屋/アパートメント/フラット/フロア番号も含まれます。 |
|
|
city
|
city | string |
都市、村、町、自治区などです。これは郵便の町であり、必ずしも居住地や勤務先ではありません。 |
|
|
郡
|
county | string |
メール アドレス指定の目的で使用されない米国または英国の郡などの管理地区を処理します。 サブリージョンは、配信アドレスを対象としていません。 |
|
|
状態
|
state | string |
州、州、郡 (アイルランド)、土地 (ドイツ)、出国 (フランス) など。 |
|
|
postalCode
|
postalCode | string |
郵便番号。 通常は全国的ですが、都市に固有の場合もあります ('ダブリン 2、アイルランド' の住所の '2' など)。 |
|
|
country
|
country | string |
国の ISO 国コード |
戻り値
- Body
- Customer
顧客を更新する
顧客を更新する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
顧客 ID
|
customerId | True | string |
顧客識別子 |
|
サブスクリプション ID
|
subscription_id | True | string |
指定された要求の戻り値を示すために呼び出し元に返される関連付け ID。 |
|
クライアント ID
|
client_id | True | string |
ソリューションを構築する開発者/ソリューション プロバイダーに固有のクライアント ID。 |
|
クライアント シークレット
|
client_secret | True | string |
ソリューションを構築する開発者/ソリューション プロバイダーに固有のクライアント シークレット。 |
|
要求 ID
|
Request-Id | string |
書式 - guid。 指定された要求の戻り値を示すために呼び出し元に返される関連付け ID |
|
|
eTag
|
If-Match | True | string |
リソース更新要求を条件付きにします。 If-Match で提示されるチェックサム値は、リソースの現在の ETag 値と一致している必要があります。 |
|
first
|
first | True | string |
顧客の名 |
|
中央
|
middle | string |
顧客のミドル ネーム |
|
|
last
|
last | True | string |
顧客の姓 |
|
prefix
|
prefix | string |
顧客のプレフィックス |
|
|
接尾辞
|
suffix | string |
顧客のサフィックス |
|
|
primaryPhone
|
primaryPhone | string |
顧客のプライマリ電話番号 |
|
|
homePhone
|
homePhone | string |
顧客の自宅電話番号 |
|
|
mobilePhone
|
mobilePhone | string |
顧客の携帯電話番号 |
|
|
ポケットベル
|
pager | string |
顧客のポケットベル番号 |
|
|
pagerAccessCode
|
pagerAccessCode | string |
顧客のポケットベル アクセス コード |
|
|
homeFax
|
homeFax | string |
顧客の自宅 FAX 番号 |
|
|
workFax
|
workFax | string |
顧客の勤務先 FAX 番号 |
|
|
email1
|
email1 | string |
顧客のメール アドレス 1。 他の電子メール アドレスが存在しない場合は、該当しない場合は NA、顧客拒否の場合は CD を入力できます |
|
|
emailDesc1
|
emailDesc1 | string |
電子メール アドレス 1 の説明。 電子メール 1 に入力した場合、NA または CD が含まれます。 |
|
|
email2
|
email2 | string |
顧客のメール アドレス 2 |
|
|
emailDesc2
|
emailDesc2 | string |
メール アドレス 2 の説明 |
|
|
email3
|
email3 | string |
顧客のメール アドレス 3 |
|
|
emailDesc3
|
emailDesc3 | string |
電子メール アドレス 3 の説明 |
|
|
email4
|
email4 | string |
顧客のメール アドレス 4 |
|
|
emailDesc4
|
emailDesc4 | string |
電子メール アドレス 4 の説明 |
|
|
email5
|
email5 | string |
顧客のメール アドレス 5 |
|
|
emailDesc5
|
emailDesc5 | string |
電子メール アドレス 5 の説明 |
|
|
email6
|
email6 | string |
顧客の電子メール アドレス 6 |
|
|
emailDesc6
|
emailDesc6 | string |
電子メール アドレス 6 の説明 |
|
|
preferredMethod
|
preferredMethod | string |
お客様の優先する連絡方法 |
|
|
blockPhoneFlag
|
blockPhoneFlag | boolean |
電話による電話広告を行うかどうかを示します |
|
|
blockEmailFlag
|
blockEmailFlag | boolean |
電子メールの広告をブロックするかどうかを示します |
|
|
blockMailFlag
|
blockMailFlag | boolean |
メール広告をブロックするかどうかを示します |
|
|
街路
|
street | string |
通り、大通り、道路などです。この要素には、家の番号と部屋/アパートメント/フラット/フロア番号も含まれます。 |
|
|
city
|
city | string |
都市、村、町、自治区などです。これは郵便の町であり、必ずしも居住地や勤務先ではありません。 |
|
|
郡
|
county | string |
メール アドレス指定の目的で使用されない米国または英国の郡などの管理地区を処理します。 サブリージョンは、配信アドレスを対象としていません。 |
|
|
状態
|
state | string |
州、州、郡 (アイルランド)、土地 (ドイツ)、出国 (フランス) など。 |
|
|
postalCode
|
postalCode | string |
郵便番号。 通常は全国的ですが、都市に固有の場合もあります ('ダブリン 2、アイルランド' の住所の '2' など)。 |
|
|
country
|
country | string |
国の ISO 国コード |
戻り値
- Body
- Customer
定義
カスタマー
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
customerId
|
customerId | string |
顧客レコードの識別子 |
|
名前
|
name | Name | |
|
contactMethods
|
contactMethods | ContactMethods | |
|
postalAddress
|
postalAddress | PostalAddress | |
|
preferredContact
|
preferredContact | string |
好ましい接触方法 |
|
links
|
links | CustomerLinks |
ContactMethods
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
primaryPhone
|
primaryPhone | string |
顧客のプライマリ電話番号 |
|
homePhone
|
homePhone | string |
顧客の自宅電話番号 |
|
mobilePhone
|
mobilePhone | string |
顧客の携帯電話番号 |
|
ポケットベル
|
pager | string |
顧客のポケットベル番号 |
|
pagerAccessCode
|
pagerAccessCode | string |
顧客のポケットベル アクセス コード |
|
homeFax
|
homeFax | string |
顧客の自宅 FAX 番号 |
|
workFax
|
workFax | string |
顧客の勤務先 FAX 番号 |
|
email1
|
email1 | string |
顧客のメール アドレス 1。 他の電子メール アドレスが存在しない場合は、該当しない場合は NA、顧客拒否の場合は CD を入力できます |
|
emailDesc1
|
emailDesc1 | string |
電子メール アドレス 1 の説明。 電子メール 1 に入力した場合、NA または CD が含まれます。 |
|
email2
|
email2 | string |
顧客のメール アドレス 2 |
|
emailDesc2
|
emailDesc2 | string |
メール アドレス 2 の説明 |
|
email3
|
email3 | string |
顧客のメール アドレス 3 |
|
emailDesc3
|
emailDesc3 | string |
電子メール アドレス 3 の説明 |
|
email4
|
email4 | string |
顧客のメール アドレス 4 |
|
emailDesc4
|
emailDesc4 | string |
電子メール アドレス 4 の説明 |
|
email5
|
email5 | string |
顧客のメール アドレス 5 |
|
emailDesc5
|
emailDesc5 | string |
電子メール アドレス 5 の説明 |
|
email6
|
email6 | string |
顧客の電子メール アドレス 6 |
|
emailDesc6
|
emailDesc6 | string |
電子メール アドレス 6 の説明 |
|
preferredMethod
|
preferredMethod | string |
お客様の優先する連絡方法 |
|
blockPhoneFlag
|
blockPhoneFlag | boolean |
電話による電話広告を行うかどうかを示します |
|
blockEmailFlag
|
blockEmailFlag | boolean |
電子メールの広告をブロックするかどうかを示します |
|
blockMailFlag
|
blockMailFlag | boolean |
メール広告をブロックするかどうかを示します |
PostalAddress
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
街路
|
street | string |
通り、大通り、道路などです。この要素には、家の番号と部屋/アパートメント/フラット/フロア番号も含まれます。 |
|
city
|
city | string |
都市、村、町、自治区などです。これは郵便の町であり、必ずしも居住地や勤務先ではありません。 |
|
郡
|
county | string |
メール アドレス指定の目的で使用されない米国または英国の郡などの管理地区を処理します。 サブリージョンは、配信アドレスを対象としていません。 |
|
状態
|
state | string |
州、州、郡 (アイルランド)、土地 (ドイツ)、出国 (フランス) など。 |
|
postalCode
|
postalCode | string |
郵便番号。 通常は全国的ですが、都市に固有の場合もあります ('ダブリン 2、アイルランド' の住所の '2' など)。 |
|
country
|
country | string |
国の ISO 国コード |
CustomerLinks
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
リソースへのリンクの詳細
|
self | LinkDescriptionObject |
CustomerCollection
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
items
|
items | array of Customer |
名前
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
first
|
first | string |
顧客の名 |
|
中央
|
middle | string |
顧客のミドル ネーム |
|
last
|
last | string |
顧客の姓 |
|
prefix
|
prefix | string |
顧客のプレフィックス |
|
接尾辞
|
suffix | string |
顧客のサフィックス |
|
companyName
|
companyName | string |
顧客が会社を表す場合は、会社名が考慮されます |
LinkDescriptionObject
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
href
|
href | string |
ターゲット URI |
|
メソッド
|
method | string |
リンクのターゲットに要求を行うために使用する必要がある HTTP 動詞 |
|
title
|
title | string |
title プロパティはリンクのタイトルを提供し、エンド クライアントによる理解を容易にする便利なドキュメント ツールです |