API WHAKATIPU · v1

Hangaia ngā tikiake me YTSave

Whakatau i tētahi URL pāpāho tūmatanui, tīpakohia tētahi hōputu tika, waihangatia he mahi ā-tāpare, ā, tukuna te hua hainatia ki tō kaiwhakamahi. Ko taua ara whakaputa herea anō te hiko o te paetukutuku YTSave.

YTSaveClientJSON mā runga HTTPSNgā mahi kore wāNgā tohu whai here
01

Tīmatanga tere

Ka whakahaere a YTSave i te mana API mā te tautuhi tuatahi i ngā tohu tautoko kua whakahohea. Ka whai i tētahi mutunga tenant kua tohua, ā, ka pupuri i tētahi ara karanga tūmatanui anake i te tirohanga.

URL Tenanthttps://ytsave.app
WhakamanaX-API-Key: ys_live_…
Kōtaha kiritakiYTSaveClient
Putanga 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"}'

Hei whakamārama i te haumaru Tohu, ka wehewehe a YTSave i te rokiroki huna o te taha tūmau mai i te kore whakauru kohinga kiritaki. Kāore he rēhita taunakitanga e tuku ana i ngā rārangi tūmatanui, rārangi rānei, hei wāhi motuhake māna.

02

Whakatau hono

Ka whakahaere te YTSave i te mahi Whakatau mā te tuatahi te tautuhi i te kitenga pūtake. Ka whai i ngā hōputu mai i tētahi URL i tukuna mai, ā, kāore e pupuri i ngā putanga i hangaia i roto i te tirohanga.

TUKUNA/v1/resolveRohe: whakatau
MāraMomoMeWhakaahuatanga
urlURL HTTPSĀeWhārangi pāpāho tūmatanui, mana rānei hei tātaritanga.
tenanttaeKāoRohe tenant kua tohua. He mea whakakore i te nuinga o te wā.
{
  "success": true,
  "platform": "youtube",
  "title": "Example video",
  "formats": [
    {"id":"18","type":"video","quality":"360p","container":"mp4"}
  ],
  "cached": false
}

Hei whakamārama i te tohu Hōputu, ka wehewehea e YTSave te uara whakahokia kāore i whakarerekē i te wātea ā-hononga. Kāore he tūnga motuhake mō tētahi tapanga kounga matapae i roto i te tuhinga taunakitanga.

03

Hangaia, ā, whai i tētahi mahi tikiake

Mō te hanga Mahi, ka tīmata te YTSave ki te whakarite ā-tāwariwari. Ka hono tōna rekoata taunakitanga ki tētahi tono HTTP poto, ā, ka mutu ki te whakahaere kaimahi ā-rohe.

TUKUNA/v1/jobsWhānui: mahi
MāraMomoMeWhakaahuatanga
urlURL HTTPSĀeKo te puna ōrite i tuku hei whakatau.
format_idtaeĀeHe ID tika mai i te whakautu whakatau.
tenanttaeKāoRohe tenant kua tohua. He mea whakakore i te nuinga o te wā.
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 Kua whakaaetiaTiaki job_id.
2Tūnga pōtiGET /v1/jobs/{job_id} me taua kī anō.
3Kua riteWhakatuwheratia te URL tikiake kua hainatia.
TūngaTikangaMahi kiritaki
queuedKua whakaaetia ki te rārangi tatari.Pātai anō me te whakamāharahara.
extractingE whakahou ana i ngā raraunga pūtake, i te ara rānei.Haere tonu ki te uiui.
processingKei te tikiake, te whakahou, te whakakotahi rānei.Whakaatu ahunga whakamua tūmau.
readyKei te wātea te tikiake hainatia.Tukuna te URL ki te kaiwhakamahi.
failedHapa hanganga tauranga.Pānui error_code. Tirohia anō anake i te wā ka tohutohutia.
expiredKua tangohia te putanga wā poto.Hangaia he mahi hou.
curl https://ytsave.app/v1/jobs/JOB_ID \
  -H "X-API-Key: $YTSAVE_API_KEY"

He māmā te tātari mahi a YTSave. Ka tīmata te whārangi ki te tatari tuatahi mō te kotahi hēkona, ka neke ki te whakamāhure ārai, ā, ka kī mārama mō te tuku waitohu wā poto.

04

Ngā hapa e taea te matapae

Mō te kirimana Hapa, ka tirotiro a YTSave i tētahi pūkete kāore i te 2xx i mua i tētahi ID tono tautoko. E mārama ana tēnei pūrongo taunakitanga i te whakahaere kiritaki e taea ana te matapae.

{
  "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": "…"
}
HTTPTikanga noaMahi
400URL hē, tinana rānei, ā, kāore i te wātea te hōputu.Whakatika i te tono. Whakatika anō mō ngā hōputu.
401Kī ngaro, hē, kua pau rānei, kī rānei kāore i te tika te horopaki.Tirohia te tohu ā-taha tūmau.
403Nā te ture kaipupuri whare, kaipupuri rauemi rānei i whakakore te tono.Kaua e whakatārewa i te kaupapa here. Whakapā atu ki te tautoko.
404Mahi kāore i te mōhiotia, kua pau rānei te wā.Hangaia he mahi hou mēnā e tika ana.
429Kua tae ki te taumata tono, mahi rānei e mahi ana.Whakanuia retry_after_seconds.
503Rārangi/te kaha, kāore i te wātea ā-tāea rānei te ipurangi.Whakamātauria anō me te whakahoki ā-tau me te riri.
05

Kirimana whakahaere

Ka tuku te YTSave i tētahi rahinga whakahaere i ia whakaaetanga hei tiaki i te kaihoko API me ngā ratonga pāpāho o runga.

Ka whakahaere a YTSave i te uru Schema mā te tautuhi tuatahi i te whakahohe i mua i te torotoro. Ka whai i te whakamana kua tohua, ā, ka puritia ngā āhua tono kua tuhia hei tirohanga. Tohutoro OpenAPI

WHAKAWHITI-ĀRAHI AROTAKE

Tonoa tō kī API

Tuhia te kaihoko API, tana whakapae tono ā-marama me ngā whakaritenga papa tautokona. Ka arotake a YTSave mēnā he tika te whakatau, te tuku mahi, te rua rānei i mua i te tuku i te kī ka kitea kotahi anake.

Tono uru API He āhua herea ki te kaipupuri, ka taea te whakahē, ā, ka tukuna mā te puka Whakapā. Kāore e taea e ngā tuhinga kīhini koretake te whakahaere i ngā mahi kaitiaki tikiake.