تغییرات

تغییرات مهم گیم روت و API عمومی در این صفحه ثبت می‌شود. تغییری که کد موجود شما را از کار بیندازد فقط در نسخه جدید API (مثلاً /api/v2) منتشر می‌شود و دست‌کم ۳۰ روز پیش از آن در همین صفحه اعلام خواهد شد. افزودن فیلد یا مسیر جدید تغییر ناسازگار حساب نمی‌شود.

۹ آبان ۱۴۰۵: نسخه ۱ API عمومی#

API#

• انتشار API عمومی نسخه ۱ در https://gameroute.ir/api/v1 با سند OpenAPI 3.1 در /api/v1/openapi.json.
• مسیرهای خواندنی: فهرست و جزئیات سرورها، وضعیت زنده، بازیکنان، نمودار ۲۴ ساعته، ۷ روزه و ۳۰ روزه، رکوردها و نشان‌ها و اخبار.
• مسیرهای مدیریتی با کلید سرور: انتشار، ویرایش و حذف خبر (news:write) و ویرایش اطلاعات سرور (profile:write).
• کلیدهای API با پیشوند gr_live_، کلید حساب برای خواندن و کلید سرور برای مدیریت، با بررسی دوباره دسترسی سازنده در هر درخواست.
• سقف درخواست: ۱۲۰ درخواست در دقیقه برای هر کلید و ۳۰ درخواست در دقیقه برای درخواست‌های بدون کلید، با سرآیندهای X-RateLimit-*.
• CORS باز برای مسیرهای خواندنی.

وبهوک و ابزارک#

• وبهوک‌ها برای آفلاین و آنلاین شدن سرور، رکورد جدید، بوست جدید و نظر جدید؛ به آدرس HTTP با امضای HMAC-SHA256 یا مستقیم به کانال دیسکورد، با ارسال آزمایشی، گزارش ارسال‌ها و تلاش مجدد خودکار.
• بنرهای وضعیت SVG و PNG در چهار اندازه و سه پوسته، و کارت زنده iframe در /embed/server/<slug>.

داکیومنت#

• داکیومنت تازه با فهرست بخش‌ها، فهرست مطالب هر صفحه، جست‌وجو و دکمه کپی برای نمونه کدها.
• مرجع API که از روی کد ساخته می‌شود، با نمونه کد cURL، JavaScript، Python و PHP و امکان آزمایش مسیرها با کلید خودتان.
• بازنویسی کامل قوانین، شرایط استفاده از خدمات و حریم خصوصی.