External Integration
API 對接教學
外部系統可透過 WEMS 投資新聞 API 讀取文章、行情、K 線與分析資料。除 /status 外,其餘端點需在 HTTP Header 放入 X-Api-Key。
Base URLhttps://news.sun-bd.com/api/public/v1
驗證 HeaderX-Api-Key
回應格式JSON envelope
版本v1
快速開始
/status 可不帶 key 用於健康檢查;正式資料端點需使用營運方提供的 API key。
curl -sS "https://news.sun-bd.com/api/public/v1/status"
curl -sS "https://news.sun-bd.com/api/public/v1/catalog" \
-H "X-Api-Key: YOUR_API_KEY"
標準回應格式
所有成功與錯誤回應都使用一致 envelope,方便合作系統進行錯誤處理、追蹤與重試。
{
"success": true,
"data": {},
"error": null,
"timestamp": "2026-05-30T12:00:00Z",
"traceId": null
}
端點清單
| Method | Path | 用途 | Key |
|---|---|---|---|
| GET | /status | 健康檢查與 API 狀態確認 | 否 |
| GET | /catalog | 取得可用端點與查詢參數說明 | 是 |
| GET | /articles | 查詢已發布文章,支援 page、page_size、category、keyword | 是 |
| GET | /articles/{id} | 取得單篇文章內容、摘要、標籤與發布資訊 | 是 |
| GET | /market/assets | 取得市場資產清單,可用 category 篩選 | 是 |
| GET | /market/candles | 取得 K 線資料,支援 asset_id、interval、days | 是 |
| GET | /analytics/overview | 取得文章、瀏覽、分享與推播總覽 | 是 |
範例
curl -sS "https://news.sun-bd.com/api/public/v1/articles?page=1&page_size=20&category=market" \
-H "X-Api-Key: YOUR_API_KEY"
curl -sS "https://news.sun-bd.com/api/public/v1/market/assets?category=crypto" \
-H "X-Api-Key: YOUR_API_KEY"
curl -sS "https://news.sun-bd.com/api/public/v1/market/candles?asset_id=BTC&interval=day&days=30" \
-H "X-Api-Key: YOUR_API_KEY"
const response = await fetch("https://news.sun-bd.com/api/public/v1/articles", {
headers: { "X-Api-Key": process.env.WEMS_NEWS_API_KEY }
})
const body = await response.json()
錯誤處理
401:缺少或錯誤的X-Api-Key。404:指定文章不存在或尚未發布。503:外部 API 未啟用或暫時不可用。
會員登入 API
會員登入、登出、刷新 token 與權限不屬於本專案 API,請使用集中會員 API 文件。