دانلودها
دریافت جزئیات دانلود
GET
https://api.parsget.com/api/v1/downloads/{download}OAuth یا Personal API Keyمقدار Access Token یا Personal API Key را با قالب Bearer TOKEN در هدر Authorization بفرستید.
برای پیگیری درخواست در لاگها، یک شناسه بین ۱ تا ۱۰۰ کاراکتر بفرستید. اگر این هدر را نفرستید، سرور شناسه میسازد.
هدرهای استانداردوضعیت فعلی و پیشرفت دانلود را برای پیگیری دورهای برمیگرداند. پس از تکمیل، از file_id برای دریافت مشخصات فایل و ساخت لینک دانلود استفاده کنید. برای نمایش امکان لغو یا تلاش مجدد، can_cancel و can_retry را بخوانید.
OAuth Scope: downloads:read
پس از تکمیل تورنت، ممکن است ارسال فایل به دیگر کاربران تورنت ادامه داشته باشد. در این حالت، status برابر completed و activity برابر seeding است.
Parameters
| Field | Type | Description |
|---|---|---|
download | string · pathrequired | شناسه یکتای دانلود |
Response schema
200جزئیات دانلود
Payload
object| Field | Type | Description |
|---|---|---|
id | string | — |
client_reference | string | برچسب دلخواه برای ارتباط دانلود با دادههای برنامه شما، مثلاً شناسه قسمت یک مجموعه. چند دانلود میتوانند برچسب یکسان داشته باشند. |
name | string | — |
status | stringqueuedprocessingdownloadingfinalizingcompletedblockedfailedcanceled | وضعیت دانلود. queued یعنی در صف، processing یعنی در حال بررسی و آمادهسازی دانلود، downloading یعنی دریافت فایل و finalizing یعنی آمادهسازی نهایی. completed یعنی تکمیل شده، blocked یعنی نیازمند پرداخت، failed یعنی ناموفق و canceled یعنی لغوشده. |
activity | stringseedingnull | پس از تکمیل تورنت، ممکن است ارسال فایل به دیگر کاربران تورنت ادامه داشته باشد. در این حالت، activity برابر seeding و status برابر completed است. |
source | object | |
type | stringurltorrentusenet | — |
hash | string | هش تورنت (فقط برای دانلودهای تورنت مقدار دارد) |
host | string | کد سرویس دانلود؛ برای اطلاعات سرویس آن را با code در GET /services تطبیق دهید. |
file_id | string | شناسه فایل ایجادشده پس از تکمیل موفق دانلود |
mime_type | string | — |
size_bytes | integerint64 | — |
progress | object | |
percent | numberfloatmin 0max 100 | درصد پیشرفت دانلود از ۰ تا ۱۰۰. |
bytes_completed | integerint64min 0 | حجم دریافتشده بر حسب بایت. |
speed_bytes_per_second | numbermin 0 | سرعت دریافت بر حسب بایت بر ثانیه؛ اگر مشخص نباشد null است. |
eta_seconds | numbermin 0 | زمان تخمینی باقیمانده بر حسب ثانیه؛ اگر مشخص نباشد null است. |
can_cancel | boolean | اگر true باشد، میتوانید دانلود را لغو کنید. دکمه لغو را بر اساس این مقدار نمایش دهید. |
can_retry | boolean | اگر true باشد، میتوانید دانلود را دوباره شروع کنید. دکمه تلاش مجدد را بر اساس این مقدار نمایش دهید. |
error | object | null | |
code | stringsource_unavailabledownload_expiredquota_exceededdownload_failed | — |
message | string | — |
created_at | stringdate-time | — |
updated_at | stringdate-time | — |
completed_at | stringdate-time | — |
attempt | integermin 1 | شماره تلاش دانلود، از ۱. با شروع موفق یک تلاش جدید از طریق endpoint retry افزایش مییابد. |
پاسخهای خطاساختار استاندارد
error