對外 API 常見問題
費用、不會寫程式能不能用、API Key 能做什麼、Webhook 沒收到事件怎麼辦,以及停用模組後 key 與 Webhook 會怎樣。
費用
對外 API 要付多少錢?
NT$299/月,以工作區計價,不依人數收費,請求與 Webhook 傳送次數在上限內不另外收費,提供 14 天試用。見方案與價格。
不會寫程式也能用嗎?
可以搭配 Zapier、Make 這類串接服務:在客脈新增 Webhook,把它們提供的網址填進去,就能在新增聯絡人、商機換階段時觸發它們的流程;它們也可以用 API Key 在客脈建立資料。設定方式依各服務的說明。
API Key
API Key 可以做哪些事?
讀寫公司、聯絡人、商機(含換階段、關聯聯絡人、設定標籤)、活動紀錄與待辦,讀取銷售流程、自訂欄位、標籤與成員。不能修改銷售流程、自訂欄位、成員與工作區設定,也還不能存取附件、報價單、發票等加購模組的資料。完整清單見開發者 API。
為什麼 key 突然不能用了?
請依序檢查:
- key 是不是被撤銷或已過期(「API Key」分頁的狀態)。
- 建立者是不是被移出工作區。建立者被移出時,這位成員建立的 key 立即失效。
- 對外 API 模組是不是還在訂閱中,見管理訂閱。
- 是不是每分鐘超過 120 次請求。超過時要等一下再試。
一把 key 可以給好幾個系統用嗎?
可以,但建議一個系統一把,名稱寫清楚用途。這樣某個系統不用了或 key 外洩時,只要撤銷那一把,其他系統不受影響;稽核紀錄也看得出是哪個系統做的變更。
Webhook
為什麼我沒有收到事件?
請依序檢查:
- Webhook 是不是啟用中;連續失敗 20 次會自動停用。
- 有沒有勾選這種事件。
- 看 Webhook 頁面的傳送紀錄:失敗的話,「回應」會顯示對方回應的狀態或錯誤原因。
- 接收端有沒有在 10 秒內回應
2xx。 - 是不是已經超過每天 20,000 次的上限,管理員會收到通知。
同一個事件會不會收到兩次?
可能會。例如接收端已經處理好、但回應太慢被當成失敗,客脈會重試。請用事件的 id 判斷是不是已經處理過,見開發者 API:Webhook。
事件的順序一定正確嗎?
不保證。重試或同時發生的事件可能比較晚到。需要最新狀態時,請用 API Key 讀取那筆資料。
停用與資料
停用模組後,API Key 和 Webhook 會怎樣?
保留但不會生效:API Key 的請求會被拒絕,Webhook 也不會傳送。90 天內重新開通就會恢復;滿 90 天才會刪除。