選單路徑: 儀表板 > APIs > 端點詳細(正式環境分頁)> 開啟控制台

正式控制台

概述

正式控制台是一個僅所有者可用的功能,用於直接從儀表板管理正式環境資料。無需任何外部 API 工具,直接在瀏覽器中建立、讀取、更新和刪除資料。

沙箱環境測試 vs. 正式控制台

沙箱環境測試 正式控制台
環境 沙箱環境(測試) 正式環境(正式)
存取權限 所有者 + 協作者 僅所有者
API 金鑰 手動輸入(tm_test_ 自動設定(預設正式環境金鑰)
資料影響 測試資料(30 天後刪除) 正式的正式環境資料
協作者 Webhook 可透過標頭測試 不觸發
所有者 Webhook 已設定則觸發 已設定則觸發
用途 部署前呼叫測試 直接正式環境資料管理

什麼時候有用?

  • 想要預先填充產品列表或公告,供合作夥伴透過 GET 取得
  • 需要直接修復或刪除錯誤輸入的正式環境記錄
  • 想要不使用外部工具快速 POST(建立) 簡單資料

如何進入

  • 端點詳細正式環境分頁 > 右側邊欄 > 開啟控制台 按鈕
  • 僅在正式環境部署完成且僅對所有者顯示

開始之前

開始之前

警告橫幅

正式控制台處理正式的正式環境資料,因此頂部始終顯示所有變更立即生效的警告。此外,透過正式控制台發出的請求不會觸發協作者 Webhook。如果設定了所有者 Webhook,則正常觸發。

正式環境 API 金鑰

所有者的預設正式環境 API 金鑰已自動設定。無需單獨輸入或認證金鑰。

控制台

正式控制台

沙箱環境測試的試一試結構相同,但在正式環境中執行

方法選擇

頂部有 POST / GET / PUT / DELETE 分頁。選擇要執行的操作。

  • POST(建立):在請求主體中輸入 JSON 並執行。建立新記錄
  • GET(讀取):輸入記錄 ID 並執行。查看記錄資料
  • PUT(更新):輸入記錄 ID + 修改後的 JSON 請求主體。這是完全替換
  • DELETE(刪除):輸入記錄 ID 並執行。記錄永久刪除

執行區域

  • 端點 URL:顯示實際正式環境 API 路徑。路徑根據方法自動變化
  • Record ID:GET/PUT/DELETE 時必要。輸入以 rec_ 開頭的 ID
  • 請求主體:POST/PUT 時傳送的 JSON
  • Execute 按鈕:對正式環境立即生效
  • 回應:顯示狀態碼和回應時間的結果

注意:正式控制台中的所有操作對正式資料立即生效。DELETE 無法復原——請謹慎執行。


常見問題

  • 看不到開啟控制台按鈕:僅在正式環境部署完成後顯示。請在端點詳細頁面檢查部署狀態
  • 我是協作者,無法存取控制台:正式控制台僅所有者可用。協作者必須使用分配的正式環境 API 金鑰在外部呼叫
  • PUT 只更新了部分欄位,其餘消失了:PUT 使用完全替換。需要保留的欄位和要更改的欄位都必須包含
  • 如何找到編輯/刪除的記錄 ID?:前往頂部選單的日誌頁面,選擇端點並瀏覽呼叫歷史。點擊任意項目查看記錄 ID(以 rec_ 開頭)