3Min API

快速入門

只需3分鐘。從註冊到第一次 API 測試。

1. 註冊

使用 Google 快速註冊。每月免費獲得1,000次 API 請求。

2. 建立端點

1
儀表板 → API → 新建端點按鈕
2
輸入 API 名稱
  • 描述為可選項
3
可選設定
  • 必填欄位
    • 將特定欄位標記為必填。缺少必填欄位的請求將被拒絕。
    • 字串欄位可設為可搜尋，用於日誌篩選。
  • Webhook
    • 將資料轉發到 Slack 或 Discord 等外部服務。
    • 與協作者 Webhook 獨立 — 這是用於您自己的整合。
4
點擊建立 API
  • 端點 URL 和 CRUD 方法（POST/GET/PUT/DELETE）即時生成
  • 預設 API 金鑰自動發放（沙箱金鑰立即可用，正式金鑰在部署後可用）
  • 同時建立內置測試頁面 — 無需額外工具

3. 測試：第一次 API 調用和日誌驗證

建立端點後立即測試，並在日誌中驗證接收情況。

儀表板 → API → 端點詳情 → 立即測試按鈕
  • 在沙箱環境中測試實際 API 調用
儀表板 → 日誌
  • 驗證資料是否正確儲存
  • 日誌可能需要最多3秒才能顯示

4. 建立協作金鑰 & 透過郵件邀請協作者

所有者測試完成後，建立協作金鑰並透過郵件邀請協作者。

儀表板 → API → 端點詳情 → 協作金鑰 → 檢視全部
  • 點擊"新增"建立協作金鑰
  • 開啟協作金鑰詳情頁傳送郵件邀請
  • 受邀協作者可以註冊，在自己的儀表板中檢視 API 金鑰、日誌和統計資料

5. 整合測試

驗證協作者能否在沙箱環境中正確調用 API。

  • 協作者在端點詳情頁檢視自己的沙箱 API 金鑰
  • 協作者在沙箱環境中測試 API
  • 檢視儀表板 → 日誌確認請求資料是否正確接收

6. 部署到正式環境

測試完成後，部署到正式環境。所有者可以直接部署，或批準協作者的部署請求。

儀表板 → API → 端點詳情 → 部署到正式環境按鈕
  • 協作者透過端點詳情頁的"請求部署"按鈕請求部署
  • 所有者可以直接部署或審核批準協作者的請求
  • 部署完成後，協作者會自動收到通知並可獲取正式環境 API 金鑰