ParsGet API

v1.0.0

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

https://api.parsget.com/api/v1

روش‌های احراز هویت

روش احراز هویت را بر اساس نوع پروژه خود انتخاب کنید:

  • اسکریپت و سرور شخصی: استفاده از Personal API Key با پیشوند pgk_.
  • برنامه برای کاربران پارس‌گت: ورود با OAuth 2.0 و روش Authorization Code همراه با PKCE.
  • ابزارهای خط فرمان (CLI) و دستگاه‌ها: ورود با Device Flow و تأیید کاربر در مرورگر دستگاه دیگر.
Authorization: Bearer PARSGET_TOKEN

برای شروع، Access Token یا Personal API Key خود را در هدر بالا قرار دهید و GET /account را صدا بزنید. برای جزئیات کامل‌تر، راهنمای احراز هویت را بخوانید.

سازگار با هوش مصنوعی

صفحه‌های مرجع و راهنمای بخش‌ها نسخه Markdown دارند تا بتوانید متن آن‌ها را در اختیار ChatGPT یا Claude بگذارید. فهرست صفحه‌ها در llms.txt و متن کامل مرجع در llms-full.txt آمده است:

اولین درخواست

با فراخوانی GET /account اعتبار Access Token یا Personal API Key خود را بررسی کنید و ساختار پاسخ‌ها را ببینید.

curl -X GET "https://api.parsget.com/api/v1/account" \
  -H "Authorization: Bearer PARSGET_TOKEN"

ساختار پاسخ‌ها

پاسخ‌های JSON معمولاً داده را در data و اطلاعات تکمیلی را در meta برمی‌گردانند. مثال‌های زیر برای نمایش ساختار کلی کوتاه شده‌اند:

Success envelope
{
  "data": [
    {
      "id": "01M1BDA500B4A6D9K3N5R7T8VC",
      "status": "completed"
    }
  ],
  "meta": {
    "next_cursor": "eyJpZCI6IjAxTTFCREE1MDBCNEE2RDlLM041UjdUOFZDIiwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cnVlfQ",
    "has_more": true
  }
}
Error envelope
{
  "error": {
    "code": "validation_failed",
    "message": "The request contains invalid fields.",
    "details": {
      "fields": {
        "url": [
          "The field is invalid."
        ]
      }
    }
  }
}
data
داده اصلی در پاسخ‌های موفق.
meta
اطلاعات تکمیلی مانند صفحه‌بندی؛ این فیلد در همه پاسخ‌ها وجود ندارد.مقدار meta.next_cursor را بدون تغییر در پارامتر cursor درخواست بعدی بفرستید. has_more=false یعنی به انتهای فهرست رسیده‌اید.
error
برای مدیریت خطا، error.code را بخوانید. error.message توضیح انگلیسی خطاست.
X-Request-ID
شناسه پیگیری درخواست در هدر پاسخ. آن را در لاگ نگه دارید و هنگام گزارش مشکل برای پشتیبانی بفرستید.

پاسخ‌های 204 و 304 بدنه ندارند. پاسخ‌های OAuth ساختار جداگانه دارند که در صفحه همان endpoint آمده است.

بخش‌های API

راهنمای استفاده و مشخصات هر بخش را در صفحات زیر ببینید: