REST API و توکن‌ها

علاوه بر سازنده بصری، GetMyBot به‌صورت برنامه‌نویسی نیز در دسترس است: داده‌های بات را می‌توان از طریق REST API مدیریت کرد. دو نوع توکن وجود دارد — برای دسترسی به بات خاص و شخصی (برای اتوماسیون و یکپارچه‌سازی‌های سطح حساب).

توکن‌های API بات

در تنظیمات → توکن‌های API ایجاد می‌شوند. هر توکن به بات متصل است و اجازه دسترسی به اندپوینت‌های REST آن را می‌دهد (واکنش‌ها، کاربران، مجموعه‌ها، آمار و غیره). توکن فقط یک بار در زمان ایجاد نمایش داده می‌شود — آن را در محل امنی ذخیره کنید؛ فهرست، نام، ماسک و تاریخ ایجاد را نشان می‌دهد. توکن‌های اضافی را حذف کنید.

توکن‌های دسترسی شخصی (PAT)

توکن‌های دسترسی شخصی (PAT، با پیشوند mbp_) در سطح حساب کار می‌کنند و برای اتوماسیون و یکپارچه‌سازی‌ها استفاده می‌شوند. در پنل شخصی ایجاد شده؛ از طریق هدر Authorization: Bearer mbp_… ارسال می‌شوند. هر توکن دارای حوزه‌های دسترسی (scopes) — مجموعه‌ای از مجوزها به فرم resource:action (مثلاً reactions:read، bots:write) — است، و * دسترسی کامل را می‌دهد. مدت اعتبار محدود است و خود توکن‌ها به‌صورت هش‌شده ذخیره می‌شوند. این روشی مناسب برای دادن دسترسی محدود به اسکریپت بدون افشای رمز عبور است.

آنچه از طریق API در دسترس است

از طریق API همان موجودیت‌هایی که در رابط کاربری وجود دارند در دسترس هستند: بات‌ها و تنظیمات آن‌ها، واکنش‌ها (شامل ورودی/خروجی)، مشترکان و برچسب‌ها، مجموعه‌ها و رکوردها، آمار و گزارش درخواست‌ها، همه‌رسانی‌ها. این امکان می‌دهد پنل‌های سفارشی، همگام‌سازی و اتوماسیون روی GetMyBot بسازید.

کانال‌ها و WhatsApp

GetMyBot چندکاناله است (Telegram + WhatsApp + VK)، و کانال‌های بات نیز از طریق REST مدیریت می‌شوند. کانال‌ها و قالب‌های WhatsApp با scopeهای مشترک bots:read / bots:write کنترل می‌شوند — scope جداگانه‌ای برای کانال وجود ندارد.

  • GET /api/channels/capabilities — ماتریس قابلیت‌های کانال‌ها (نقطهٔ نشست، به scope PAT نیاز ندارد).
  • GET /api/bots/{botID}/channels (bots:read) — فهرست کانال‌های بات.
  • POST /api/bots/{botID}/channels (bots:write) — اتصال کانال WhatsApp یا VK.
  • DELETE /api/bots/{botID}/channels/{channelID} (bots:write) — قطع اتصال کانال.
  • GET /api/bots/{botID}/channels/{channelID}/templates (bots:read) — کاتالوگ قالب‌های WhatsApp کانال.
  • POST /api/bots/{botID}/channels/{channelID}/templates (bots:write) — ایجاد قالب و ارسال آن به Meta برای بازبینی.
  • POST /api/bots/{botID}/channels/{channelID}/templates/sync (bots:write) — همگام‌سازی مجدد کاتالوگ از Meta.
  • PUT /api/bots/{botID}/channels/{channelID}/templates/{templateID} (bots:write) — ویرایش قالب.
  • DELETE /api/bots/{botID}/channels/{channelID}/templates/{templateID} (bots:write) — حذف قالب.
  • POST /api/bots/{botID}/channels/{channelID}/templates/media (bots:write) — بارگذاری نمونهٔ رسانهٔ سرصفحه (تصویر/ویدیو/سند).

مخطط‌های درخواست و پاسخ، پارامترها و مثال‌ها در مرجع API است.

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

پلتفرم دارای اپلیکیشن موبایل با احراز هویت اختصاصی (توکن‌های access و refresh) و داشبورد یکپارچه بات‌ها است — از همان بک‌اند استفاده می‌کند.

مرجع API

مرجع تعاملی کامل API عمومی در صفحه مرجع API در دسترس است: تمام اندپوینت‌های قابل دسترسی از طریق PAT، پارامترها، طرح‌های درخواست و پاسخ، scopes موردنیاز و نمونه‌های آماده (curl، JavaScript، Python) فهرست شده‌اند. مستقیماً از صفحه می‌توانید درخواست آزمایشی با توکن خود ارسال کنید.

امنیت

  • توکن‌ها یک بار نمایش داده می‌شوند؛ آن‌ها را مانند اسرار نگهداری کنید.
  • اسرار بات‌ها و اطلاعات اعتباری رمزگذاری‌شده ذخیره می‌شوند.
  • تغییرات در گزارش ممیزی ثبت می‌شوند.

بیشتر بخوانید