API-ی REST-ی بەرهەم هێنان · v1

داگرتنەکان بە YTSave دروست بکە

بەستەری میدیای گشتیەکە چارەسەر بکە، فۆرماتی دیاریکراو هەڵبژێرە، کارێکی نێوانکاتی دروست بکە و ئەنجامی واژۆکراو بەکارهێنەرەکەت بدە. هەمان هێڵی بەرهەم هێنانی سنووردار ماڵپەڕی YTSave بەکار دەهێنێت.

YTSaveClientJSON لەسەر HTTPSکارەکانی ناهەمەجارناسنامەکانی دیاری کراو

دەستپێکی خێرا

YTSave بەڕێوەبەری API هەستیار دەکات بە یەکەم جیاکردنەوەی ناسنامەکانی پشتگیری کراوە. دواتر بە نیشاندانی کۆتایی کرێکار و ڕێڕەوی تەنها بۆ بانگەوازەکانی سێرڤەر بەردەوام دەبێت.

ناونیشانی کرێکارhttps://ytsave.app

دەستپێکردن بە ناونیشانX-API-Key: ys_live_…

پرۆفایلی کڕیارYTSaveClient

وەشانی APIv1

# Available only after support activation
export YTSAVE_API_KEY="issued-after-review"

curl -X POST https://ytsave.app/v1/resolve \
  -H "X-API-Key: $YTSAVE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://www.youtube.com/watch?v=VIDEO_ID"}'

بۆ ڕوونکردنەوەی ئاسودەیی ناسنامە، YTSave هەڵگرتنی نهێنی لای سێرڤەر جیا دەکات لە تێکەڵکردنی هیچ کۆمەڵەی کڕیار. تۆماری سەند هیچ تۆمارە گشتی یان کۆمەڵگەیەکی تایبەتی خۆی نیە.

چاکسازیی بەستەرێک

YTSave کارەساتی چارەسەرکردن بە سەرەتا دیاریکردنی دۆزینەوەی سەرچاوە دەکات. پاشان فۆرماتەکان لە یەک ناونیشانی URL ناردراو دابەزاندن و هیچ دەرچوونی دروستکراو لە سەر پەڕەکەدا نەگرتەوە.

POST/v1/resolveدەورە: چارەسەرکردن

بەردەست	جۆر	پێویست	وەسف
`url`	ناونیشانی HTTPS	بەڵێ	لاپەڕەی میدیای گشتی یان ڕێگەپێدراو بۆ ڕاگەیاندن.
`tenant`	رەشتە	نەخێر	ناونیشانی کرێکار دیاری کراوە. زۆرجار لەناوەڕاست دەکرێتەوە.

{
  "success": true,
  "platform": "youtube",
  "title": "Example video",
  "formats": [
    {"id":"18","type":"video","quality":"360p","container":"mp4"}
  ],
  "cached": false
}

بۆ ڕوونکردنەوەی ناسەری فۆرمات، YTSave نرخە گەڕاوەکان بە بێ گۆڕانکاری لە جیاکردنەوەی بەردەستبوونی هەر پەیوەندیدا جیا دەکات. تۆماری سەند هیچ ناونیشانی کەیفی گومانکراوەکی تایبەتی خۆی نیە.

دروستکردن و دابەزاندنی کارێکی داگرتن

بۆ دروستکردنی کار، YTSave دەستپێدەکات بە ئامادەکاری ئاسینکرۆن. تۆمارى سەندەکەی ئەوە لەگەڵ داواکاری کورتەی HTTP جۆرە و کۆتایی دەدات بە جێبەجێکردنی کارمەندی سنووردار.

POST/v1/jobsدەوربەری: کارەکان

بەردەست	جۆر	پێویست	وەسف
`url`	ناونیشانی HTTPS	بەڵێ	هەمان سەرچاوەی نۆرمالکراو ناردرا بۆ چارەسەرکردن.
`format_id`	رەشتە	بەڵێ	ناسنامەیەکی دروست لە وەڵامی چارەسەرکردنەوە.
`tenant`	رەشتە	نەخێر	ناونیشانی کرێکار دیاری کراوە. زۆرجار لەناوەڕاست دەکرێتەوە.

curl -X POST https://ytsave.app/v1/jobs \
  -H "X-API-Key: $YTSAVE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://www.youtube.com/watch?v=VIDEO_ID","format_id":"18"}'

1202 پەسەندکراوەپاشەکەوتکردن job_id.

2بارودۆخی ڕاگەیاندنGET /v1/jobs/{job_id} بە هەمان کلیلەوە

3ئامادەکردنەوەی URL داگرتنی واژۆکراو.

بارودۆخ	مانا	کرداری کڕیار
`queued`	پەسەندکرا بۆ هێڵی سنووردار.	دووبارە ڕاگەیەنە بە کەمکردنەوەی هەوڵ.
`extracting`	نوێکردنەوەی زانیاری سەرچاوە یان ڕێڕەو.	داوام بەردەوام بکە لە هەڵبژاردن.
`processing`	داگرتن، دووبارە ڕێکخستن یان یەککردنەوە.	پیشەڕەوی سێرڤەر نیشان بدە
`ready`	داگرتنی واژۆکراو بەردەستە.	ناونیشانی وێب بۆ بەکارهێنەر بنێرە.
`failed`	هەڵەی ڕووکەوتوو لە سیستەمی ترمینال.	خوێندن `error_code`. تەنها کاتێک ڕاهێنان کراوە دووبارە هەوڵبدە.
`expired`	ئەنجامی کاتی سەرچاوە لابرا.	کارێکی نوێ دروست بکە.

curl https://ytsave.app/v1/jobs/JOB_ID \
  -H "X-API-Key: $YTSAVE_API_KEY"

YTSave کارەساتی کارەکان بە ئاسانیدا دەکات بۆ سکانکردن. پەڕەکە دەستپێدەکات بە چاوەڕوانی یەک چرکەی سەرەتایی، پاشان بۆ کەمکردنەوەی کەوتەوەی سەرحدکراو، و بە شێوەیەکی ڕوون دڵنیایی پەخشانەکانی کاتی کاتی دەدات.

هەڵەی پێشبینی کراو

بۆ هەڵەی contract، YTSave یەک پەیامەکەی نە-2xx دەچێتەوە پێش ID-ی داواکاری پشتیوانی. ئەم تۆمارەی سەرچاوەش ڕوون دەکات چۆنیەتی چارەسەرکردنی کڕیار.

{
  "success": false,
  "error": {
    "code": "RATE_LIMITED",
    "category": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "retryable": true,
    "details": {"retry_after_seconds": 20}
  },
  "request_id": "…"
}

HTTP	مانای گشتی	کردار
400	ناڕاست URL، ناوەڕۆک یان فۆرماتەکە نەدۆزرایەوە.	داواکاریەکە ڕاست بکە. دووبارە بۆ فۆرماتەکان چارەسەر بکە.
401	کلیلەکە کەمە، نادروستە، کۆنە یان لە بوارێکی هەڵەدا.	پشتڕەوی سێرڤەر-لە لایەن دڵنیابکە.
403	سیاسەتی کرێکار یان سەرچاوە داواکاریەکە ڕەت کردەوە.	سیاسەتەکە مەزەندەکەوە مەکە. پەیوەندی بە پشتگیری بکە.
404	کارێکی نەناسراو یان کۆتایی هاتەوە.	دروستکردنی کارێکی نوێ ئەگەر گونجاو بێت.
429	داواکاری یان سنووری کارە چالاکەکان گەیشتەوە.	ڕەزامەندی `retry_after_seconds`.
503	هەڵبژاردنی ڕیزکردن/تواناکان یان سەرچاوەی سەرەوە کاتیەکی کەم نەدۆزرایەوە.	دووبارە هەوڵدان بە بەکارهێنانی کەمکردنەوەی هەژمارکراو و جیتەر.

پەیماننامەی کارکردن

YTSave هەر کاتێک پەسەند دەکرێت، بۆ پاراستنی بەکارهێنەری API و خزمەتگوزارییەکانی میدیای سەرچاوە، بڕی کارکردن دابین دەکات.

بەکارهێنانی لۆجیکی بەرنامەیەکی ئیدەمپۆتێنت و هەرگیز دەستپێکردنی کارە دووبارەکان بۆ هەمان کرتەی بەکارهێنەر نەکە.
مێتاداتای چارەسەرکردن بە خێرایی کەش بکە، بەڵام هەموو کات URL-ەکانی دابەزاندنی واژۆکراو وەک کەوتنە کاتی بەردەست بگرەوە.
بەکارهێنانی کەمکردنەوەی هەژمارکراوی سنووردار بە جیتەر بۆ 429, 503 و هەڵەیەکانی دووبارە هەوڵدان.
تەنها میدیای گشتی یان میدیای کە ڕێگە پێدراوە بۆ دەستپێکردن بەکاربەرەوە بەکاربهێنە. DRM و کۆنترۆڵەکانی دەستپێکردن نەکەوتەوە.
ناسنامەکانی داواکاری و ناسنامەکانی کار لە تۆمارەکانی کارکردنی تایبەتی پاشەکەوت بکە. URL-ە نێردراوەکان بەبێ هەژمارکردن تۆمار مەکە.

YTSave بەڕێوە دەبات بەدەست هێنانی دەستگەیشتنی Schema بە یەکەم شناسایی کردنی چالاککردن پێش ئەوەی گەڕان. دواتر بە سەردانی دڵنیایی دیاری کراو دەچێت و شێوەکانی داواکارییەکان بە تۆمار دەگرێت. بەڕێوەبەری OpenAPI

دەستپێکردنی بەڕێوەبەرایەتی کراو

داواکاری کلیلە API ی خۆت بکە

بەکارهێنەری API، هەژماری داواکاری مانگانەیەتی و پێویستیەکانی پلاتفۆڕمە پشتیوانکراو تۆمار بکە. YTSave پێشبینی دەکات ئەیا چارەسەرکردن، ناردنی کار یان هەردووەکان ڕاستە یان نا پێش ئەوەی کلیلێکی جارێکی بینراو بدات.

داواکردنی دەستڕەسەی API کلیلەکان بۆ کرێکارەکان تایبەتن، دەتوانرێن بگەڕێندرێن و لە ڕێگەی فۆڕمی پەیوەندیدانەوە دەرچوون. سکریپتە نەناسراوەکان ناتوانن کارەکانی داگرتن بەردەوام بکەن.