API عمومی رویدادها — مستندات RIQX

اصول

بی‌کلید و فقط‌خواندنی. همان داده‌ای برمی‌گردد که روی صفحه‌ی عمومی رویدادها دیده می‌شود. هیچ اطلاعات شخصی — فهرست ثبت‌نام‌کنندگان، شماره یا رایانامه — از این راه بیرون نمی‌آید.
از مرورگر هم خواندنی است. سرایند Access-Control-Allow-Origin: * فرستاده می‌شود.
تا یک دقیقه کش می‌شود. تغییر یک رویداد حداکثر پس از یک دقیقه در پاسخ دیده می‌شود.
نسخه در نشانی است (/api/v1/). اگر شکل پاسخ روزی عوض شود، نسخه‌ی تازه کنار این یکی می‌آید.

فهرست رویدادها

GET https://v.riqx.one/api/v1/events/

رویدادهای پیش‌رو و در حال برگزاری، نزدیک‌ترین اول. هر صفحه حداکثر 20 رویداد.

پارامتر	معنا
`page`	شماره‌ی صفحه، از 1
`category`	شناسه‌ی دسته — فقط رویدادهای همان دسته
`organizer`	نام کاربری برگزارکننده — فقط رویدادهای او؛ برای سایتی که فقط رویدادهای خودش را نشان می‌دهد

{
  "count": 42,
  "page": 1,
  "pages": 3,
  "next": 2,
  "results": [ { …یک رویداد… } ]
}

یک رویداد

GET https://v.riqx.one/api/v1/events/نشانی-رویداد/

فیلد	معنا
`slug`، `title`	شناسه‌ی نشانی و عنوان
`url`	صفحه‌ی رویداد در RIQX — ثبت‌نام همان‌جاست
`calendar_url`	فایل تقویم رویداد (پایین‌تر)
`category`، `category_slug`	دسته
`instructor`، `organizer`	نام مدرس و برگزارکننده
`status`	`approved` پیش‌رو · `live` در حال برگزاری
`platform`	`class` (RIQX Class — کلاس و کارگاه) یا `stage` (RIQX Stage — همایش و کنفرانس)
`starts_at`، `ends_at`	زمان، به قالب ISO 8601 با منطقه‌ی زمانی
`starts_at_jalali`	همان زمان به تقویم جلالی، آماده‌ی نمایش
`duration_minutes`	مدت رسمی
`capacity`، `seats_left`	ظرفیت و جای خالی
`is_paid`، `price_toman`	پولی بودن و قیمت به تومان
`poster`	نشانی تصویر پوستر، یا `null`

نمونه — نمایش رویدادها در سایت شما

<ul id="riqx-events"></ul>
<script>
fetch("https://v.riqx.one/api/v1/events/?organizer=نام-کاربری-شما")
  .then(r => r.json())
  .then(data => {
    const list = document.getElementById("riqx-events");
    for (const ev of data.results) {
      const li = document.createElement("li");
      const a = document.createElement("a");
      a.href = ev.url;
      a.textContent = ev.title + " — " + ev.starts_at_jalali;
      li.append(a);
      list.append(li);
    }
  });
</script>

خطاها

404 — رویداد نیست یا منتشر نشده، یا API از پنل خاموش شده.
405 — فقط GET پذیرفته می‌شود.

فایل تقویم (iCal)

GET https://v.riqx.one/events/نشانی-رویداد/calendar.ics

هر رویداد یک فایل .ics دارد. روی گوشی و رایانه با تقویم پیش‌فرض باز می‌شود و در تقویم گوگل با «افزودن از نشانی» وارد می‌شود. نشانی‌اش در فیلد calendar_url پاسخ API هم هست.

آنچه هنوز نیست

ساختن رویداد، ثبت‌نام و گرفتن فهرست شرکت‌کنندگان از راه API هنوز ممکن نیست؛ این کارها از پنل انجام می‌شوند. اتصال به Moodle و سامانه‌های آموزشی در صفحه‌ی مستندات توضیح داده شده است.