مقدمه
این راهنما نحوه اتصال برنامه نویسان به سرور تدریس مجازی از طریق API را توضیح میدهد.
API به روش REST سازماندهی شده است. همچنین بدنه درخواست ها و پاسخ ها با فرمت JSON می‌باشد.
فرمت کلی درخواست ها
همه درخواست ها از فرمت و آدرس یکسان اسفاده میکنند
همچنین بدنه درخواست ها و پاسخ ها با فرمت JSON می‌باشد.
Content-type: application/json
آدرس درخواستها : api/
پارامترها
| پارامتر | نوع | ضروری | توضیحات |
|---|---|---|---|
| Secret | string | No | config.yml قابل ویرایش در فایل |
| Type | string | Yes | نوع درخواست را مشخص میکند |
| Data | Json | No | برای هر درخواست متفاوت است |
api سکرت
- برخی از درخواست ها به apiSecret نیاز دارند . این مقدار را میتوانید در فایل کانفیگ ویرایش کنید.
- به صورت پیشفرض
meet listوactive meetsبه apiSecret نیاز دارند.