API-DIIMAHA SOOSAARKA · v1

Dhiso soo-dejinta adigoo adeegsanaya YTSave

Xallinta URL warbaahin dadweyne, doorashada qaab sax ah, abuurista shaqo aan isku xirin iyo gudbinta natiijada saxiixan ee isticmaalahaaga. Isla habka wax soo saarka ee xaddidan ayaa awood u leh bogga YTSave.

YTSaveClientJSON ka sarreeya HTTPSShaqooyinka aan isku xiranaynAqoonsiyo xaddidan
01

Bilow degdeg ah

YTSave wuxuu maamulaa martida API-ga isagoo marka hore aqoonsanaya shahaadooyinka taageerada firfircoon. Waxa uu raacaa barta dhamaadka ee kireystaha loo qoondeeyay wuxuuna hayaa waddo wicitaan server-kaliya ah oo muuqata.

URL-ka kiraystahahttps://ytsave.app
AqoonsiX-API-Key: ys_live_…
Macluumaadka macmiilkaYTSaveClient
Nooca 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"}'

Si loo sharaxo badbaadada Aqoonsiga, YTSave waxay kala soocdaa kaydinta sirta server-ka dhinaca iyo inaan la gelin wax xirmo macmiil ah. Diiwaanka caddeynta ma siinayo wax diiwaanno dadweyne ah ama kaydyo meel u gaar ah.

02

Xallinta xiriir

YTSave wuxuu maareeyaa hawsha Xallinta isagoo marka hore aqoonsanaya ogaanshaha ilaha. Waxa uu raacaa qaabab ka yimid hal URL oo la soo gudbiyey wuxuuna hayaa wax soo saar aan la hal abuurin oo muuqaal ah.

POST/v1/resolveBaaxadda: xallinta
BeertaNoocaLoo Baahan YahaySharaxaad
urlURL HTTPSHaaBogga warbaahinta dadweynaha ama la oggolaaday si loo falanqeeyo.
tenantxadhigMayaDomeenka kiraystaha ee loo qoondeeyey. Caadi ahaan waa la dhaafaa.
{
  "success": true,
  "platform": "youtube",
  "title": "Example video",
  "formats": [
    {"id":"18","type":"video","quality":"360p","container":"mp4"}
  ],
  "cached": false
}

Si loo sharaxo Aqoonsadaha Qaabka, YTSave wuxuu kala soocaa qiimaha la soo celiyay iyada oo aan waxba laga beddelin helitaanka xiriir kasta. Diiwaanka caddeynta ma siinayo summad tayo la qiyaasay meel u gaar ah.

03

Abuur oo raac shaqo soo dejin

Abuurista Shaqada, YTSave wuxuu ku bilaabaa diyaarinta asynchronous. Diiwaankiisu wuxuu isku daraa taas codsi HTTP gaaban wuxuuna ku dhammaadaa fulinta shaqaale xaddidan.

POST/v1/jobsBaaxadda: shaqooyinka
BeertaNoocaLoo Baahan YahaySharaxaad
urlURL HTTPSHaaIsha isku midka ah ee la habeeyey ayaa la gudbiyey si loo xalliyo.
format_idxadhigHaaAqoonsi sax ah oo ka yimid jawaabta xallinta.
tenantxadhigMayaDomeenka kiraystaha ee loo qoondeeyey. Caadi ahaan waa la dhaafaa.
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 La aqbalayKeydi job_id.
2Xaaladda codbixintaGET /v1/jobs/{job_id} iyadoo la isticmaalayo furaha isku midka ah.
3DiyaarFur URL-ka soo dejinta ee la saxiixay.
XaaladdaMacnahaFal macaamiil
queuedWaxaa lagu aqbalay safka xaddidan.Codso mar kale adigoo dib u dhac leh.
extractingDib u cusboonaysiinaya xogta ilaha ama waddada.Sii wad codsiga xogta.
processingSoo dejin, dib u habeyn ama isku darka.Muuji horumarka server-ka.
readySoo dejinta la saxiixay waa la heli karaa.U dir URL-ka isticmaalaha.
failedKhalad qaabaysan oo terminal ah.Akhri error_code. Isku day mar kale kaliya marka lagula taliyo.
expiredSoo saarista ku meel gaarka ah waa la tirtiray.Abuur shaqo cusub.
curl https://ytsave.app/v1/jobs/JOB_ID \
  -H "X-API-Key: $YTSAVE_API_KEY"

YTSave wuxuu ka dhigaa baaritaanka Shaqada mid sahlan in la baadho. Boggu wuxuu ku bilaabmaa sugitaan bilow ah oo hal ilbiriqsi ah, wuxuu u guuraa dib u dhac xadidan, wuxuuna si cad u sheegaa gaarsiinta ku meel gaarka ah ee la saxiixay.

04

Khaladaadka la saadaalin karo

Qandaraaska Khaladka, YTSave wuxuu hubiyaa hal baqshad aan 2xx ahayn ka hor aqoonsiga codsiga taageerada. Diiwaanka caddeyntan ayaa sidoo kale ka dhigaya maaraynta macmiilka mid la saadaalin karo oo cad.

{
  "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": "…"
}
HTTPMacnaha caadiga ahFal
400URL aan sax ahayn, jidh ama qaab aan la heli karin.Sax codsiga. Mar kale u xalliya qaabab.
401Furaha maqan, aan sax ahayn, dhacay ama leh baaxad khaldan.Hubi shahaadada dhinaca server-ka.
403Sharciga kiraystaha ama isha ayaa diiday codsiga.Ha ka boodin siyaasadda. La xiriir taageerada.
404Shaqo aan la garanayn ama dhacday.Abuur shaqo cusub haddii ay habboon tahay.
429Codsi ama xadka shaqada firfircoon waa la gaaray.Sharaf retry_after_seconds.
503Saf/awood ama kor u socod si ku meel gaar ah lama heli karo.Isku day mar kale adigoo adeegsanaya dib-u-celin korodhsi leh iyo gariir.
05

Qandaraas hawleed

YTSave waxay bixisaa xad hawleed kasta oo la oggolaado si loo ilaaliyo isticmaalaha API-ga iyo adeegyada warbaahinta ee sare.

YTSave waxay maamushaa helitaanka Schema iyadoo marka hore aqoonsanaysa dhaqaajinta ka hor sahaminta. Waxay raacdaa xaqiijinta loo qoondeeyay waxayna haynaysaa qaababka codsiga ee la diiwaangeliyay oo muuqda. Tixraaca OpenAPI

GALIDKA LAGU EEGEY HAWLGALKA

Codso furahaaga API

Dukumiinti isticmaalaha API-ga, qiyaasta codsiga bille iyo shuruudaha madal ee la taageeray. YTSave waxay dib u eegtaa haddii xallinta, gudbinta shaqada ama labadaba ay sax yihiin ka hor inta aan la bixin furaha mar muuqda.

Codso helitaanka API Furayaasha waa kuwo ku kooban kiraystaha, la joojin karo waxaana lagu siiyaa foomka Xiriirka. Qoraallada aan la aqoonsan karin ma fulin karaan shaqada soo dejiyaha.