快速開始
1. 取得 API Key
請向 WEMS Marketing 管理員申請 API Key。Key 會對應到特定租戶資料範圍，不應放進公開網頁、前端 JavaScript、Git 或文件截圖。
2. 使用同一個正式網址
API、教學文件、功能介紹頁與 Web 系統都在 marketing.sun-bd.com，不需要記多個網域。
確認服務狀態
curl -sS "https://marketing.sun-bd.com/api/public/v1/status" \
-H "Accept: application/json"查詢租戶行銷摘要
curl -sS "https://marketing.sun-bd.com/api/public/v1/summary" \
-H "Accept: application/json" \
-H "X-Api-Key: YOUR_API_KEY"API 清單
| 用途 | Method / URL | 說明 |
|---|---|---|
| 服務狀態 | GET /status |
不需 API Key，供監控與串接前檢查。 |
| API 目錄 | GET /catalog |
不需 API Key，回傳可用資源與端點。 |
| 行銷摘要 | GET /summary |
回傳 SEO、社群、廣告等資料筆數摘要。 |
| SEO 健檢 | GET /seo/audits |
分頁查詢最近的網站健檢紀錄。 |
| 關鍵字 | GET /seo/keywords |
分頁查詢已管理的關鍵字與指標。 |
| SERP 排名 | GET /seo/serp-rankings |
查詢關鍵字排名、搜尋引擎、裝置與網址。 |
| 社群貼文 | GET /social/posts |
查詢貼文草稿、排程、發布與失敗狀態。 |
| 社群互動 | GET /social/engagements |
查詢按讚、留言、分享、觸及與點擊等指標。 |
| 廣告活動 | GET /ads/campaigns |
查詢活動名稱、預算、期間與狀態。 |
| 廣告成效 | GET /ads/performance |
查詢曝光、點擊、轉換、花費、收入與 ROAS。 |
所有受保護端點皆支援 page 與 page_size，page_size 最大為 100。
常用範例
查詢 SEO 健檢
curl -sS "https://marketing.sun-bd.com/api/public/v1/seo/audits?page=1&page_size=20" \
-H "Accept: application/json" \
-H "X-Api-Key: YOUR_API_KEY"查詢社群貼文
curl -sS "https://marketing.sun-bd.com/api/public/v1/social/posts?page=1&page_size=20" \
-H "Accept: application/json" \
-H "X-Api-Key: YOUR_API_KEY"查詢廣告成效
curl -sS "https://marketing.sun-bd.com/api/public/v1/ads/performance?page=1&page_size=20" \
-H "Accept: application/json" \
-H "X-Api-Key: YOUR_API_KEY"回應格式
{
"success": true,
"data": {
"items": [],
"total": 0,
"page": 1,
"page_size": 20,
"total_pages": 0
},
"error": null,
"traceId": "generated-trace-id"
}安全提醒：API Key 只應由伺服器端系統使用。不要把 Key 寫入公開 HTML、前端程式、App 原始碼或文件。