مستندات BottelX

به مستندات رسمی BottelX خوش آمدید. BottelX یک پلتفرم SaaS برای ساخت، مدیریت و درآمدزایی از ربات‌های تلگرام است که API قدرتمند، Webhook و سیستم تبلیغات یکپارچه ارائه می‌دهد.

در این مستندات با موارد زیر آشنا می‌شوید:

دریافت و مدیریت API Key
ارسال درخواست‌های امن به API
دریافت رویدادها از طریق Webhook
مدیریت خطاها و محدودیت‌ها

برای شروع، ابتدا یک حساب کاربری ایجاد کرده و API Key خود را از داشبورد دریافت کنید.

احراز هویت

تمام درخواست‌های API BottelX نیازمند احراز هویت با استفاده از API Key معتبر هستند. این کلید به هر حساب کاربری اختصاص داده می‌شود و باید به‌صورت امن نگهداری شود.

API Key باید در Header تمام درخواست‌ها به شکل زیر ارسال شود:

Authorization: Bearer YOUR_API_KEY

در صورت افشای API Key، می‌توانید آن را از داشبورد لغو یا مجدداً ایجاد کنید.

API Overview

BottelX API بر پایه REST طراحی شده و تمام پاسخ‌ها به‌صورت JSON بازگردانده می‌شوند. هر Endpoint وظیفه مشخصی دارد و قابل استفاده در پروژه‌های کوچک تا سیستم‌های بزرگ است.

Base URL: https://api.bottelx.com/v1
فرمت پاسخ‌ها: JSON
Methodها: GET, POST, PUT, DELETE
احراز هویت: API Key

تمام Endpointها نسخه‌بندی شده‌اند تا از سازگاری آینده اطمینان حاصل شود.

Webhook

Webhookها برای دریافت رویدادهای بلادرنگ از BottelX استفاده می‌شوند. به‌محض وقوع یک رویداد، یک درخواست HTTP POST به URL مشخص‌شده ارسال می‌شود.

رویدادهای متداول Webhook:

دریافت پیام جدید
تغییر وضعیت پرداخت
رویدادهای تبلیغاتی

در صورت عدم پاسخ مناسب، Webhook ممکن است مجدداً ارسال شود.

مدیریت خطا

در صورت بروز خطا، API BottelX پاسخ JSON شامل کد وضعیت و پیام خطا بازمی‌گرداند تا پردازش سمت کلاینت ساده باشد.

{
  "error": "Unauthorized",
  "code": 401
}

پیشنهاد می‌شود تمام پاسخ‌ها را از نظر status code بررسی کنید.

محدودیت‌ها

برای حفظ پایداری سیستم، محدودیت منطقی روی تعداد درخواست‌های API اعمال می‌شود. این محدودیت بر اساس پلن کاربر تنظیم شده و برای پروژه‌های بزرگ قابل افزایش است.

در صورت رسیدن به محدودیت، پاسخ مناسب از سمت API ارسال خواهد شد.