CDK 磁碟驅動器客戶 （預覽版）
API 可讓您在 CDK Drive 中尋找、擷取和篩選服務客戶。 在 CDK Drive 中，客戶是已出售車輛、是車輛的潛在客戶、購買了零件或通過經銷商維修或保養車輛並存在於 CRM 系統中的個人。 此外，此連接器可讓您建立基本客戶記錄。 這有助於服務顧問允許這些工作流程與客戶綁定，從而提供積極的體驗。
此連接器適用於以下產品和區域：
| 服務 | Class | Regions |
|---|---|---|
| 副駕駛工作室 | 進階 | 除下列區域外的所有 Power Automate 區域 ： - 美國政府 （GCC） - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部 （DoD） |
| 邏輯應用程式 | 標準 | 所有 Logic Apps 區域， 但下列區域除外： - Azure Government 區域 - Azure 中國區域 - 美國國防部 （DoD） |
| Power Apps | 進階 | 除下列區域外的所有 Power Apps 區域 ： - 美國政府 （GCC） - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部 （DoD） |
| Power Automate（自動化服務） | 進階 | 除下列區域外的所有 Power Automate 區域 ： - 美國政府 （GCC） - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部 （DoD） |
| 連絡人 | |
|---|---|
| 名稱 | CDK全球 |
| URL | https://serviceconnect.support.cdk.com |
| mbd_support@cdk.com |
| 連接器中繼資料 | |
|---|---|
| Publisher | CDK全球 |
| 網站 | https://fortellis.io |
| 隱私策略 | https://fortellis.io/privacy |
| 類別 | 資料 |
大約
CDKDrive Customer API V1 可讓您在 CDK Drive 中搜尋、檢視、建立和更新客戶記錄。
https://apidocs.fortellis.io/specs/0d488dd1-c609-4618-9061-68be8b61c2a9
重要概念
客戶
客戶是 CDK Drive DMS 中至少符合下列條件之一的個人：
- 從經銷商處購買了車輛（或有購買車輛的潛在客戶）
- 從經銷商處購買的零件
- 將車輛帶到經銷商處進行維修或保養
潛在用例
使用 CDKDrive 客戶 API 建立解決方案來處理以下情況：
- 搜尋客戶並顯示客戶詳細資料
- 建立或更新客戶資訊
- 更新客戶偏好的聯絡方式
- 使用 CDKDrive Service Vehicles API 獲取客戶信息以與車輛鏈接
相關的 API
CDKDrive 客戶 API 可以獨立使用，也可以與下列任何 API 搭配使用。
優惠
使用有關他們正在購買或租賃的客戶和車輛的信息查找並創建交易。 CDKDrive Customer API 可用來將客戶記錄與交易建立關聯。 交易 API：獲取經銷商員工。
CDKDRIVE 維修訂單
在 CDK Drive 上啟用服務寫入工作流程。 CDKDrive Customer API 可用來將客戶記錄與維修訂單建立關聯。
https://apidocs.fortellis.io/specs/b0f20c99-ed1f-49de-a0e8-6776d2ee0fe3
CDKDRIVE 服務車輛
在 CDK Drive 中建立、更新、查詢和擷取服務網域車輛資訊。 您可以使用 CDKDrive Service Vehicles API 將客戶連結至車輛。
https://apidocs.fortellis.io/specs/54b70ee1-ac17-4be2-9314-45c947692c5d
開始使用 CDKDRIVE 客戶 API
Pre-requisites
您需要以下內容才能繼續
• 要使用連接器，您需要是 Fortellis 用戶。
• 您需要在 Fortellis 中創建一個解決方案來生成要在調用 API 時使用的客戶端 ID 和密碼
詳細文件可在以下網址找到：
https://apidocs.fortellis.io/specs/0d488dd1-c609-4618-9061-68be8b61c2a9
節流限制
| 名稱 | 呼叫 | 續約期間 |
|---|---|---|
| 每個連線的 API 呼叫 | 100 | 60 秒 |
動作
| 建立客戶 |
建立客戶 |
| 更新客戶 |
更新客戶 |
| 查詢客戶 |
查詢客戶 |
| 查詢客戶 |
查詢客戶 |
建立客戶
建立客戶
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
用戶端識別碼
|
client_id | True | string |
建置解決方案的開發人員/解決方案提供者應該是唯一的用戶端識別碼。 |
|
用戶端密碼
|
client_secret | True | string |
建置解決方案的開發人員/解決方案提供者應該是唯一的用戶端密碼。 |
|
訂用帳戶識別碼
|
subscription_id | True | string |
應該傳回呼叫端的相互關聯識別碼，以指出指定要求的傳回。 |
|
請求標識碼
|
Request-Id | string |
格式 - 引導。 應該傳回給呼叫端的相互關聯識別碼，以指出傳回指定要求 |
|
|
先
|
first | True | string |
客戶的名字 |
|
中
|
middle | string |
客戶的中間名 |
|
|
last
|
last | True | string |
客戶的姓氏 |
|
prefix
|
prefix | string |
客戶的前置詞 |
|
|
後綴
|
suffix | string |
客戶的後綴 |
|
|
主要電話
|
primaryPhone | string |
客戶的主要電話號碼 |
|
|
首頁電話
|
homePhone | string |
客戶的住家電話號碼 |
|
|
手機
|
mobilePhone | string |
客戶的手機號碼 |
|
|
呼叫器
|
pager | string |
客戶的傳呼機號碼 |
|
|
尋頁器存取代碼
|
pagerAccessCode | string |
客戶的傳呼機存取碼 |
|
|
首頁傳真
|
homeFax | string |
客戶的家庭傳真號碼 |
|
|
工作傳真
|
workFax | string |
客戶的工作傳真號碼 |
|
|
電子郵件1
|
email1 | string |
客戶的電子郵件地址 1。 如果沒有其他電子郵件地址，您可以輸入 NA 表示 Non-Applicable 或 CD 表示 Customer Declined |
|
|
電子郵件描述1
|
emailDesc1 | string |
電子郵件地址 1 描述。 如果在電子郵件中輸入，將包含 NA 或 CD1。 |
|
|
電子郵件2
|
email2 | string |
客戶的電子郵件地址 2 |
|
|
電子郵件描述2
|
emailDesc2 | string |
電子郵件地址 2 說明 |
|
|
電子郵件3
|
email3 | string |
客戶的電子郵件地址 3 |
|
|
電子郵件描述3
|
emailDesc3 | string |
電子郵件地址 3 說明 |
|
|
電子郵件4
|
email4 | string |
客戶的電子郵件地址 4 |
|
|
電子郵件描述4
|
emailDesc4 | string |
電子郵件地址 4 說明 |
|
|
電子郵件5
|
email5 | string |
客戶的電子郵件地址 5 |
|
|
電子郵件描述5
|
emailDesc5 | string |
電子郵件地址 5 說明 |
|
|
電子郵件6
|
email6 | string |
客戶的電子郵件地址6 |
|
|
電子郵件描述6
|
emailDesc6 | string |
電子郵件地址 6 說明 |
|
|
preferred方法
|
preferredMethod | string |
客戶首選的聯絡方式 |
|
|
blockPhone旗標
|
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 國家代碼 |
傳回
- 身體
- Customer
更新客戶
更新客戶
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
客戶識別碼
|
customerId | True | string |
客戶識別碼 |
|
訂用帳戶識別碼
|
subscription_id | True | string |
應該傳回呼叫端的相互關聯識別碼，以指出指定要求的傳回。 |
|
用戶端識別碼
|
client_id | True | string |
建置解決方案的開發人員/解決方案提供者應該是唯一的用戶端識別碼。 |
|
用戶端密碼
|
client_secret | True | string |
建置解決方案的開發人員/解決方案提供者應該是唯一的用戶端密碼。 |
|
請求標識碼
|
Request-Id | string |
格式 - 引導。 應該傳回給呼叫端的相互關聯識別碼，以指出傳回指定要求 |
|
|
eTag
|
If-Match | True | string |
使資源更新要求成為條件式。 隨 If-Match 呈現的總和檢查碼值必須符合資源的目前 ETag 值。 |
|
先
|
first | True | string |
客戶的名字 |
|
中
|
middle | string |
客戶的中間名 |
|
|
last
|
last | True | string |
客戶的姓氏 |
|
prefix
|
prefix | string |
客戶的前置詞 |
|
|
後綴
|
suffix | string |
客戶的後綴 |
|
|
主要電話
|
primaryPhone | string |
客戶的主要電話號碼 |
|
|
首頁電話
|
homePhone | string |
客戶的住家電話號碼 |
|
|
手機
|
mobilePhone | string |
客戶的手機號碼 |
|
|
呼叫器
|
pager | string |
客戶的傳呼機號碼 |
|
|
尋頁器存取代碼
|
pagerAccessCode | string |
客戶的傳呼機存取碼 |
|
|
首頁傳真
|
homeFax | string |
客戶的家庭傳真號碼 |
|
|
工作傳真
|
workFax | string |
客戶的工作傳真號碼 |
|
|
電子郵件1
|
email1 | string |
客戶的電子郵件地址 1。 如果沒有其他電子郵件地址，您可以輸入 NA 表示 Non-Applicable 或 CD 表示 Customer Declined |
|
|
電子郵件描述1
|
emailDesc1 | string |
電子郵件地址 1 描述。 如果在電子郵件中輸入，將包含 NA 或 CD1。 |
|
|
電子郵件2
|
email2 | string |
客戶的電子郵件地址 2 |
|
|
電子郵件描述2
|
emailDesc2 | string |
電子郵件地址 2 說明 |
|
|
電子郵件3
|
email3 | string |
客戶的電子郵件地址 3 |
|
|
電子郵件描述3
|
emailDesc3 | string |
電子郵件地址 3 說明 |
|
|
電子郵件4
|
email4 | string |
客戶的電子郵件地址 4 |
|
|
電子郵件描述4
|
emailDesc4 | string |
電子郵件地址 4 說明 |
|
|
電子郵件5
|
email5 | string |
客戶的電子郵件地址 5 |
|
|
電子郵件描述5
|
emailDesc5 | string |
電子郵件地址 5 說明 |
|
|
電子郵件6
|
email6 | string |
客戶的電子郵件地址6 |
|
|
電子郵件描述6
|
emailDesc6 | string |
電子郵件地址 6 說明 |
|
|
preferred方法
|
preferredMethod | string |
客戶首選的聯絡方式 |
|
|
blockPhone旗標
|
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 國家代碼 |
傳回
- 身體
- Customer
查詢客戶
查詢客戶
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
客戶識別碼
|
customerId | True | string |
客戶識別碼 |
|
訂用帳戶識別碼
|
subscription_id | True | string |
應該傳回呼叫端的相互關聯識別碼，以指出指定要求的傳回。 |
|
用戶端識別碼
|
client_id | True | string |
建置解決方案的開發人員/解決方案提供者應該是唯一的用戶端識別碼。 |
|
用戶端密碼
|
client_secret | True | string |
建置解決方案的開發人員/解決方案提供者應該是唯一的用戶端密碼。 |
|
請求標識碼
|
Request-Id | string |
格式 - 引導。 應該傳回給呼叫端的相互關聯識別碼，以指出傳回指定要求 |
傳回
- 身體
- Customer
查詢客戶
查詢客戶
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
名稱
|
name | string |
按名稱篩選客戶 |
|
|
Email
|
string |
按電子郵件地址過濾客戶 |
||
|
電話
|
phone | string |
按電話號碼過濾客戶 |
|
|
訂用帳戶識別碼
|
subscription_id | True | string |
應該傳回呼叫端的相互關聯識別碼，以指出指定要求的傳回。 |
|
用戶端識別碼
|
client_id | True | string |
建置解決方案的開發人員/解決方案提供者應該是唯一的用戶端識別碼。 |
|
用戶端密碼
|
client_secret | True | string |
建置解決方案的開發人員/解決方案提供者應該是唯一的用戶端密碼。 |
|
請求標識碼
|
Request-Id | string |
格式 - 引導。 應該傳回給呼叫端的相互關聯識別碼，以指出傳回指定要求 |
傳回
定義
客戶
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
customerId
|
customerId | string |
客戶記錄的識別碼 |
|
名稱
|
name | Name | |
|
contact方法
|
contactMethods | ContactMethods | |
|
郵政地址
|
postalAddress | PostalAddress | |
|
preferred聯絡方式
|
preferredContact | string |
首選的聯絡方式 |
|
links
|
links | CustomerLinks |
聯絡方法
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
主要電話
|
primaryPhone | string |
客戶的主要電話號碼 |
|
首頁電話
|
homePhone | string |
客戶的住家電話號碼 |
|
手機
|
mobilePhone | string |
客戶的手機號碼 |
|
呼叫器
|
pager | string |
客戶的傳呼機號碼 |
|
尋頁器存取代碼
|
pagerAccessCode | string |
客戶的傳呼機存取碼 |
|
首頁傳真
|
homeFax | string |
客戶的家庭傳真號碼 |
|
工作傳真
|
workFax | string |
客戶的工作傳真號碼 |
|
電子郵件1
|
email1 | string |
客戶的電子郵件地址 1。 如果沒有其他電子郵件地址，您可以輸入 NA 表示 Non-Applicable 或 CD 表示 Customer Declined |
|
電子郵件描述1
|
emailDesc1 | string |
電子郵件地址 1 描述。 如果在電子郵件中輸入，將包含 NA 或 CD1。 |
|
電子郵件2
|
email2 | string |
客戶的電子郵件地址 2 |
|
電子郵件描述2
|
emailDesc2 | string |
電子郵件地址 2 說明 |
|
電子郵件3
|
email3 | string |
客戶的電子郵件地址 3 |
|
電子郵件描述3
|
emailDesc3 | string |
電子郵件地址 3 說明 |
|
電子郵件4
|
email4 | string |
客戶的電子郵件地址 4 |
|
電子郵件描述4
|
emailDesc4 | string |
電子郵件地址 4 說明 |
|
電子郵件5
|
email5 | string |
客戶的電子郵件地址 5 |
|
電子郵件描述5
|
emailDesc5 | string |
電子郵件地址 5 說明 |
|
電子郵件6
|
email6 | string |
客戶的電子郵件地址6 |
|
電子郵件描述6
|
emailDesc6 | string |
電子郵件地址 6 說明 |
|
preferred方法
|
preferredMethod | string |
客戶首選的聯絡方式 |
|
blockPhone旗標
|
blockPhoneFlag | boolean |
指示是否要打電話廣告 |
|
blockEmailFlag
|
blockEmailFlag | boolean |
指出是否要封鎖電子郵件廣告 |
|
blockMailFlag
|
blockMailFlag | boolean |
指出是否要封鎖郵件廣告 |
郵寄地址
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
街道
|
street | string |
可以是街道、大道、道路等。此元素還包括門牌號和房間/公寓/公寓/樓層號。 |
|
city
|
city | string |
可以是城市、村莊、城鎮、行政區等。這是郵政城鎮，不一定是居住地或營業地點。 |
|
縣
|
county | string |
處理不用於郵件定址目的的行政區，例如美國或英國縣。 子區域不適用於送貨地址。 |
|
狀態
|
state | string |
州、省、縣（愛爾蘭）、土地（德國）、省（法國）等。 |
|
postalCode
|
postalCode | string |
郵遞區號。 通常是全國範圍內的，但有時特定於城市（例如「都柏林 2，愛爾蘭」地址中的「2」）。 |
|
country
|
country | string |
該國家/地區的 ISO 國家代碼 |
客戶連結
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
資源連結的詳細資料
|
self | LinkDescriptionObject |
客戶集合
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
items
|
items | array of Customer |
名稱
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
先
|
first | string |
客戶的名字 |
|
中
|
middle | string |
客戶的中間名 |
|
last
|
last | string |
客戶的姓氏 |
|
prefix
|
prefix | string |
客戶的前置詞 |
|
後綴
|
suffix | string |
客戶的後綴 |
|
companyName
|
companyName | string |
如果客戶代表一家公司，則公司名稱將被考慮 |
LinkDescription物件
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
href
|
href | string |
目標 URI |
|
方法
|
method | string |
必須用來向連結目標提出要求的 HTTP 動詞 |
|
title
|
title | string |
title 屬性提供連結的標題，而且是有助於最終客戶理解的實用文件工具 |