建立新端點

概述

端點是一個可以接收外部系統 JSON 資料的 URL。3Min API 儲存傳入的資料、記錄日誌，並可選擇透過 Webhook 轉發。

在此頁面，您只需輸入名稱、描述和可選的必填欄位即可建立端點。必填欄位可以稍後在詳細頁面修改，因此可以先略過。

建立後

• 自動在沙箱環境中建立
• 立即簽發沙箱環境 API 金鑰（tm_test_ 前綴）
• 同時簽發正式環境 API 金鑰（tm_live_），但在部署前正式環境呼叫將被拒絕且不記錄日誌
• 自動產生公開的整合指南頁面連結（Swagger 風格測試 + 程式碼範例）

如何進入

• 儀表板右上角的 新建端點 按鈕
• 左側選單 APIs → 列表頁右上角的 建立新 API 按鈕

---

基本資訊

API 名稱

必填欄位。

• 用於區分端點的使用者可見名稱
• 實際 API 路徑（Slug）自動產生，因此請選擇能反映資料性質的名稱
  • 推薦範例：contact-form、order-notification、wine-shop-sale
  • 避免使用：test、api1、my endpoint
• 限制條件：
  • 不能為空
  • 同一帳戶內名稱不能重複
  • 有最大長度限制（超出時顯示錯誤訊息）

描述

可選欄位。

• 端點用途的自由文字描述
• 記錄該端點何時被呼叫、接收什麼樣的資料，方便協作者和未來的自己查閱
• 範例：「結帳完成時觸發的訂單確認通知」
• 之後可在詳細頁面內聯編輯

必填欄位

可選。可以隨時在詳細頁面新增。

預先定義 API 呼叫中必須包含的 JSON 欄位。如果定義的欄位在請求中缺失，呼叫將被拒絕。

每個項目的輸入欄位

• 欄位名：欄位鍵（例如 order_id、customer_email）
• 資料類型：從 String、Number、Boolean、Object、Array 中選擇
• 可搜尋：勾選後可在日誌頁面用該欄位作為搜尋關鍵字
• 欄位描述（可選）：與協作者分享的描述

限制條件

• 可搜尋僅適用於 String 類型欄位
• 可搜尋每個端點最多限 2 個欄位
• 欄位名必須以字母或底線開頭，只能包含字母、數字和底線
• 不允許重複的欄位名

驗證方式

僅檢查 JSON 中是否存在該鍵——不驗證值的內容或格式。

現在可以略過

如果未定義必填欄位，端點將接受任何 JSON Payload。先建立端點，在沙箱環境中測試，確定需要哪些欄位後，再在端點詳細頁面新增。

此頁面上沒有的功能

• Webhook 設定 — 建立後在端點詳細頁面設定
• 通知設定 — 同樣在詳細頁面
• 協作金鑰管理 / 邀請 — 在詳細頁面的協作金鑰中管理
• 正式環境部署 — 使用詳細頁面的 部署到正式環境 按鈕

建立後

點擊 建立 API 後自動跳轉到端點詳細頁面。從那裡繼續：

1. 在概覽卡片上查看實際端點 URL
2. 使用預設 API 金鑰測試沙箱環境呼叫
3. 根據需要設定 Webhook / 通知 / 協作金鑰
4. 準備好上線後，使用 部署到正式環境 進行部署

---

常見問題

• 之後可以改名嗎？ — 可以，隨時在詳細頁面概覽中編輯名稱和描述
• 需要多個端點嗎？ — 大多數情況下不需要。3Min API 使用文件式儲存，您可以將巢狀 JSON 作為一個 Payload 傳送到單個端點。只有當事件本質不同時（例如訂單 vs. 諮詢）才需要拆分端點
• 需要定義嚴格的必填欄位嗎？ — 先不定義，與協作者一起測試，然後只新增確實必須始終存在的欄位