WEMS Marketing API 对接教学

快速开始

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 清单

资源	Endpoint	用途	认证
状态	`GET /status`	确认服务状态，并取得文件链接。	不需要 API Key
目录	`GET /catalog`	列出可用的公开 API 资源。	不需要 API Key
摘要	`GET /summary`	返回 SEO、社群与广告资料数量摘要。	`X-Api-Key`
SEO	`GET /seo/audits` `GET /seo/keywords` `GET /seo/serp-rankings`	读取 SEO 检查、关键词与 SERP 排名记录。	`X-Api-Key`
社群	`GET /social/posts` `GET /social/engagements`	读取社群贴文与互动资料。	`X-Api-Key`
广告	`GET /ads/campaigns` `GET /ads/performance`	读取广告活动与广告成效记录。	`X-Api-Key`

常用范例

查询 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
  }
}

受保护端点缺少或使用错误 API Key 时会返回 401。若服务器端尚未配置资料消费者，受保护端点会返回 503。