跳到主要內容
客脈 Kemai文件中心
文件選單 加購模組與帳務

API Key

建立、保管與撤銷 API Key:選擇唯讀或讀寫、設定到期日,以及 key 外洩時該怎麼做。

API Key 是你的系統呼叫客脈時用的密碼。建立後把它設定到你的系統(或 Zapier、Make),之後的請求都帶著這把 key。

建立 API Key

  1. 開啟使用者選單,點選「API 與 Webhook」,進入「API Key」分頁。
  2. 填「名稱」,寫清楚是哪個系統在用,例如「官網聯絡表單」。
  3. 選「範圍」:

    • 唯讀:只能讀資料,適合報表、同步到試算表。
    • 讀寫:可以新增、修改、刪除資料,適合表單建立聯絡人、ERP 回寫商機。
  4. 選「到期」:30 天、90 天、1 年或不會到期。
  5. 按「建立 API Key」。
  6. 畫面會顯示完整的 key(kemai_ 開頭)。按「複製」,貼到你的系統,再按「我已經保存好了」。

範圍與身分

API Key 以建立者的身分操作:經由 key 建立的資料,建立者就是你;稽核紀錄的操作者也是你,並標示「經由 API Key」與 key 的名稱。

能做的事取「建立者目前的角色」和「key 的範圍」較小的一個:

建立者的角色唯讀的 key讀寫的 key
擁有者、管理員等同檢視者等同成員
成員等同檢視者等同成員
檢視者等同檢視者等同檢視者

建立者被移出工作區時,這位成員建立的 key 立即失效。如果是人員異動,請由留下的管理員重新建立 key、更新到你的系統,再移除原本的成員。

列表上看得到什麼

每把 key 顯示名稱、前幾碼(方便你對照是哪一把)、範圍、建立者、最後使用時間與狀態(有效、已撤銷、已過期)。最後使用時間大約每小時更新一次。

撤銷 API Key

  1. 在「API Key」分頁找到那把 key,按「撤銷」。
  2. 確認後按「撤銷」。

撤銷後使用這把 key 的系統會立即無法存取,而且無法復原;需要時請重新建立一把。

保管 API Key

  • 只放在伺服器端或 Zapier、Make 這類服務的設定裡;不要放在網頁、App 的前端程式或公開的程式碼庫,任何人拿到都能以你的身分存取資料。
  • 一個系統用一把 key,名稱寫清楚用途;不用的系統就撤銷它的 key。
  • 只需要讀資料的系統用唯讀的 key。
  • 懷疑 key 外洩時,馬上撤銷,再建立新的 key 更新到你的系統,並到稽核紀錄檢查經由這把 key 做了哪些變更。

相關文件