مستندات API
این مستندات برای نقاط پایانی API در دسترس است که بر اساس معماری REST ساخته شدهاند. تمام نقاط پایانی API پاسخ JSON با کدهای پاسخ HTTP استاندارد برمیگردانند و نیاز به احراز هویت Bearer از طریق کلید API دارند.
احراز هویت
تمام نقاط پایانی API نیاز به کلید API دارند که از طریق روش احراز هویت Bearer ارسال میشود.
Authorization: Bearer {api_key}
curl --request GET \
--url 'https://98cloud.ir/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://98cloud.ir/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \
خطاها
API ما از کدهای وضعیت HTTP متداول برای نشان دادن موفقیت یا شکست یک درخواست استفاده میکند.
{
"errors": [
{
"title": "\u0634\u0645\u0627 \u0628\u0647 API \u062f\u0633\u062a\u0631\u0633\u06cc \u0646\u062f\u0627\u0631\u06cc\u062f.",
"status": 401
}
]
}
200 درخواست با موفقیت انجام شد
400 درخواست نامعتبر - پارامترهای ضروری缺失 یا نامعتبر هستند
401 غیرمجاز - کلید API缺失 یا نامعتبر است
404 منبع درخواستی یافت نشد
429 درخواستهای زیاد - محدودیت نرخ فراتر رفته است
500 خطای داخلی سرور - به معنای مشکل در سمت ما است
نتایج تمام نقاط پایانی API با منطقه زمانی UTC کار میکنند مگر اینکه بهصورت دیگری مشخص شده باشد.
کاربر
فایلها
اشتراکها
آمار اشتراک
آمار دانلودهای فایل
پروژهها
پیکسلها
دامنههای سفارشی
مدیریت اعلانها
پرداختهای حساب
گزارشهای حساب