選單路徑: 儀表板 > APIs > 端點詳細 > 檢視全部
協作金鑰
概述
協作金鑰允許您為外部協作者（合作夥伴、客戶、其他內部系統等）簽發專用 API 金鑰來呼叫您的端點。每個協作金鑰可以獨立設定：
- 專用 API 金鑰（沙箱環境 / 正式環境各 1 對，建立時立即簽發）
- CRUD 權限 — Create (POST) / Read (GET) / Update (PUT) / Delete (DELETE)
- 啟用 / 停用 切換 — 立即攔截特定協作者
- 電子郵件邀請 — 向單個金鑰邀請多個協作者
什麼時候需要？
- 與多個合作夥伴共享端點，想要追蹤各方的呼叫量
- 想要給特定合作夥伴僅讀取（GET）權限
- 需要因問題僅停止某個合作夥伴的呼叫
- 合作夥伴的開發者需要存取測試頁面和整合指南
一個金鑰，多個協作者
單個協作金鑰可以邀請多個協作者。通常用於「每家公司 1 個金鑰 → 邀請該公司的聯絡人」。
如何進入
- 頂部選單 APIs → 點擊端點名稱進入端點詳細
- 在協作金鑰區域點擊
檢視全部按鈕
協作金鑰列表
所有已註冊的協作金鑰以表格形式顯示。
| 欄位 | 說明 |
|---|---|
| 序號 | 列號 |
| 名稱 | 協作金鑰名稱（例如合作夥伴名稱） |
| 描述 | 用途描述 |
| 邀請 | 邀請狀態。X 人已接受，Y 人待處理 格式 |
| 沙箱環境 | 沙箱環境 API 金鑰啟用/停用標籤 |
| 正式環境 | 正式環境 API 金鑰啟用/停用標籤 |
| 建立時間 | 協作金鑰建立時間 |
點擊頂部的 新增 按鈕註冊新金鑰。點擊表格中的名稱進入詳細頁面。
新增協作金鑰
點擊 新增 開啟對話框。此步驟是建立協作 API 金鑰——邀請協作者在之後的詳細頁面進行。
輸入欄位
- 協作金鑰名稱 — 必填。輸入可區分的名稱，如合作夥伴或團隊名稱（例如
Acme Corp、Mobile Team） - 描述 — 可選。簡要說明用途
- 權限 — 選擇該金鑰允許執行的 API 操作
Create (POST)/Read (GET)/Update (PUT)/Delete (DELETE)- 預設全部選取。僅勾選需要的即可
儲存後將立即簽發沙箱環境和正式環境 API 金鑰，然後跳轉到詳細頁面。
協作金鑰詳細
單個協作金鑰的所有管理在此頁面完成。
API 金鑰
頂部有 沙箱環境 | 正式環境 分頁，獨立管理各環境的 API 金鑰。
- API 金鑰顯示：提供隱藏、複製和重新生成按鈕
- 啟用/停用切換（電源圖示）：切換為停用後，該環境中使用此金鑰的所有 API 呼叫立即被拒絕。用於暫時攔截特定協作者
- 重新生成：舊金鑰立即失效並簽發新金鑰。請務必通知協作者金鑰已更換
權限
指定該協作金鑰可以執行的 API 操作。
- Create (POST) / Read (GET) / Update (PUT) / Delete (DELETE) 核取方塊
- 更改後點擊
儲存 - 呼叫無權限的方法回傳 403 Forbidden
- 權限按環境獨立管理，因此可以在沙箱環境中允許廣泛存取，在正式環境中進行限制
邀請
管理與該協作金鑰關聯的協作者邀請。
傳送邀請
點擊 邀請協作者 按鈕開啟對話框。輸入協作者的電子郵件地址後傳送。
- 向協作者傳送邀請郵件
- 協作者登入後，儀表板頂部也會顯示邀請接受橫幅
- 邀請有效期 7 天 — 過期後需要重新傳送
按邀請狀態的操作
| 狀態 | 操作按鈕 |
|---|---|
| 待處理 | 取消邀請、重新傳送 |
| 已接受 | 撤銷訪問 |
| 已過期 | 重新傳送 |
協作者接受後可以做什麼
- 在儀表板上查看共享端點
- 查看已簽發的 API 金鑰（沙箱環境 / 正式環境）
- 在測試與整合指南頁面測試（Swagger 風格，curl/JS/Python 範例）
- 查看端點的日誌和統計
- 設定分配給自己的通知
協作者不能做的事：更改端點設定、管理其他協作者、直接部署到正式環境（只能請求）。
撤銷存取的注意事項
- 撤銷邀請會斷開協作者的儀表板存取權限
- 要使 API 金鑰本身失效，請使用啟用/停用切換或重新生成
- 要完全攔截存取，請同時執行「撤銷存取 + 停用金鑰（或重新生成）」
危險區域
- 刪除協作金鑰 — 完全移除該協作金鑰
- 所有環境的 API 金鑰、關聯邀請和權限設定均被刪除
- 使用該金鑰的所有 API 呼叫立即停止
- 該金鑰的歷史 API 呼叫記錄（日誌）保留，但不再接收新呼叫
常見問題
- 協作者未收到邀請郵件：請檢查垃圾郵件資料夾。仍未找到的話，在狀態為待處理時點擊
重新傳送 - 接受連結顯示已過期：7 天有效期。使用
重新傳送傳送新連結 - 想要暫時攔截特定協作者：在協作金鑰詳細頁面點擊 API 金鑰停用切換。呼叫立即被攔截，重新啟用後恢復
- 沙箱環境正常但正式環境被拒絕：權限按環境獨立管理。請檢查正式環境分頁是否勾選了 CRUD 權限
- 重新生成後協作者無法呼叫：舊金鑰立即失效——必須將新金鑰分享給協作者