綠界大數據 ECPAYDATA API 文件
API 與 AI 串接中心

API Docs

應用範例

用業務場景理解 Public REST API 可以做哪些報表、產品與決策支援。

應用範例怎麼讀

這些範例用業務場景說明 REST API 可以支援哪些報表、產品與決策流程。詳細 request、response schema 與錯誤格式請回到 REST API 文件查閱。

所有 live data 呼叫都需要 API Key。交給 AI Agent 時，請把 API Key 放在環境變數或 secret store，只提供變數名稱與任務目標。

場景流程

市場概況儀表板

適合誰：經營者、營運主管、BI 工程師

REST API 文件

可以回答什麼問題

  • 整體交易金額、筆數與客單價最近如何變化？
  • 哪些主分類貢獻最大，哪些分類成長最快？
  • 付款方式結構是否有明顯變化？

產出形式

首頁型儀表板、週報摘要、經營會議簡報。

注意事項與費用

  • 適合先做總覽，不需要先指定分類。
  • 近 30 天自助用量不是正式帳單，正式收費依合約或帳單為準。

建議 API 呼叫順序

  1. 整體週度趨勢/api/public/trends/overview
  2. 主分類交易排行/api/public/overview/ranking
  3. 主分類成長率/api/public/overview/growth
  4. 整體付款方式/api/public/overview/payment

指定主分類市場分析

適合誰：品類經理、行銷企劃、資料產品工程師

REST API 文件

可以回答什麼問題

  • 指定主分類的交易趨勢是否上升或下滑？
  • 該主分類底下哪些子分類最重要？
  • 目前區間與前一區間的人維度與交易焦點有何差異？

產出形式

分類市場分析頁、品類檢討報告、行銷活動前的市場基準。

注意事項與費用

  • 先用 Meta API 取得合法分類，避免手動輸入錯字。
  • 查詢天數會影響 API 點數；長區間請先評估用量。

建議 API 呼叫順序

  1. 確認可用主分類/api/public/meta/categories
  2. 主分類週度趨勢/api/public/trends/market?category=美妝保養&start=2025-07-01&end=2025-12-26
  3. 子分類排行/api/public/market/sub-ranking?category=美妝保養&start=2025-07-01&end=2025-12-26
  4. 市場數據焦點/api/public/market/focus?category=美妝保養&start=2025-07-01&end=2025-12-26

子分類品項追蹤

適合誰：商品營運、品項負責人、內部分析工具開發者

REST API 文件

可以回答什麼問題

  • 指定子分類是否正在成長？
  • 交易金額、筆數、客單價是否同步變化？
  • 這個子分類的焦點指標是否和上一期不同？

產出形式

品項追蹤頁、商品線週報、子分類異常觀察清單。

注意事項與費用

  • 子分類查詢需搭配主分類，建議先從 Meta API 取得選單。
  • 目前 API 提供趨勢與焦點，不提供單一商品或個資級明細。

建議 API 呼叫順序

  1. 取得子分類清單/api/public/meta/sub-categories?category=美妝保養
  2. 子分類週度趨勢/api/public/trends/sub-market?category=美妝保養&sub=精華液&start=2025-07-01&end=2025-12-26
  3. 子分類數據焦點/api/public/sub-market/focus?category=美妝保養&sub=精華液&start=2025-07-01&end=2025-12-26

付款方式觀察

適合誰：支付策略、營運管理、風險與客服團隊

REST API 文件

可以回答什麼問題

  • 整體或指定主分類的付款方式占比如何？
  • 特定付款方式是否在某些分類中特別集中？
  • 活動或檔期前後，付款方式結構是否改變？

產出形式

付款方式監控、支付產品策略參考、營運與客服觀察摘要。

注意事項與費用

  • 付款方式 API 回傳占比與筆數，適合做結構觀察。
  • 若要解釋原因，需結合內部活動、通路或金流資料另外分析。

建議 API 呼叫順序

  1. 整體付款方式/api/public/overview/payment
  2. 主分類付款方式/api/public/market/payment?category=美妝保養&start=2025-07-01&end=2025-12-26

交給 AI Agent 產出報表

適合誰：想用 Codex、Claude Code 或其他 Agent 協助串接的使用者

REST API 文件

可以回答什麼問題

  • 如何產出 AI Agent 報表草稿？
  • 如何讓 Agent 先讀懂 API 文件？
  • 如何避免把 API Key 明碼貼進對話？
  • 如何讓 Agent 產出可重跑的報表腳本？

產出形式

可重跑的報表腳本、內部分析 notebook、週報自動化草稿。

注意事項與費用

  • API Key 只能放在環境變數、CI/CD secret 或 Agent secret store。
  • 交給 Agent 時只提供 `ECPAYDATA_API_KEY` 這類變數名稱與任務目標，不要貼完整 key。

建議 API 呼叫順序

  1. 讓 Agent 讀 Docs MCP/api/mcp
  2. 讓 Agent 查 REST 文件/developers/rest-api
  3. 先驗證分類連線/api/public/meta/categories
  4. 再產出指定場景 API 呼叫/api/public/trends/market?category=美妝保養&start=2025-07-01&end=2025-12-26

最小 curl skeleton

先用主分類清單驗證 API Key 與連線，再依場景接續呼叫其他 endpoint。

curl -s "https://app.ecpaydata.com.tw/api/public/meta/categories" \
  -H "x-api-key: YOUR_API_KEY"