کلاس آنلاین،
متصل به سامانه شما

وب‌سایت، نرم‌افزار یا سامانه آموزشی خود را به کلاس آنلاین متصل کنید. API بیگ بلو باتن ایران از ساختار استاندارد BigBlueButton استفاده می‌کند؛ دریافت اطلاعات اتصال از حساب شما انجام می‌شود.

1. وارد سامانه شویدبا حساب خود وارد app.bigbluebutton.me شوید.
2. مدیریت جلسات ← تنظیماتدر این بخش، URL و Secret اختصاصی اتصال خود را بردارید.
3. اتصال را در سرور برنامه تنظیم کنیدURL را با همان مسیر نمایش‌داده‌شده استفاده کنید. Secret فقط در تنظیمات امن سمت سرور ذخیره شود.

درخواست را با نام دقیق متد و پارامترهای URL بسازید. سپس checksum را از اتصال نام متد، رشته پارامترها و Secret محاسبه کنید. Secret خودش نباید در URL ارسال شود.

checksum = HASH(methodName + exactQueryString + sharedSecret)

• رشته امضا و رشته ارسال‌شده باید از نظر ترتیب، فاصله‌ها و URL encoding یکسان باشند.
• پارامتر checksum را بعد از محاسبه به URL اضافه کنید؛ خودش جزو رشته امضا نیست.
• نمونه این صفحه از SHA-1 برای سازگاری با اتصال‌های متداول استفاده می‌کند. الگوریتم‌های SHA-256 / SHA-512 فقط در صورت پشتیبانی تنظیمات سرویس انتخاب شوند.
• در درخواست POST، محاسبه checksum بر اساس query string آدرس است. بدنه XML یا multipart را به فرمول اضافه نکنید.
• Secret را در JavaScript مرورگر، مخزن عمومی، ابزار آنلاین ساخت checksum یا فایل دانلودی قرار ندهید.

مقادیر BBB_API_URL و BBB_SHARED_SECRET را در محیط امن سرور برنامه تعریف کنید. URL در این نمونه باید آدرس کامل پوشه API باشد. کد زیر نقطه شروع اتصال است؛ ورود کاربر، مجوز دسترسی به دوره و تعیین نقش را در برنامه خود پیاده کنید.

<?php
// Run on your application server. Requires PHP cURL + SimpleXML.
$base = rtrim((string) getenv('BBB_API_URL'), '/') . '/';
$secret = (string) getenv('BBB_SHARED_SECRET');
if (!str_starts_with($base, 'https://') || $secret === '') {
    throw new RuntimeException('Configure API URL and secret first.');
}
function bbbUrl(string $method, array $params): string {
    global $base, $secret;
    $query = http_build_query($params, '', '&', PHP_QUERY_RFC3986);
    $checksum = hash('sha1', $method . $query . $secret);
    return $base . $method . '?' . $query
        . ($query === '' ? '' : '&') . 'checksum=' . $checksum;
}
function bbbRequest(string $method, array $params): SimpleXMLElement {
    $curl = curl_init(bbbUrl($method, $params));
    curl_setopt_array($curl, [
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_CONNECTTIMEOUT => 5,
        CURLOPT_TIMEOUT => 20,
        CURLOPT_FOLLOWLOCATION => false,
        CURLOPT_SSL_VERIFYPEER => true,
        CURLOPT_SSL_VERIFYHOST => 2,
    ]);
    $body = curl_exec($curl);
    $status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
    curl_close($curl);
    if ($body === false || $status !== 200) {
        throw new RuntimeException('API transport error');
    }
    libxml_use_internal_errors(true);
    $xml = simplexml_load_string($body, 'SimpleXMLElement', LIBXML_NONET);
    if ($xml === false || (string) $xml->returncode !== 'SUCCESS') {
        // Record a sanitized messageKey internally; never log the URL/secret.
        throw new RuntimeException('API operation failed');
    }
    return $xml;
}
// Obtain meetingID from your authorized server-side application data.
$meetingID = 'course-42-session-1';
$meeting = bbbRequest('create', [
    'name' => 'Online class',
    'meetingID' => $meetingID,
    'record' => 'true',
]);
// Authenticate the user and check course access before generating this URL.
// Only your server decides MODERATOR/VIEWER; do not trust a browser field.
$joinUrl = bbbUrl('join', [
    'meetingID' => $meetingID,
    'fullName' => 'Demo learner',
    'userID' => 'student-1001',
    'role' => 'VIEWER',
]);
// In a web controller, after authorization and before any output:
// header('Location: ' . $joinUrl, true, 303);
// exit;

برای ورود مدیر، فقط پس از احراز هویت و بررسی مجوز، مقدار role را روی MODERATOR بگذارید. لینک امضاشده ورود را مانند یک اطلاعات دسترسی حساس نگهداری کنید؛ آن را عمومی یا در گزارش‌های تحلیلی ثبت نکنید.

همه درخواست‌های زیر به امضای معتبر نیاز دارند. فهرست پارامترهای این صفحه روی کاربردهای اصلی متمرکز است؛ پارامترهای پیشرفته و تفاوت نسخه‌ها از مرجع هر متد در دسترس است.

موفق بودن HTTP به تنهایی کافی نیست؛ نتیجه عملیات را از returncode بخوانید. اغلب متدها پاسخ XML دارند؛ join با redirect و برخی متدهای جدید استثنا هستند. نمونه‌های زیر نمایشی‌اند.

<response>
  <returncode>SUCCESS</returncode>
  <running>true</running>
</response>

<response>
  <returncode>FAILED</returncode>
  <messageKey>checksumError</messageKey>
  <message>Request signature is invalid.</message>
</response>

در لاگ، نام متد، شناسه پیگیری داخلی و نتیجه پاک‌سازی‌شده را ثبت کنید؛ URL امضاشده، Secret و اطلاعات شخصی کاربران را ثبت نکنید.

برای هر جلسه برنامه‌ریزی‌شده، شناسه مشخص نگه دارید. پس از پایان، پردازش ضبط ممکن است زمان ببرد؛ با فاصله مناسب وضعیت را بررسی کنید و به کاربر «در حال پردازش» نمایش دهید. دسترسی به ضبط را در سطح حساب و دوره کنترل کنید.

ضبط، مدت نگهداری و ظرفیت مصرف تابع سرویس شماست. API مجوز عبور از محدودیت اشتراک را ایجاد نمی‌کند. برای مشاهده تعرفه‌ها به تعرفه خدمات بروید.

برای اتصال سامانه آموزشی یا وب‌سایت، افزونه سازگار با نسخه نصب‌شده خود را انتخاب کنید. اطلاعات URL و Secret را از حساب بیگ بلو باتن ایران بردارید.

1. از سایت مودل و دیتابیس آن پشتیبان بگیرید؛ نسخه مودل را بررسی کنید.
2. BigBlueButton از مودل ۴ در هسته قرار دارد. اگر فعالیت موجود است، افزونه قدیمی را دوباره روی آن نصب نکنید.
3. در مدیریت سایت، بخش افزونه‌ها و تنظیمات BigBlueButton را باز کنید؛ جای دقیق آن ممکن است با نسخه مودل فرق کند.
4. Server URL و Shared Secret حساب خود را وارد کنید. قالب URL مورد انتظار افزونه را بررسی کنید؛ بعضی اتصال‌ها مسیر /api را خودشان اضافه می‌کنند.
5. در یک دوره آزمایشی، فعالیت BigBlueButton بسازید و ورود با نقش مدرس و دانشجو را جدا تست کنید.
6. ضبط و دسترسی به بازپخش را با یک جلسه کوتاه آزمایش کنید.

برای نسخه‌هایی که نصب جدا لازم دارند، فقط بسته سازگار با همان نسخه را از منبع افزونه بگیرید. راهنمای رسمی مودل ↗

1. از فایل‌ها و دیتابیس وردپرس پشتیبان بگیرید و ابتدا روی محیط آزمایشی تست کنید.
2. نسخه PHP، وردپرس و سابقه به‌روزرسانی افزونه را با توضیحات کارت دانلود تطبیق دهید.
3. در «افزونه‌ها ← افزودن ← بارگذاری افزونه»، فایل ZIP مورد اعتماد را نصب کنید یا افزونه را از مخزن بیابید.
4. در تنظیمات افزونه، URL و Secret حساب خود را وارد و ذخیره کنید. این مقادیر نباید به سورس عمومی صفحه منتقل شوند.
5. اتاق آزمایشی بسازید؛ روش درج اتاق یا shortcode را از راهنمای همان افزونه بردارید.
6. مجوز مدیر و شرکت‌کننده، ورود مهمان و دسترسی به ضبط را جدا بررسی کنید.

• تعیین نقش و مجوز شرکت در جلسه فقط سمت سرور انجام شود.
• Secret خارج از پوشه عمومی و مخزن کد ذخیره شود.
• HTTPS و اعتبارسنجی گواهی TLS روشن بماند.
• برای ساخت، پایان و حذف جلسه یا ضبط، احراز هویت و محدودیت درخواست اعمال شود.
• درخواست‌های عمومی سایت خود را با CSRF و کنترل مجوز محافظت کنید.
• برای خطای شبکه timeout و backoff تعیین کنید.
• در صورت افشای Secret، از پشتیبانی برای تعویض آن کمک بگیرید.
• پیش از انتشار، سناریوهای ورود مدرس، ورود دانشجو، ضبط و پایان جلسه را تست کنید.

این راهنما برای اتصال به خدمات بیگ بلو باتن ایران نوشته شده است. فهرست کامل پارامترهای کم‌کاربرد در مرجع استاندارد در دسترس است. برای درخواست پشتیبانی، نام متد، زمان خطا و messageKey را ارسال کنید؛ Secret را ارسال نکنید.