Yesing Forum » Cami 線上智慧客服系統 » 使用說明文件 » 會員系統串接機制(v2)

 步驟 1 

請先依照說明安裝 Cami 系統代碼


 步驟 2 

前往管理中心 > 系統整合 > API 金鑰管理,建立或使用既有的 API Key,

建立完成後,會包含金鑰 (API Key) 及密鑰 (API Secret),請妥善保存。




 步驟 3 
於 Cami 系統代碼上方加入以下代碼,此時可利用各開發者工具查看 console 是否有紀錄錯誤訊息。


const camiBridge = {
  setting:{
    apiKey:’API Key’,
    timestamp:’以十位數的 timestamp 表示現在時間’,
    token:’利用 API Secret 將資訊經過 sha256 編碼後的字串 ({API Secret}{timestamp}{Member uniqueId})’
  },
  member:{
    uniqueId:’會員識別編號’
  }
};


 步驟 4 
前往管理中心 → 網站設置 → 通用設定或個別設定 → 設定頁面拉至最下方,選擇「API 設定」。


會員登入網址:當 API URL 回傳需要訪客登入時,系統會將其引導到此處所設定的網址進行登入。

整合 API URL:Cami 將依據步驟2所帶入的會員編號 (Member unique id),以傳送至此 API 位址,取回會員資料。


Cami 傳送資訊至 API URL 時,格式如下:


HTTP GET

apiKey所使用的 API Key
requestId本次進程的識別 ID
(uuid 格式,例:9ee14520-6d0c-e5cf-a61e-e1da153dd4ad)
timestamp
以十位數的 timestamp 表示現在時間
token供驗證來源正確性,利用 API Secret 將資訊經過 sha256 編碼後的字串
({API Secret}{timestamp}{requestId}{Member uniqueId})
memberUniqueIdMember unique id

請務必確實驗證 token 正確後才回傳相關資料,API URL 須回傳格式如下:


JSON

timestamp
required以十位數的 timestamp 表示現在時間,Cami 收到回傳資訊時,將驗證此時間戳記,其誤差必須在正負 120 秒內
token
required供驗證來源正確性,利用 API Secret 將資訊經過 sha256 編碼後的字串
({API Secret}{timestamp}{requestId}{Member uniqueId})
loginRequired required

是否要求訪客進行登入

1:必須登入

0:不須登入

member.displayNameoptional會員顯示名稱
member.realNameoptional會員姓名
member.sexoptional

會員性

1:男
2:女

3:其他

member.phoneoptional會員電話
member.mobileoptional會員手機號碼
member.emailoptional會員 email 電子信箱
member.birthdayoptional

會員生日 {yyyy/mm/dd}

member.addressoptional會員地址
customizeData.0.keyoptional第一個自訂資料欄位名稱
customizeData.0.valueoptional第一個自訂資料欄位值
customizeData.1.key
optional第二個自訂資料欄位名稱
customizeData.1.valueoptional第二個自訂資料欄位值
customizeData.2.keyoptional第三個自訂資料欄位名稱
customizeData.2.valueoptional第三個自訂資料欄位值

回傳 JSON 範例如下:


{"token":"cd1ad25f9608661ca7c73f02f75829c4cb84a0dfd0872fe8ccb82f8e","timestamp":1609430400,"loginRequired":0,"member":{"displayName":"Display Name","realName":"Real Name","sex":"1","phone":"02-2697-1701","mobile":"0987654321","email":"member@mail.com","birthday":"2009\/09\/03","address":"新北市"},"customizeData":[{"key":"近期訂單編號","value":"abc001、abc002、abc003"},{"key":"會員等級","value":"LV5"}]}


 步驟 5 

當訪客進入裝有 Cami 代碼的頁面時,若有設定 API Key,系統將自動向所設定的 API 位址取得會員資訊