رفتن به محتوای اصلی

توسعه‌دهندگان

روی مارکتینگ استودیو بسازید.

هر کاری که تیم شما در استودیو انجام می‌دهد، برای کد و عامل‌های هوش مصنوعی شما هم در دسترس است — با توکن‌های محدود، سقف‌های روشن و مشخصات باز.

REST API

نقاط پایانی JSON نسخه‌دار برای محتوا، انتشار، تولید، تحلیل، انتساب، سرنخ‌ها و انطباق.

سرور MCP

عامل هوش مصنوعی خودتان را متصل کنید تا پیش‌نویس بنویسد، پست زمان‌بندی کند، تصویر بسازد و اعداد شما را بخواند.

ردیابی و وب‌هوک

پیکسل شخص اول، ثبت تبدیل از سمت سرور و وب‌هوک‌های امضاشدهٔ سفارش ووکامرس و شاپیفای.

شروع سریع

سه گام تا نخستین درخواست.

  1. ۰۱

    توکن بسازید

    تنظیمات ← توکن‌های API. دسترسی‌های لازم را انتخاب کنید و بهتر است توکن را به یک برند محدود کنید.

  2. ۰۲

    آن را در سرآیند Bearer بفرستید

    هر درخواست سرآیند Authorization: Bearer <token> دارد. توکن‌های نامحدود به برند، سرآیند X-Workspace-Id را هم می‌فرستند.

  3. ۰۳

    API را فراخوانی کنید

    همهٔ پاسخ‌ها JSON است. فهرست‌ها صفحه‌بندی شده‌اند و کارهای طولانی شناسه‌ای برمی‌گردانند که می‌توانید وضعیتش را بپرسید.

curl https://api.studio.pro.plus/api/v1/content?status=review \
  -H "Authorization: Bearer $MS_TOKEN" \
  -H "Accept: application/json"

curl -X POST https://api.studio.pro.plus/api/v1/content \
  -H "Authorization: Bearer $MS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"type":"social_post","title":"Autumn launch","body":"New single-origin beans are here.","language":"en"}'

احراز هویت و دسترسی‌ها

توکن‌ها توکن دسترسی شخصی هستند و هر کدام دسترسی‌های مشخصی دارند. درخواست خارج از این دسترسی‌ها پاسخ ۴۰۳ با کد insufficient_scope می‌گیرد.

دسترسیامکان
content:readفهرست و خواندن محتوا، تقویم، کانال‌ها و صف انتشار.
content:writeساخت پیش‌نویس، ویرایش، یادداشت و ارسال برای بازبینی. شامل content:read.
publishزمان‌بندی یا انتشار پست در کانال‌های متصل (قواعد تأیید همچنان برقرار است).
generateتولید تصویر و رسانه، پرسش از دستیار بازاریابی و بررسی انطباق. از اعتبار حساب کسر می‌شود.
analytics:readشاخص‌های داشبورد، گزارش‌های مدیریتی و انتساب درآمد.
seo:readکلیدواژه‌های پایش‌شده، نمای کلی سئو و دیده‌شدن در پاسخ‌های هوش مصنوعی.
leads:readسرنخ‌های امتیازدار همراه با توضیح و مخاطبان.
leads:writeثبت تبدیل و ساخت مخاطب. شامل leads:read.

سقف درخواست و خطاها

هر توکن می‌تواند ۱۲۰ درخواست در دقیقه داشته باشد. هر پاسخ سرآیندهای X-RateLimit-Limit و X-RateLimit-Remaining دارد و پاسخ ۴۲۹ در Retry-After می‌گوید چقدر صبر کنید.

401

توکن ارسال نشده، منقضی یا باطل شده است.

403

دسترسی کافی نیست (insufficient_scope)، نقطهٔ پایانی عمومی نیست (not_public_api) یا توکن به برند دیگری محدود است (workspace_mismatch).

422

اعتبارسنجی ناموفق بود — فهرست errors همهٔ فیلدها را نشان می‌دهد.

424

کلید یک سرویس (مثلاً ارائه‌دهندهٔ هوش مصنوعی) برای حساب تنظیم نشده است.

429

درخواست‌ها بیش از حد است — پس از ثانیه‌های اعلام‌شده دوباره تلاش کنید.

نقاط پایانی

توضیح کامل همراه با همهٔ فیلدها در سند OpenAPI 3.1 آمده است.

محتوا

GET/contentcontent:read
POST/contentcontent:write
GET/content/{id}content:read
POST/content/{id}/submitcontent:write

انتشار

GET/social/channelscontent:read
POST/social/publishpublish

تولید

POST/generationsgenerate
GET/generations/{id}generate
POST/copilot/askgenerate

تحلیل و انتساب

GET/dashboardanalytics:read
GET/platform/attributionanalytics:read
POST/platform/conversionsleads:write

سئو

GET/seo/keywordsseo:read
GET/seo/visibilityseo:read

سرنخ‌ها

GET/platform/leadsleads:read
GET/platform/leads/{contact_id}leads:read

انطباق

POST/platform/compliance/checkgenerate

MCP

سرور MCP برای عامل‌های هوش مصنوعی شما

مارکتینگ استودیو با پروتکل Model Context Protocol روی Streamable HTTP کار می‌کند. هر عامل سازگار با MCP ابزارها را پیدا می‌کند و در محدودهٔ دسترسی توکن عمل می‌کند — پیش‌نویس‌ها تا تأیید یک فرد، پیش‌نویس می‌مانند.

نقطهٔ پایانی
POST https://api.studio.pro.plus/api/mcp
احراز هویت
توکن دسترسی شخصی در سرآیند Bearer (دسترسی‌ها تعیین می‌کنند کدام ابزارها نمایش داده شوند)
نسخه‌های پروتکل
2026-07-28 · 2025-11-25 · 2025-06-18 · 2025-03-26

پیکربندی کلاینت

{
  "mcpServers": {
    "marketing-studio": {
      "type": "http",
      "url": "https://api.studio.pro.plus/api/mcp",
      "headers": { "Authorization": "Bearer <your token>" }
    }
  }
}
POST /api/mcp
MCP-Protocol-Version: 2026-07-28
Mcp-Method: tools/call
Mcp-Name: create_content_draft

{"jsonrpc":"2.0","id":7,"method":"tools/call","params":{
  "name":"create_content_draft",
  "arguments":{"type":"article","title":"How to brew for a team of 40","submit_for_review":true},
  "_meta":{"io.modelcontextprotocol/protocolVersion":"2026-07-28"}}}

ابزارها

list_contentcontent:read

فهرست محتوای برند با وضعیت و امتیاز

get_contentcontent:read

خواندن کامل یک مورد

create_content_draftcontent:write

ساخت پیش‌نویس یا ارسال برای بازبینی

list_channelscontent:read

کانال‌های متصل و شناسهٔ آن‌ها

schedule_postpublish

زمان‌بندی پست یا سپردن انتخاب بهترین زمان به استودیو

generate_imagegenerate

ساخت تصویر هماهنگ با برند

get_generationgenerate

بررسی وضعیت تولید و دریافت تصویر

get_dashboard_metricsanalytics:read

درآمد، ترافیک و حلقه‌های رشد

get_attributionanalytics:read

درآمد به تفکیک کانال، کمپین و محتوا

ask_copilotgenerate

پرسش از تحلیلگر برند

list_keywordsseo:read

کلیدواژه‌های پایش‌شده و جایگاه‌ها

list_hot_leadsleads:read

سرنخ‌های امتیازدار همراه با نشانه‌ها

check_compliancegenerate

سنجش متن با بسته‌های ضوابط

ردیابی و انتساب

یک اسکریپت روی سایت شما بازدیدهای کمپین را با پارامترهای UTM و شناسه‌های کلیک در کوکی شخص اول ثبت می‌کند. با وب‌هوک سفارش‌ها، هر فروش به کانال‌ها، کمپین‌ها و محتوایی که آن را رقم زده‌اند نسبت داده می‌شود.

<script async src="https://api.studio.pro.plus/t.js" data-key="ms_your_site_key"></script>

شناسایی بازدیدکننده و ثبت تبدیل

mstudio("identify", { email: "sara@example.com", name: "Sara Ahmadi" });
mstudio("track", "lead", { email: "sara@example.com" });
mstudio("track", "purchase", { value: 49, currency: "USD", order_id: "1042" });

وب‌هوک‌های امضاشدهٔ فروشگاه

ووکامرس و شاپیفای هر سفارش را با HMAC-SHA256 امضا می‌کنند. نشانی و کلید را از «انتساب ← راه‌اندازی ردیابی» بردارید. ارسال دوباره بی‌خطر است: سفارش‌های تکراری حذف و مبلغ بازگشتی کسر می‌شود.

// Every order webhook is signed:
// X-WC-Webhook-Signature / X-Shopify-Hmac-Sha256 = base64(HMAC-SHA256(raw body, secret))
https://api.studio.pro.plus/api/v1/webhooks/platform/shop/woocommerce/<site key>
https://api.studio.pro.plus/api/v1/webhooks/platform/shop/shopify/<site key>

ثبت تبدیل از سمت سرور

curl -X POST https://api.studio.pro.plus/api/v1/platform/conversions \
  -H "Authorization: Bearer $MS_TOKEN" -H "Content-Type: application/json" \
  -d '{"type":"purchase","value":120,"currency":"USD","external_id":"order-1042","email":"sara@example.com"}'

توسعه‌دهندگان

هر وقت تیم شما آماده بود.

در یک دقیقه توکن بسازید — یا دربارهٔ یکپارچه‌سازی اختصاصی با ما گفت‌وگو کنید.