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

對外 API

用 API Key 讓自己的系統讀寫客脈的公司、聯絡人、商機、活動紀錄與待辦,並用 webhook 在資料異動時即時收到通知。

對外 API 讓你把客脈接上自己的系統。例如「官網聯絡表單送出後,自動在客脈建立聯絡人」、「商機成交時,通知公司的 ERP 建立訂單」、「用 Zapier 或 Make 把新商機同步到試算表」。

包含什麼

  • API Key:你的系統用 API Key 呼叫客脈,讀寫公司、聯絡人、商機、活動紀錄與待辦,也能讀取銷售流程、自訂欄位、標籤與成員。見API Key。
  • Webhook:公司、聯絡人、商機、活動紀錄或待辦有異動時,客脈會把事件送到你指定的網址,你的系統不必一直來查。見Webhook。

要串接的工程師請看開發者 API:網址、認證、每個資源的欄位、錯誤碼與簽章驗證的範例。

在哪裡

  • 使用者選單的「API 與 Webhook」:分成「API Key」與「Webhook」兩個分頁(擁有者與管理員)。
  • 經由 API Key 做的變更,和手動操作一樣出現在紀錄頁;稽核紀錄會標示「經由 API Key」與 key 的名稱。

權限

角色建立、撤銷 API Key新增、修改、刪除 Webhook
擁有者可以可以
管理員可以可以
成員不行不行
檢視者不行不行

API Key 以建立者的身分操作,而且有範圍限制:

  • 唯讀的 key 最多等同「檢視者」,只能讀資料。
  • 讀寫的 key 最多等同「成員」,可以新增、修改、刪除公司、聯絡人、商機、活動紀錄與待辦。
  • 不論範圍,API Key 都不能修改銷售流程、自訂欄位、成員與工作區設定。
  • 建立者被移出工作區時,這位成員建立的 key 立即失效;建立者的角色降低時,key 能做的事也跟著減少。

上限

  • 每個工作區最多 20 把有效的 API Key、10 個 Webhook。
  • 每把 API Key 每分鐘最多 120 次請求,超過時要等一下再試。
  • 每個工作區每天最多傳送 20,000 次 Webhook 事件,超過時當天之後的事件不會送出,並通知管理員;隔天(台北時間午夜)恢復。
  • Webhook 的傳送紀錄保留 30 天。

停用模組後

  • API Key 與 Webhook 保留但不會生效:API Key 的請求會被拒絕,Webhook 也不會傳送。
  • 90 天內重新開通,API Key 與 Webhook 就會恢復;滿 90 天才會刪除。

相關文件