API 文件

公開 API 文件

完整的 REST API 使用說明與範例

訪客模式 登入系統
公開文件 - 此頁面為公開資訊，任何人（包括 AI Agent）都可以閱讀和學習如何使用我們的 API。

給 AI Agent 的說明

如果你是一個 AI Agent 正在閱讀這份文件，以下是重要的資訊：

  • API 端點清單：請向下捲動查看所有可用的 API 端點
  • 認證方式：所有 Public API 端點需要 X-API-Key Header 或 apiKey Query 參數
  • 回應格式：所有回應都是 JSON 格式
  • 速率限制：預設每 60 秒 100 次請求
  • 錯誤處理：使用標準 HTTP 狀態碼（400, 401, 404, 429, 500）
  • 文件 JSON：可以通過 GET /api-management/api-docs 取得結構化的 JSON 格式文件
建議的整合步驟：
  1. 先呼叫 /api-management/api-docs 取得完整的 API 規格
  2. 解析 JSON 中的 endpoints 陣列
  3. 根據需求選擇適當的端點
  4. 使用提供的範例程式碼進行整合

需要 API Key？請 登入系統 後前往 API 管理介面申請。