PRODUCTION REST API · v1

Jambulani otsitsa ndi YTSave

Yankha URL ya media ya anthu, sankhani mtundu weniweni, pangani ntchito yosagwirizana ndiponso perekani zotsatira zolemba kwa wogwiritsa ntchito wanu. Njira yomangidwa yomangidwa imathandizira tsamba la YTSave.

YTSaveClientJSON pa HTTPSNtchito zosagwirizanaZikalata zokhudzidwa

Yambani mwachangu

YTSave imayang'anira API host poyamba kudziwa ma credentials omwe amathandizidwa. Imatsatira ndi malo a tenant omwe adasankhidwa ndipo imasunga njira yotumizira mawu ya server yokha kuti ione.

URL ya Wogwiritsa Ntchitohttps://ytsave.app

KuzindikiraX-API-Key: ys_live_…

Mbiri ya kasitomalaYTSaveClient

Mtundu wa 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"}'

Kufotokozera chitetezo cha Credentials, YTSave imasiyanitsa kusungidwa kwa chinsinsi pa seva kuchokera ku kusakanikirana kwa makasitomala. Chikalata cha umboni sichipereka ma log kapena malo osungira anthu onse malo ake okha.

Yankha ulalo

YTSave imayang'anira ntchito ya Resolve poyamba kudziwa gwero la kupeza. Imatsatira ndi mitundu kuchokera ku URL imodzi yomwe yatumizidwa ndipo siyikupereka zotulutsa zolengedwa mu mawonekedwe.

PEREKA/v1/resolveMalo: kuthetsa

Munda	Mtundu	Zofunikira	Kufotokozera
`url`	URL ya HTTPS	Inde	Tsamba la anthu onse kapena lovomerezeka la media kuti muwunikire.
`tenant`	chingu	Ayi	Dzina la domain la tenant lomwe lapezeka. Nthawi zambiri limasiyidwa.

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

Kufotokozera chizindikiro cha Format, YTSave imasiyanitsa mtengo womwe wabweretsedwa osasinthidwa kuchokera ku kupezeka kwa ulalo uliwonse. Chikalata cha umboni sichipereka chizindikiro cha khalidwe lomwe lingaganizidwe malo ake okha.

Pangani ndi kutsatira ntchito yotsitsa

Pochita ntchito yopanga Job, YTSave imayamba ndi kukonzekera kosalumikizana. Zolemba zake za umboni zimaphatikiza izi ndi pempho la HTTP laling'ono ndipo zimatha ndi kuchita kwa wogwira ntchito wochepa.

PEREKA/v1/jobsMalo: ntchito

Munda	Mtundu	Zofunikira	Kufotokozera
`url`	URL ya HTTPS	Inde	Gwero lomwelo losinthidwa linalembedwa kuti lithandizire.
`format_id`	chingu	Inde	ID yeniyeni kuchokera ku yankho la kusintha.
`tenant`	chingu	Ayi	Dzina la domain la tenant lomwe lapezeka. Nthawi zambiri limasiyidwa.

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

2Malo a PollGET /v1/jobs/{job_id} ndi kiyi yomweyo.

3WokonzekaTsegulani URL yotsitsa yomwe yasintha.

Malo	Tanthauzo	Chinthu cha kasitomala
`queued`	Adalowa mʼmndandanda wolembedwa.	Funsani mafunso kachiwiri ndi kuchedwa.
`extracting`	Kukonzanso metadata ya gwero kapena njira.	Pitirizani kufunsa.
`processing`	Kutsitsa, kusintha kapena kuphatikiza.	Onetsani patsogolo pa seva.
`ready`	Kutsitsa kosainidwa kuli kupezeka.	Tumizani URL kwa wogwiritsa ntchito.
`failed`	Cholakwika chachikhalidwe cha terminal.	Werengani `error_code`. Yesani kachiwiri pokhapokha mutalimbikitsidwa.
`expired`	Zotsatira zapakati zatchulidwa.	Pangani ntchito yatsopano.

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

YTSave imapangitsa kuti kufufuza ntchito za Job kukhala kosavuta. Tsambalo limayamba ndi kudikira kwa sekondi imodzi, limatsatira njira yochepetsera nthawi, ndipo limafotokoza bwino kutumiza kosayina kwakanthawi.

Zolakwika zomwe zingayembekezedwe

Pachilango cha zolakwika, YTSave imayang'ana chikwatu chimodzi chosati cha 2xx musanapemphe ID yothandizira. Chidziwitso ichi chimapangitsa kuti kukonza makasitomala kuonekere bwino.

{
  "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	Tanthauzo wamba	Chitukuko
400	URL yosavomerezeka, thupi kapena mtundu wosapezeka.	Lembetsani bwino pempho. Yesaninso kuti mupeze ma format.
401	Chinsinsi cholephera, chosavomerezeka, chatha kapena cholephera pa malire.	Yang'anani chizindikiro cha seva.
403	Ndondomeko ya tenant kapena gwero yaletsa pempho.	Musapitilize malamulo. Lumikizanani ndi thandizo.
404	Ntchito yosadziwika kapena yatha nthawi.	Pangani ntchito yatsopano ngati zikugwirizana.
429	Pempho kapena malire a ntchito yolimbikitsidwa yafika.	Lembani ulemu `retry_after_seconds`.
503	Mndandanda/mphamvu kapena njira yapamwamba siyikupezeka kwakanthawi.	Yesetsani kachiwiri ndi kuchedwa kwa exponential ndi jitter.

Mgwirizano wogwira ntchito

YTSave imapereka quota yogwira ntchito ndi chilolezo chilichonse kuti iteteze wogwiritsa API ndi mautumiki a media apamwamba.

Gwiritsani ntchito njira ya pulogalamu yopanda kusintha ndipo musayambitse ntchito zofanana kawirikawiri pa dinani limodzi la wogwiritsa ntchito.
Sungani metadata yothetsera mwachidule, koma nthawi zonse onani ma URL otsitsa omwe ali ndi siginecha ngati omwe amatha kumalizidwa nthawi yake.
Gwiritsani ntchito bounded exponential backoff yokhala ndi jitter pa 429, 503 ndi zolakwika zomwe zingayesedwe kachiwiri.
Sinthani media ya anthu onse kapena media yomwe muli ndi ufulu woyang'anira. DRM ndi malamulo a kupeza siziphwanyidwa.
Sungani ma ID a pempho ndi ma ID a ntchito m'zolemba zachinsinsi zogwira ntchito. Osalemba ma URL omwe mwapereka osafunikira.

YTSave imayang'anira kupeza Schema poyamba kudziwa kuti yakhazikitsidwa bwanji musanayang'ane. Imatsatira ndi chilolezo cholembedwa ndipo imasunga mitundu ya pempho muwona. Chitsanzo cha OpenAPI

KUPEZERA KWA OPARETA WAFUFUZI

Pemphani kiyi yanu ya API

Lembani wogwiritsa ntchito API, kuwerengera kwake kwa pempho mwezi uliwonse ndi zofunikira za nsanja zomwe amathandiza. YTSave imayang'ana ngati kuthetsa, kutumiza ntchito kapena zonsezi zikuyenera pamaso poti ipereke kiyi yomwe inali yowonekera nthawi imodzi.

Pemphani mwayi wa API Makiyi amakhala okhudzana ndi wogwiritsa ntchito, amatha kuchotsedwa ndipo amaperekedwa kudzera mu fomu ya Contact. Zolemba zosadziwika sizitha kuchita ntchito ya downloader.