PRODUCTION REST API · v1

Tegura ibikururwa na YTSave

Sobanura URL y'itangazamakuru rusange, hitamo format nyayo, shyiraho akazi kadakora icyarimwe kandi uhe umusaruro wemejwe umukozi wawe. Umuyoboro umwe w'ibikorwa ugenzura urubuga rwa YTSave.

YTSaveClientJSON kuri HTTPSImirimo itegereje gukorwaImpamyabumenyi zifite imbibi

Gutangira byihuse

YTSave igenzura API host itangirira ku kumenya ibyangombwa byashyizweho n'inkunga. Ikurikiraho ni ihuriro ry'umukiriya ryagenwe kandi ikomeza kugaragaza inzira y'itumanaho rya server gusa.

URL y'umukiriyahttps://ytsave.app

Kwemeza umwirondoroX-API-Key: ys_live_…

Umwirondoro w'umukiriyaYTSaveClient

Verisiyo ya 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"}'

Gusobanura umutekano w'Impamyabumenyi, YTSave itandukanya kubika ibanga ku ruhande rwa server no kutinjiza umufuka w'umukiriya. Icyemezo cy'ibimenyetso ntigitanga inyandiko rusange cyangwa aho bibikwa ku giti cyacyo.

Gukemura umurongo

YTSave ikora ku gikorwa cyo Gukemura ibibazo itangira kumenya aho byaturutse. Ikurikirana n'amaforomati ava kuri URL imwe yatanze kandi ntigira ibisohoka byahimbwe bigaragara.

OHEREZA/v1/resolveUrwego: gukemura

Umwanya	Ubwoko	Bisabwa	Ibisobanuro
`url`	HTTPS URL	Yego	Urupapuro rusanzwe cyangwa rwemewe rw'itangazamakuru rwo gusesengura.
`tenant`	umurongo	Oya	Izina ry'ubukode ryagenwe. Akenshi ntirishyirwaho.

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

Gusobanura umwirondoro w'imiterere, YTSave itandukanya agaciro gasubijwe ntakagihindutse uhereye ku bushobozi bwa buri murongo. Icyemezo cy'ibimenyetso ntigitanga umwanya ku cyapa cy'ubuziranenge cyatekerejweho.

Tegura kandi ukurikire akazi ko gukurura

Ku bijyanye no gukora Akazi, YTSave itangirira ku myiteguro idahita ikorwa (asynchronous). Irekura inyandiko y'ibimenyetso ihuza n'ubusabe bugufi bwa HTTP kandi irangiza ishyira mu bikorwa umurimo ufite imbibi.

OHEREZA/v1/jobsIcyerekezo: imirimo

Umwanya	Ubwoko	Bisabwa	Ibisobanuro
`url`	HTTPS URL	Yego	Isoko imwe isanzwe yoherejwe kugirango ikemurwe.
`format_id`	umurongo	Yego	Indangamuntu nyakuri iva mu gisubizo cyo gukemura.
`tenant`	umurongo	Oya	Izina ry'ubukode ryagenwe. Akenshi ntirishyirwaho.

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

2Imiterere y'ubushakashatsiGET /v1/jobs/{job_id} n'ifunguro rimwe.

3BiteguyeFungura URL y'ububiko yasinye.

Imiterere	Ibisobanuro	Igikorwa cy'umukiriya
`queued`	Yemerewe mu murongo ugenwe.	Saba ibitekerezo ukundi ukoresheje gusubira inyuma.
`extracting`	Kuvugurura amakuru y'inkomoko cyangwa inzira.	Komeza gusaba amakuru.
`processing`	Gukurura, guhindura cyangwa guhuza.	Erekana intambwe y'umukozi w'ububiko.
`ready`	Ububiko bwasinye burahari.	Ohereza URL ku mukoresha.
`failed`	Ikosa ryubatswe muri terminal.	Soma `error_code`. Ongera ugerageze gusa igihe ubisabwe.
`expired`	Ibisohoka by'agateganyo byakuweho.	Tangira akazi gashya.

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

YTSave ituma gusuzuma akazi byoroha. Urupapuro rutangira n'igihe cyo gutegereza amasegonda rimwe, rukajya ku gusubira inyuma gufite umupaka, kandi rukavuga neza ko ari itangwa ry'igihe gito ryashyizweho umukono.

Amakosa ashobora guteganywa

Ku masezerano y'ikosa, YTSave igenzura agasanduku kamwe katari 2xx mbere y'ikimenyetso cy'ubusabe bw'inkunga. Iri tangazo ry'ibimenyetso rinagaragaza neza uburyo umukiriya azitwara.

{
  "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	Ibisobanuro bisanzwe	Igikorwa
400	URL itariyo, umubiri cyangwa uburyo butaboneka.	Hindura icyifuzo. Subira gusuzuma ku mafishi.
401	Urufunguzo rucitse, rudakwiye, rwarangiye cyangwa rufite uburenganzira butari bwo.	Reba icyemezo cya seriveri.
403	Politiki y'umukiriya cyangwa isoko yanze ubusabe.	Ntukarenze ku mategeko. Vugana n'ubufasha.
404	Akazi katazwi cyangwa kashize igihe.	Tangira akazi gashya niba biboneye.
429	Umubare ntarengwa w'ibisabwa cyangwa imirimo ikora wagezeho.	Icyubahiro `retry_after_seconds`.
503	Urutonde/ubushobozi cyangwa umurongo w'ibanze ntibiboneka by'agateganyo.	Gerageza kongera ukoresheje uburyo bwo kugabanya gahoro gahoro hamwe no guhindagurika.

Amasezerano y'akazi

YTSave itanga umubare ntarengwa w’imikoreshereze buri gihe yemerewe kugira ngo irinde umukoresha wa API n’ibikorwa by’itangazamakuru byo hejuru.

Koresha imitekerereze y'ubusubirizo idahinduka kandi ntutangire imirimo y'inyongera ku gukanda kumwe kw'umukoresha umwe.
Bika by'agateganyo amakuru y'ibisubizo, ariko ihorere URL z'ububiko zifite umukono nk'izishaje.
Koresha gusubira inyuma kwa exponential gufite imbago hamwe na jitter 429, 503 n'amakosa ashobora gusubirwamo.
Kora gusa ku itangazamakuru rusange cyangwa iryemerewe kugerwaho. DRM n'ubugenzuzi bw'uburenganzira ntibinyurwaho.
Bika nimero z’ibisabwa na nimero z’imirimo mu bitabo by’ibikorwa byihariye. Ntukandike URL zoherejwe utabikeneye.

YTSave igenzura uburyo bwo kugera kuri Schema itangirira ku kumenya niba byahise byemezwa mbere yo kugenzura. Ikurikiraho ni ugushyiraho uburyo bwo kwemeza no kugumana inyandiko z'ubusabe zigaragara. Icyerekezo cya OpenAPI

UBURYO BWEMEWE N'UMUKORESHA

Saba urufunguzo rwa API yawe

Andika umukoresha wa API, igipimo cy'ubusabe bwe buri kwezi n'ibisabwa ku rubuga bishyigikiwe. YTSave isuzuma niba gukemura, kohereza akazi cyangwa byombi byemewe mbere yo gutanga urufunguzo rwerekanwe rimwe.

Saba uburenganzira bwo gukoresha API Imfunguzo zifite imbibi ku bakoresha, zirashobora gukurwaho kandi zitangwa binyuze ku ifishi yo Kuvugana. Scripts zidafite amazina ntizishobora gukora akazi ko gukuramo.