پرش به محتوای اصلی

API چگونه کار می‌کند

این مقاله اصول کار API مربوط به LeagueRepublic را به زبان ساده توضیح می‌دهد. برای دنبال کردن آن به هیچ دانش فنی‌ای نیاز ندارید.

نوشته‌شده توسط Pedro Maia

چه کسی می‌تواند از آن استفاده کند؟

لیگ‌هایی که طرح Gold دارند و API را روشن کرده‌اند. برای روشن کردن آن به صفحه اصلی مدیریت > API > تنظیمات API (Admin Home > API > API Settings) بروید و فعال‌سازی JSON API (Enable JSON API) را علامت بزنید. اگر یکی از این دو نباشد، هر نشانی وبی که در این مقاله‌ها آمده به‌جای داده‌های شما خطا برمی‌گرداند.

این چیست؟

API به یک وب‌سایت، اپلیکیشن یا برنامه دیگر اجازه می‌دهد برنامه مسابقات، نتایج و جدول‌های لیگ شما را مستقیم از LeagueRepublic بخواند. آن را مثل یک گارسون در نظر بگیرید: وب‌سایت شما چیزی درخواست می‌کند («لطفاً مسابقات امروز») و LeagueRepublic پاسخ را می‌آورد.

چطور درخواست می‌کنید؟

یک نشانی وب را باز می‌کنید، درست مثل باز کردن یک صفحه وب. به‌جای یک صفحه زیبا، متن ساده‌ای در قالبی به نام JSON دریافت می‌کنید. کد توسعه‌دهنده وب شما، یا صفحه‌ای که دستیار هوش مصنوعی ساخته، این متن را می‌خواند و به هر چیزی که طراحی کرده‌اید تبدیل می‌کند.

JSON چه شکلی است؟

فهرستی از برچسب‌ها و مقدارهاست، کمی شبیه فرمی که پر شده باشد:

{ "homeTeamName": "Arthurlie", "homeScore": "2" }

کلمه‌ای که قبل از دونقطه می‌آید نام فیلد است (برچسب روی فرم). بخش بعد از آن مقدار است (چیزی که در کادر نوشته شده). مشخصات API توضیح می‌دهد هر نام فیلد چه معنایی دارد.

شناسه (ID) چیست؟

هر لیگ، فصل، دسته، تیم و مسابقه در LeagueRepublic شماره مخصوص به خود را دارد که شناسه (ID) نامیده می‌شود. مثل شماره عضویت کار می‌کند: هرگز تغییر نمی‌کند و هیچ دو چیزی شناسه یکسان ندارند. شناسه‌ها را در نشانی وب می‌گذارید تا مشخص کنید کدام فصل یا تیم را می‌خواهید.

شناسه‌های خود را چطور پیدا کنم؟

شناسه لیگ شما در صفحه اصلی مدیریت > API > تنظیمات API (Admin Home > API > API Settings) نمایش داده می‌شود.

شناسه فصل شما: این نشانی را در مرورگر خود باز کنید و به‌جای [MY-LEAGUE-ID] شناسه لیگ خود را بگذارید. فصل‌های شما را همراه با شناسه هر کدام فهرست می‌کند.

https://api.leaguerepublic.com/json/getSeasonsForLeague/[MY-LEAGUE-ID].json

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

آیا محدودیتی هست؟

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

چند واژه که خواهید دید

Road – تیم مهمان. LeagueRepublic به‌جای «مهمان» که بیشتر مردم می‌گویند، «road» می‌گوید.

Fixture – یک مسابقه، چه برگزار شده باشد چه نه.

Fixture group – یک دسته (مثل «Premier Division»)، یک جام یا گروه دیگری از مسابقات.

Result – مسابقه‌ای که نتیجه دارد.

null – کادر خالی است. لیگ آن را وارد نکرده یا مربوط نیست.

true / false – بله / خیر.

جزئیات کامل کجاست؟

هر چیز دقیق، مثل هر نام فیلد، محدودیت و پیام‌های خطا، در مشخصات API آمده است:

آیا پاسخ سؤالتان داده شد؟