مرجع API

BotLaunch API

با API REST BotLaunch یکپارچه‌سازی‌های قدرتمند بسازید. دسترسی کامل به ربات‌ها، کاربران، پیام‌ها و موارد دیگر با مستندات و نمونه‌های جامع.

آدرس پایه

https://api.botlaunch.io

نسخه

v1.0

احراز هویت

JWT Bearer

شروع سریع

در عرض چند دقیقه با API BotLaunch شروع به کار کنید.

۱. نصب یا آزمایش

# Install the BotLaunch SDK
npm install @botlaunch/sdk

# Or use the REST API directly
curl -X GET "https://api.botlaunch.io/api/health" \
  -H "Content-Type: application/json"

bash

۲. احراز هویت

// Authenticate and get an access token
const response = await fetch("https://api.botlaunch.io/api/auth/login", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    email: "your@email.com",
    password: "your-password"
  })
});

const { data } = await response.json();
console.log(data.accessToken);

javascript

۳. فراخوانی API

// Make authenticated API calls
const bots = await fetch("https://api.botlaunch.io/api/bots", {
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "x-organization-id": "YOUR_ORG_ID"
  }
});

const { data } = await bots.json();
console.log(data); // Array of your bots

javascript

نقاط پایانی API

نقاط پایانی API موجود را بر اساس نوع منبع بررسی کنید.

احراز هویت

درباره توکن‌های JWT، کلیدهای API و روش‌های احراز هویت امن بیاموزید.

مشاهده مستندات

ربات‌ها

ربات‌های تلگرام خود را به صورت برنامه‌نویسی ایجاد، پیکربندی و مدیریت کنید.

مشاهده مستندات

کاربران

کاربران، مجوزها و اعضای سازمان را مدیریت کنید.

مشاهده مستندات

پیام‌ها

پیام ارسال کنید، callback‌ها را مدیریت کنید و مکالمات را اداره کنید.

مشاهده مستندات

وب‌هوک‌ها

وب‌هوک‌ها را برای دریافت رویدادها و اعلان‌های بلادرنگ پیکربندی کنید.

مشاهده مستندات

فرمت پاسخ

تمام پاسخ‌های API از یک ساختار JSON یکسان پیروی می‌کنند.

پاسخ موفق

{
  "data": {
    "id": "bot_123",
    "name": "My Bot",
    "status": "active"
  },
  "message": "Bot retrieved successfully"
}

json

پاسخ خطا

{
  "error": "Unauthorized",
  "statusCode": 401,
  "message": "Invalid or expired token"
}

json

پاسخ صفحه‌بندی شده

{
  "data": [
    { "id": "bot_1", "name": "Bot 1" },
    { "id": "bot_2", "name": "Bot 2" }
  ],
  "total": 25,
  "page": 1,
  "limit": 10
}

json

محدودیت نرخ

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

پلن	درخواست/دقیقه	درخواست/روز	محدودیت لحظه‌ای
Free	60	1,000	10
Starter	300	10,000	50
Professional	1,000	50,000	100
Business	5,000	Unlimited	500
Enterprise	Custom	Unlimited	Custom

هدرهای محدودیت نرخ

Check X-RateLimit-Remaining and X-RateLimit-Reset headers in API responses to monitor your usage.

بازگشت به مستندات احراز هویت