ورود / ثبت‌نام
مرجع اتصال API

راهنمای اتصال؛ بر اساس قراردادهای موجود

این راهنما نقطهٔ شروع اتصال است. مسیرهای زیر از قرارداد فعلی foximoon-api بررسی شده‌اند؛ برای payload کامل و شرایط مجوز، مستندات همان محیط را بخوانید.

نمونه‌ها دادهٔ نمایشی دارند. ساخت یا تغییر منابع واقعی به حساب، tenant و مجوز معتبر نیاز دارد. کلید API را در مرورگر یا فرم عمومی وارد نکنید.

ساخت embed

POST /api/v1/player/embeds
نیازمند مجوز ساخت پخش؛ سمت سرور

از قرارداد معتبر ویدیو و مخاطب، مسیر نمایش ایجاد می‌شود. ساخت نشست مجاز با نمایش عمومی سند embed متفاوت است.

نمایش پلیر

GET /api/v1/player/embed/v2/{embedId}
سند HTML عمومی با شناسهٔ کوتاه‌عمر

API موجود سند پلیر را برمی‌گرداند. انقضا و سیاست دامنهٔ مجاز همچنان اعمال می‌شوند؛ پاسخ خصوصی و بدون cache است.

پاسخ سؤال داخل ویدیو

POST /api/v1/player/embed/v2/{embedId}/assessment-answers
وابسته به نشست embed و قرارداد سؤال

ثبت پاسخ در مسیر پلیر انجام می‌شود. نتیجه و شرط ادامه باید از قرارداد واقعی دریافت شود؛ تغییر ظاهر دکمه جای ثبت پاسخ را نمی‌گیرد.

ارزیابی هنرجو

GET /api/v1/learner/assessments/{assessmentId}
احراز هویت و دسترسی هنرجو

دریافت ارزیابی از ثبت تلاش و ارسال پاسخ جداست. نوع سؤال، مهلت و شیوهٔ تصحیح را از قرارداد همان ارزیابی بخوانید.

ورود به جلسه

POST /api/v1/learner/live-sessions/{roomId}/join
احراز هویت و مجوز جلسه

مجوز ورود با محیط واقعی جلسه کامل می‌شود. داشتن API ورود به معنی آماده‌بودن تمام رابط‌های میت در سایت شما نیست.

پلن‌های مجموعه

GET /api/v1/billing/plans
نیازمند قابلیت billing.plans.list و مجوز مالی مجموعه

فهرست پلن‌های فعال برای مخاطب مجاز است؛ یک API عمومی قیمت‌گذاری نیست. سایت نمونه قیمت‌های نمایشی را جدا نگه می‌دارد.

مدیریت Webhook

GET /admin/v1/webhooks/event-types
مسیر مدیریتی با مجوز مشخص؛ خارج از مرورگر عمومی

انواع رویداد قابل اشتراک از قرارداد فعلی بررسی می‌شوند. کلید مدیریتی یا مسیر کنترل اشتراک در صفحهٔ عمومی قرار نمی‌گیرد.

نمونهٔ جاسازی پلیر

EMBED_ID را با شناسهٔ معتبر و کوتاه‌عمر جایگزین کنید. دامنهٔ سایت باید در سیاست نمایش مجاز باشد. خطای ۴۰۴ می‌تواند ناشی از نامعتبر یا منقضی بودن نشست باشد.

<iframe
  src="https://api.foximoon.com/api/v1/player/embed/v2/EMBED_ID"
  title="پلیر آموزشی فاکسیمون"
  allow="fullscreen"
  referrerpolicy="no-referrer">
</iframe>
مشاهدهٔ مستندات API محیط فعلی

از نمونه تا پلیر واقعی

نمونهٔ زیر بدون ارسال داده کار می‌کند. برای استفاده از API موجود، شناسهٔ embed کوتاه‌عمر و معتبر را که در مسیر مجاز ساخته‌اید وارد کنید؛ کلید API وارد نکنید.

نمونهٔ تعاملی محلی

کدام عدد زوج است؟

نمونهٔ تعاملی برای آشنایی؛ پاسخ شما ذخیره یا ارسال نمی‌شود.

مجوز و جداسازی

حساب بدون دسترسی، دسترسی لغوشده و tenant دیگر را هم آزمایش کنید. شناسهٔ منبع جای مجوز را نمی‌گیرد.

خطا و بازیابی

انقضا، خطای شبکه و پاسخ نامعتبر باید پیام روشن داشته باشند. عملیات نوشتن را بدون توجه به قرارداد idempotency تکرار نکنید.

پذیرش نهایی

موفقیت نمونهٔ محلی، تأیید اتصال واقعی نیست. برای انتشار، مسیر کاربر مجاز و غیرمجاز را با دادهٔ آزمایشی در سرویس واقعی تکمیل کنید.

مسیر مناسب آموزش خود را انتخاب کنید

نیازهای مجموعه و شیوهٔ ارائهٔ آموزش را مشخص کنید؛ در فضای فاکسیمون یا سایت خودتان.

شروع همکاری