這個頁面做什麼
建立給公司官網或其他服務使用的唯讀金鑰,讓它們透過內容 API 讀取「官網內容管理」裡的資料,例如團隊成員、文章與案例。金鑰只能讀取,不能新增、編輯或封存,也不會開放報價、請款等商務資料或尚未儲存的編輯草稿。
這個頁面在「設定 › 整合與開發」,只有擁有者與管理員可以開啟。內容 API 與 Webhook 屬於高級方案;目前方案不含時,頁面會提示升級,「建立金鑰」無法使用。降級後已建立的金鑰會保留,但暫時無法讀取資料,升級後即恢復。串接方式、資料欄位與範例在同一區的「API 文件」。
建立金鑰
按「建立金鑰」,填寫:
名稱:方便辨識這把金鑰給誰使用,例如「官網讀取服務」。
授權資料類型:只授權勾選的內容類型,至少選一種。公司之後停用某個內容類型時,金鑰也讀不到那個類型的資料。
到期日:預設為 90 天後,最早可選今天;到期日當天結束後就讀不到資料。
建立後會顯示一次性密鑰,請立刻複製並保存在網站伺服器的密鑰設定,不要放在瀏覽器看得到的程式碼裡。關閉視窗前會再確認一次;關閉後無法再查看,遺失時只能撤銷後重新建立。
每家公司最多 10 把有效的金鑰(已撤銷或已到期的不計入);達到上限時請先撤銷不再使用的金鑰。每把金鑰每分鐘最多呼叫 600 次,超過時會暫時被拒絕,網站請快取回應,不要在每次有人瀏覽時都呼叫。
狀態與到期提醒
狀態 | 說明 |
|---|---|
有效 | 可以讀取授權的資料。 |
N 天後到期 | 剩 14 天內到期時改為提醒,例如「3 天後到期」「明天到期」。 |
今天到期 | 今天結束後就讀不到資料。 |
已到期 | 已無法讀取資料,請建立新金鑰並更新網站設定。 |
已撤銷 | 已手動停用,無法讀取資料。 |
金鑰沒有延長期限的操作:快到期時請先建立新金鑰、更新網站設定,確認網站正常後再撤銷舊金鑰。
撤銷金鑰
在列表按「撤銷」,或打開金鑰詳情,從「⋯」選「撤銷金鑰」,再確認「撤銷金鑰」後,這把金鑰立即失效,使用它的網站或程式就讀不到資料。詳情會更新為已撤銷,無法重複撤銷。撤銷無法復原,需要時請建立新金鑰。
建立時連線中斷
按「建立金鑰」後連線中斷,可能已經建立但沒收到密鑰。這時再按一次「建立金鑰」就能確認:若前一次已建立,會說明這把金鑰已在前一次建立、密鑰無法再顯示,請在列表撤銷它後重新建立;若前一次沒有建立,會正常建立並顯示密鑰。不會因為重按而多建立一把。
目前限制
金鑰只有唯讀權限,無法透過 API 新增或修改內容。
密鑰只在建立時顯示一次,好辦也無法替你查回。
到期日建立後不能修改。