📓مستندات

📌 معرفی کلی API های گیم تولز

این صفحه به شما یک دید کلی از مجموعه API های گیم تولز ارائه می‌دهد. در این بخش، توضیحات مختصری از دسته‌های مختلف API ها قرار داده شده است تا شما با ویژگی‌ها و کاربردهای هر یک آشنا شوید. هر بخش از API ها دارای توضیحات جداگانه‌ای است که می‌توانید در لینک‌های مربوطه پیدا کنید.


📝 دسته‌بندی API های مجموعه گیم تولز

API های مختلف به دسته‌های جداگانه تقسیم شده‌اند تا دسترسی به آن‌ها آسان‌تر باشد. هر دسته به یک بخش خاص مربوط می‌شود و دارای مسیر استفاده مختص به خود است.

🔹 API های سرور: برای دسترسی به اطلاعات و داده‌های مربوط به سرورها، از جمله وضعیت سرور و سایر جزئیات.

📂
سرور

🔸 API های تیم مدیریت: برای دریافت لیست تیم مدیریت سرورها.

👨🏻‍💻
تیم مدیریت

🔸 API های بازیکنان: برای دسترسی به اطلاعات بازیکنان، بررسی و تغییر وضعیت آن‌ها و مدیریت پروفایل‌ها.

👬
بازیکنان

🔹 API های رأی‌گیری: برای مدیریت سیستم رأی‌گیری، امتیازدهی و بررسی امتیازات کاربران نسبت به سرورها.

🗳️
رای

🔹 API های بوست: این دسته برای دریافت بوست سرورها به کار می‌رود.

بوست

🔸 API های لایک: برای بررسی تعداد لایک‌های سرورها.

❤️
لایک

🛠 راهنمای سریع استفاده از API ها

برای استفاده مؤثر از هر API، نیاز به آشنایی با پارامترها، نوع داده‌ها و ساختار خروجی است. در اینجا یک راهنمای سریع برای شروع ارائه شده است:

  • پارامترهای ورودی: هر API دارای پارامترهای خاص خود است. جزئیات این پارامترها را می‌توانید در مستندات مربوطه بیابید.
  • ساختار خروجی: تمامی داده‌ها به فرمت JSON ارائه می‌شوند. خروجی هر API به تفکیک و با مثال‌های مرتبط در مستندات توضیح داده شده است.
  • مسیرها و متدها: برای دسترسی به هر بخش، مسیرهای مشخصی وجود دارد که می‌توانید با متدهای HTTP (مانند GET) درخواست ارسال کنید.

برای تسریع در شروع، مثال‌های کد در مستندات قرار داده شده است. این نمونه‌ها به شما در درک نحوه ارسال درخواست و دریافت پاسخ کمک می‌کنند.


🔓 دسترسی به API ها

برای دسترسی به API های عمومی نیازی به احراز هویت نیست، اما برخی از API های خصوصی نیاز به توکن و دسترسی خاص دارند.

🔑 دسترسی به API های عمومی و خصوصی

  • API های عمومی: دسترسی به این API ها آزاد است و بدون نیاز به احراز هویت می‌توانید از آن‌ها استفاده کنید.
  • API های خصوصی: به دلیل مسائل امنیتی، این API ها نیاز به توکن و سطح دسترسی خاص دارند. اطلاعات بیشتر در صفحات مربوط به هر API موجود است.

📜 نحوه دریافت توکن دسترسی

برای استفاده از API های خصوصی، لازم است که یک توکن دسترسی داشته باشید. برای دریافت توکن سرور خود، شما باید Owner سرور باشید و می‌توانید از طریق داشبورد گیم تولز توکن سرور خود را دریافت کنید.

لطفاً توجه داشته باشید که توکن‌ها را نباید در دسترس شخص یا سیستم‌های دیگر قرار دهید، زیرا این کار می‌تواند به امنیت اطلاعات شما آسیب برساند.


🛠 Template

در مجموعه گیم تولز، ما دو نوع قالب اصلی داریم که با استفاده از API های ما ساخته شده‌اند:

  1. قالب وب‌سایت: این قالب به شما این امکان را می‌دهد که به راحتی و به صورت یکپارچه از API های گیم تولز در وب‌سایت‌های خود استفاده کنید. با استفاده از این قالب، می‌توانید اطلاعات مختلفی را به صورت داینامیک در سایت خود نمایش دهید.
🌐
وبسایت
  1. بات دیسکورد: این بات برای استفاده در سرورهای دیسکورد طراحی شده و به شما امکان می‌دهد تا با اتصال به API های گیم تولز، قابلیت‌های جذابی را به سرور دیسکورد خود اضافه کنید.
🤖
دیسکورد

🔌 Extension

ما همچنین سه نوع اکستنشن داریم که به شما کمک می‌کند تا از قابلیت‌های گیم تولز در سرورهای مختلف استفاده کنید:

  1. پلاگین Minecraft: این اکستنشن به شما این امکان را می‌دهد تا با استفاده از API های گیم تولز در سرورهای Minecraft به راحتی با بازیکنان تعامل کنید. بازیکنان می‌توانند با استفاده از این پلاگین، رأی دهند و در ازای آن جوایزی دریافت کنند.
📗
پلاگین ماینکرفت
  1. اسکریپت FiveM: این اسکریپت برای سرورهای FiveM طراحی شده و به شما این امکان را می‌دهد که با استفاده از API های گیم تولز، عملکردهای جدیدی را به سرور خود اضافه کنید.
📒
اسکریپت فایوام
  1. اسکریپت MTA: با استفاده از این اسکریپت، بازیکنان می‌توانند در سرورهای MTA با استفاده از API های گیم تولز، رأی دهند و جوایز بگیرند.
📙
اسکریپت ام تی ای

این اکستنشن‌ها به شما این امکان را می‌دهند تا با استفاده از API های گیم تولز، تعاملات بیشتری با بازیکنان در سرورهای مختلف داشته باشید و به صورت داینامیک به رویدادهای مختلف پاسخ دهید.


🚀 شروع کنید!

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

✅ مراحل اولیه

  • بررسی مستندات: با مرور مستندات هر بخش، می‌توانید قابلیت‌های موجود را بررسی کنید.
  • آزمایش و تست: از ابزارهایی مانند Postman یا Insomnia استفاده کنید تا درخواست‌های آزمایشی ارسال کرده و ساختار داده‌ها را بررسی کنید.

💌 دسترسی به پشتیبانی

در صورتی که نیاز به کمک دارید، تیم پشتیبانی ما همیشه آماده است. از طریق سرور دیسکورد گیم تولز با ما در تماس باشید.

📆 به‌روز نگه‌داشتن مستندات

ما همواره تلاش می‌کنیم مستندات را به‌روز نگه داریم و شما آخرین تغییرات را در دسترس داشته باشید. پیشنهاد می‌کنیم به صورت مرتب به این صفحه مراجعه کرده و آپدیت‌ها را دنبال کنید.


امیدواریم که مستندات ما تجربه‌ی خوبی را برای شما فراهم کند و بتوانید بهترین استفاده را از API های گیم تولز داشته باشید! 🎉

آخرین آپدیت