WEMS Marketing API Integration Guide

Quick Start

1. Request an API key

Ask a WEMS Marketing administrator for an API key. Each key maps to a specific tenant data scope. Do not store keys in public websites, frontend JavaScript, Git repositories, or screenshots.

2. Use the same official domain

The feature pages, API guide, external API, and web app are all under marketing.sun-bd.com. You do not need to manage several product domains.

Check service status

curl -sS "https://marketing.sun-bd.com/api/public/v1/status" \
  -H "Accept: application/json"

Read tenant marketing summary

curl -sS "https://marketing.sun-bd.com/api/public/v1/summary" \
  -H "Accept: application/json" \
  -H "X-Api-Key: YOUR_API_KEY"

Endpoint List

Resource	Endpoint	Purpose	Auth
Status	`GET /status`	Check service status and discover documentation links.	No API key required
Catalog	`GET /catalog`	List available public API resources.	No API key required
Summary	`GET /summary`	Return marketing record counts for SEO, social, and ads.	`X-Api-Key`
SEO	`GET /seo/audits` `GET /seo/keywords` `GET /seo/serp-rankings`	Read SEO audits, keywords, and SERP ranking records.	`X-Api-Key`
Social	`GET /social/posts` `GET /social/engagements`	Read social posts and engagement data.	`X-Api-Key`
Ads	`GET /ads/campaigns` `GET /ads/performance`	Read advertising campaigns and performance records.	`X-Api-Key`

Common Examples

Read SEO audits

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"

Read social posts

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"

Read ad performance

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"

Response Format

{
  "success": true,
  "data": {
    "items": [],
    "total": 0,
    "page": 1,
    "page_size": 20
  }
}

Protected endpoints return 401 when the API key is missing or invalid. If tenant data consumers are not configured server-side, protected endpoints return 503.