PRODUCTION REST API · v1

Tegura gushikira n'uburyo bwa YTSave

Gusubiza URL y'itangazamakuru rusangi, guhitamwo uburyo nyabwo, gukora akazi katari kumwe no guha umuserukira ibimenyetso vyemejwe. Umuyagankuba umwe w'ibikorwa uha imbaraga urubuga rwa YTSave.

YTSaveClientJSON ku HTTPSImirimo idakora mu gihe kimweIvyemezo vyemejwe

Gutanguza vuba

YTSave irakora ku mutwe wa API itangura yerekana uburenganzira bwemejwe n'inkunga. Ikomereza ku murongo w'uwukoresha wahariwe kandi ikagumana inzira y'ubusabe bw'umurongo w'igikoresho gusa mu maso.

Url y'umukoreshahttps://ytsave.app

Kwemeza umwirondoroX-API-Key: ys_live_…

Ikarata y'umukiriyaYTSaveClient

Ico API igezwehov1

# 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"}'

Kugira usobanukirwe umutekano w’inyandiko z’ukwiyandikisha, YTSave iratandukanya ububiko bw’ibanga ku ruhande rwa server n’ukutagira ikintu na kimwe c’ishirahamwe ry’umukiriya. Ikarata y’ukwemeza ntitanga inyandiko rusangi canke ahantu hihariye h’ububiko.

Gusubiza ku murongo

YTSave irakora igikorwa ca Resolve itangura kumenya aho isoko riva. Ikurikira n'uburyo butangwa n'URL imwe yoherejwe kandi ntibika ibisohoka vyahimbwe mu kwerekana.

OHEREZA/v1/resolveIhiganwa: gukemura

Umwanya	Ubwoko	Bisabwa	Ibisobanuro
`url`	HTTPS URL	Ego	Urupapuro rw'itangazamakuru rusangi canke rwemewe rwo gusesengura.
`tenant`	umurongo	Oya	Akarorero k'akarorero k'umuturage. Akenshi ntikabonekera.

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

Kugira usobanure Ikimenyetso c'Ifaranga, YTSave iratandukanya agaciro gasubijwe katahindutse kuva ku kuboneka kwa buri murongo. Ico gihimbano ntigitanga akadomo k'ubwiza bw'ukwiyumvira ku gice caco.

Hanga kandi ukurikirane akazi ko gukurako

Ku gukora Akazi, YTSave itangura n'ugutegura kudahuza. Ikaranga ibimenyetso vyayo hamwe n'ubusabe bugufi bwa HTTP kandi irangiza n'ugukora kw'abakozi bafise imbibe.

OHEREZA/v1/jobsIhiganwa: imirimo

Umwanya	Ubwoko	Bisabwa	Ibisobanuro
`url`	HTTPS URL	Ego	Isoko risanzwe ryatanzwe kugira rihabwe igisubizo.
`format_id`	umurongo	Ego	ID nyakuri ivuye mu gisubizo co gukemura.
`tenant`	umurongo	Oya	Akarorero k'akarorero k'umuturage. Akenshi ntikabonekera.

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 VyemereweBika job_id.

2Imiterere y'ivyiyumviroGET /v1/jobs/{job_id} n'ifunguro risa.

3VyiteguyeFungura URL yo gukurako yasinye.

Imiterere	Ibisobanuro	Igikorwa c'umukiriya
`queued`	Yemerewe kwinjira mu murwi w'ugutegereza.	Gusubiramwo amatora ukoresheje gusubira inyuma.
`extracting`	Kuvugurura amakuru y'inkomoko canke inzira.	Komeza gutora amakuru.
`processing`	Gukurako, guhindura canke guhuza.	Erekana intambwe y'umurongo w'ubushikiranganji.
`ready`	Gukurako yasinye iraboneka.	Ohereza URL ku mukoresha.
`failed`	Ikosa ryubatswe mu buryo bwa terminal.	Soma `error_code`. Subira gusa igihe ubisabwe.
`expired`	Ibisohoka vy'agateganyo vyakuweho.	Hanga akazi gashasha.

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

YTSave korohereza gusuzuma akazi k'ugusoma. Urupapuro rutangura n'ugutegereza umunota umwe, rukagenda rumanuka buhoro, kandi rukavuga neza ko hariho gutanga ibimenyetso vy'igihe gito.

Amakosa ashobora kwitega

Ku masezerano y'ikosa, YTSave iragenzura agasandugu kamwe katari 2xx imbere y'ikimenyetso c'ubusabe bw'inkunga. Iyi nyandiko y'ibimenyetso ituma uburyo bwo gufata abakiriya bugaragara neza.

{
  "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	Ivyiyumviro bisanzwe	Igikorwa
400	URL itariyo, umubiri canke uburyo butaboneka.	Hindura ubusabe. Subira gushaka ku buryo bw'ivyuma.
401	Ikoreshwa ry'ingenzi ritaboneka, ritari ryo, ryarengeje igihe canke rifise imbibe zitari zo.	Raba ibimenyetso vy'uruhande rw'umukozi wa seriveri.
403	Itegeko ry’umukoresha canke isoko ryanka ubusabe.	Ntukirengagize amategeko. Vugana n'ubufasha.
404	Akazi katamenyekanye canke kahera igihe.	Hanga akazi gashasha igihe bikwiye.
429	Uruhara rwo gusaba canke akazi kariko karakorwa rwuzuye.	Icohwe `retry_after_seconds`.
503	Urutonde/ubushobozi canke umuyagankuba ntibiboneka mu gihe gito.	Gerageza ukundi ukoresheje gusubira inyuma kwiyongera no guhindagurika.

Amasezerano y'akazi

YTSave itanga urugero rw'akazi hamwe n'ukwemera kwose kugira irinde umukoresha wa API hamwe n'ibikorwa vy'ibinyamakuru vy'inyuma.

Koresha logic y'ubusubirizi idahinduka kandi ntutangure imirimo y'ubwenge y'ibiri kwiyongera ku gukanda kumwe kw'umukoresha.
Bika mu buryo bugufi amakuru y'inyuma, ariko ihora ufata URL z'ugushikira zifise umukono nk'izirangirana.
Koresha gusubira inyuma kwiyongera kw'igihe hamwe na jitter kuri 429, 503 n'amakosa ashobora gusubirwamwo.
Kora gusa ku bitangazwa rusangi canke ku bitangazwa wemerewe kwinjiramwo. DRM n'ubugenzuzi bw'ukwinjira ntibishobora kwirengagizwa.
Bika indangamuntu z'ubusabe hamwe n'indangamuntu z'akazi mu bitabu vy'ibikorwa vy'ibanga. Ntukandike imirongo y'ama URL yoherejwe utabikeneye.

YTSave irakora ku bijanye no kwinjira muri Schema itangura kumenya kwatsa mbere yo gusuzuma. Ikurikira kwemeza uburenganzira bwatanzwe kandi ikabika mu nyandiko imiterere y'ubusabe mu kiringo. Ihinyanyurwa rya OpenAPI

KWEMERERWA KWEMEWE N'UMUKORESHA

Saba urufunguzo rwa API yawe

Andika umukoresha wa API, iciyumviro c'ukwiyandikisha kwa kwe kw'ukwezi n'ibikenewe ku mbuga zishyigikiwe. YTSave iragenzura niba gukemura, gutanga akazi canke vyose vyemewe mbere yo gutanga urufunguzo ruboneka rimwe gusa.

Saba uburenganzira bwo gukoresha API Imfungurwa zifise imbibe z'abakoresha, zirashobora gukurwa kandi zitangwa biciye ku fomu yo guhamagara. Amashirahamwe atamenyekanye ntashobora gukora akazi ko gukurura.