API Docs

快速開始

從判斷要交給誰處理,到完成第一支 REST API 資料呼叫。

先判斷要用哪一種

API Key

給工程師、網站、後台或內部系統呼叫 REST API。建立後把完整 key 交給可信任工程師,不要貼到公開文件、prompt 或前端程式碼。

Docs MCP

給 Codex、Claude Code、VS Code 或其他 AI 工具讀文件。公開免 token,只回 API 文件、OpenAPI、catalog 與 changelog。

API Key 串接步驟

  1. 登入後到「API 與 AI 串接中心」建立 API Key。
  2. 呼叫主分類清單取得可用分類。
  3. 呼叫子分類清單取得指定主分類底下的子分類。
  4. 帶入 `category`、`sub`、`start`、`end` 呼叫 market 或 sub-market API。

日期格式固定為 `YYYY-MM-DD`。

交給 AI Agent 時

讓 Agent 先讀 Docs MCP 或 Markdown/OpenAPI,再請它依 REST API 文件產生串接程式。Docs MCP 不需要建立憑證;API Key 應放在環境變數或後端安全設定。

{
  "mcpServers": {
    "ecpaydata-api-docs": {
      "type": "http",
      "url": "https://app.ecpaydata.com.tw/api/mcp"
    }
  }
}

程式範例

curl -s "https://app.ecpaydata.com.tw/api/public/meta/categories" \
  -H "x-api-key: YOUR_API_KEY"
<?php
$apiKey = getenv('ECD_DATA_API_KEY');
$url = 'https://app.ecpaydata.com.tw/api/public/trends/market?category=%E7%BE%8E%E5%A6%9D%E4%BF%9D%E9%A4%8A&start=2025-07-01&end=2025-12-26';

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['x-api-key: ' . $apiKey],
]);
$response = curl_exec($ch);
curl_close($ch);

echo $response;
import os
import requests

url = "https://app.ecpaydata.com.tw/api/public/trends/market?category=%E7%BE%8E%E5%A6%9D%E4%BF%9D%E9%A4%8A&start=2025-07-01&end=2025-12-26"
headers = {"x-api-key": os.environ["ECD_DATA_API_KEY"]}
response = requests.get(url, headers=headers, timeout=30)
response.raise_for_status()
print(response.json())