پرش به محتوا
بیاروم
توسعه‌دهندگان

در ۵ دقیقه به سامانه خودتان وصل شوید

REST API با نسخه‌گذاری، کلید API با دسترسی محدودشونده، Idempotency-Key و Webhook امضاشده.

دریافت کلید API
برنامه‌نویسی که روی لپ‌تاپ کد می‌نویسد
REST · Webhook · SDK برای Node و PHP

۱. ساخت کلاس

کلید API را از پنل → توسعه‌دهندگان بسازید.

curl -X POST https://YOUR-DOMAIN/api/v1/rooms \
  -H "Authorization: Bearer ocp_xxx_yyy" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 7d1c…" \
  -d '{"title":"Math 101","slug":"math-101","profile":"class"}'

۲. لینک ورود شخصی برای هر کاربر

curl -X POST https://YOUR-DOMAIN/api/v1/rooms/{id}/join-links \
  -H "Authorization: Bearer ocp_xxx_yyy" \
  -d '{"role":"participant","name":"Sara Ahmadi","externalUserId":"lms-42","maxUses":1}'
# → { "url": "https://YOUR-DOMAIN/j/…", "token": "…" }

۳. گزارش حضور و Webhook

GET /api/v1/rooms/{id}/sessions
GET /api/v1/sessions/{sessionId}/attendance?format=json|csv|xlsx

قرار دادن کلاس در سایت

<iframe src="https://YOUR-DOMAIN/school-x/math-101"
        allow="camera; microphone; display-capture; autoplay"
        style="width:100%;height:640px;border:0"></iframe>

مرجع کامل API

همه مسیرها با پارامترها، نمونه درخواست و پاسخ، و امکان ارسال درخواست واقعی با کلید خودتان؛ به‌همراه کتابخانه‌های Node.js و PHP.

مشاهده مرجع API