مستندات وب سرویس گیتهاب
با استفاده از این وب سرویس، میتوانید اطلاعات پروفایل گیتهاب، اطلاعات مخزن و لیست برخی از مخازن یک پیج را دریافت کنید.
جهت دریافت توکن دسترسی، اینجا کلیک کنید. - نمونه توکن دسترسی: 750394:b5d1ada54acf4185c1a114a526d0bf18
دسترسی به نسخه 2 وب سرویس، از طریق لینک زیر امکان پذیر است:
https://api.ineo-team.ir/github.php
با توجه به اینکه وب سرویس، نیاز به توکن دسترسی دارد، میبایست در هنگام ارسال درخواست از طریق متد GET یا POST، باید مقدار پارامتر accessKey
برابر با توکن دسترسی شما باشد.
https://api.ineo-team.ir/github.php?accessKey=750394:b5d1ada54acf4185c1a114a526d0bf18
برای استفاده از این وب سرویس، درخواست ها را باید از طریق متد GET یا POST ارسال کنیم.
نکته مهم 1: این وب سرویس دارای سیستم کنترل اسپم میباشد و در صورتی که در 11 ثانیه، بیشتر از 10 درخواست به وب سرویس ارسال کنید، آیپی شما مسدود خواهد شد و دسترسی به این وب سرویس برای شما ممکن نخواهد بود و با توجه به قوانین و شرایط استفاده از وب سرویس های آی نئو، بعد از بلاک شدن، توکن دسترسی شما مسدود خواهد شد.
نکته مهم 2: در صورتی که از کانال رسمی وب سرویس های آی نئو خارج شوید، تمامی توکن دسترسی های شما غیرفعال میشوند و برای فعال سازی مجدد، میبایست ابتدا در کانال @iNeoAPI عضو شوید و بر روی دستور /active کلیک کنید تا توسط پشتیبانی، عضویت شما بررسی و توکن دسترسی های شما مجددا فعال شوند.
با استفاده از این درخواست، میتوانید اطلاعات مربوط به یک پروفایل در گیتهاب را دریافت کنید.
accessKey | اجباری | توکن دسترسی شما |
---|---|---|
action | اجباری | مقدار: profile |
username | اجباری | نام کاربری گیتهاب |
جهت ارسال درخواست از طریق متد POST
، باید از پارامترهای بالا استفاده کنید.
نمونه ارسال درخواست از طریق لینک:
با استفاده از این درخواست، میتوانید اطلاعات مربوط به یک مخزن در پروفایل گیتهاب را دریافت کنید.
accessKey | اجباری | توکن دسترسی شما |
---|---|---|
action | اجباری | مقدار: project |
url | اجباری | لینک مخزن گیتهاب |
جهت ارسال درخواست از طریق متد POST
، باید از پارامترهای بالا استفاده کنید.
نمونه ارسال درخواست از طریق لینک:
با استفاده از این درخواست، میتوانید لیست مخازن یک پروفایل گیتهاب را دریافت کنید..
accessKey | اجباری | توکن دسترسی شما |
---|---|---|
action | اجباری | مقدار: repositories |
username | اجباری | نام کاربری گیتهاب |
جهت ارسال درخواست از طریق متد POST
، باید از پارامترهای بالا استفاده کنید.
نمونه ارسال درخواست از طریق لینک:
با استفاده از جدول زیر، میتوانید وضعیت و خطا های هر درخواست وب سرویس گیتهاب را بررسی کنید.
لیست کد وضعیت درخواست:
200 - successfully | درخواست به موفقیت ارسال شد. |
---|---|
4001 - parameter_error | پارامترهای اصلی و اجباری وارد نشده اند. |
308 - username_error | نام کاربری پیدا نشده است. |
309 - repositorie_error | مخزن مورد نظر پیدا نشده است. |
307 - url_error | لینک پروژه ارسال شده نادرست است. |
310 - server_busy | لطفا کمی صبر کنید و سپس درخواست ارسال کنید. |
در صورتی که کد وضعیت مورد نظر، در جدول بالا نبود، جدول کامل لیست کد وضعیت درخواست ها را مطالعه کنید.
شما از طریق قطعه کد زیر، میتوانید تمامی درخواست ها را به وب سرویس گیتهاب آی نئو تیم ارسال کنید، کافیست مقدار پارامترها را به صورت آرایه از طریق کد زیر با وب سرویس ارسال کنید.
گیتهاب وب سرویس - معرفی در تلگرام - دانلود نمونه کد
تصویر زیر، قطعه کد ارسال درخواست میباشد که میبایست در خط 5 به جای YOUR_ACCESS_KEY
، توکن دسترسی خود را بگذارید و مقدار پارامتر را به صورت آرایه ارسال کنید.