REST API HANA · v1

Hana i nā hoʻoiho me YTSave

Hoʻoponopono i kahi URL media lehulehu, koho i kahi ʻano pololei, hana i kahi hana asynchronous a hāʻawi i ka hopena i hōʻailona ʻia i kāu mea hoʻohana. Hoʻomalu ʻia ka laina hana hana paʻa like e ka pūnaewele YTSave.

YTSaveClientJSON ma luna o ka HTTPSNā hana AsynchronousNā palapala hōʻoia i kau ʻia
01

Hoʻomaka wikiwiki

Hoʻokō ʻo YTSave i ka mana API ma ka ʻike mua ʻana i nā palapala hōʻoia i hoʻoikaika ʻia e ke kākoʻo. Hoʻomau ia me kahi kikowaena tenant i hāʻawi ʻia a mālama i ke ala kelepona server-wale i ka nānā ʻana.

URL Keleponahttps://ytsave.app
HoʻomaikaʻiX-API-Key: ys_live_…
ʻIkepili mea kūʻaiYTSaveClient
Mana 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"}'

No ka wehewehe ʻana i ka palekana Credential, hoʻokaʻawale ʻo YTSave i ka mālama huna ma ka ʻaoʻao kikowaena mai ka ʻole o ka hoʻokomo pū ʻana i ka pūʻulu mea kūʻai. ʻAʻole hāʻawi ka moʻolelo hōʻike i nā log lehulehu a i ʻole nā waihona i kahi kūlana kūʻokoʻa.

02

Hoʻoponopono i ka loulou

Hoʻolālā ʻo YTSave i ka hana Hoʻoponopono ma ka ʻike mua ʻana i ka ʻike kumu. Hoʻomau ia me nā ʻano mai kahi URL i hoʻouna ʻia a mālama ʻole i nā hopena i manaʻo ʻia i ka nānā ʻana.

HOʻOKUʻU/v1/resolveKālepa: hoʻoponopono
KumuʻAnoPonoHōʻike
urlURL HTTPSʻAeʻAoʻao lehulehu a i ʻole ʻae ʻia no ka loiloi ʻana.
tenantʻŌleloʻAʻoleMauka inoa ʻāina tenant i hāʻawi ʻia. Hoʻopau pinepine ʻia.
{
  "success": true,
  "platform": "youtube",
  "title": "Example video",
  "formats": [
    {"id":"18","type":"video","quality":"360p","container":"mp4"}
  ],
  "cached": false
}

No ka wehewehe ʻana i ka mea ʻike ʻano, hoʻokaʻawale ka YTSave i ka waiwai i hoʻihoʻi ʻia me ka ʻole o ka loli mai ka loaʻa ʻana o kēlā me kēia loulou. ʻAʻole hāʻawi ka moʻolelo hōʻike i kahi hōʻailona maikaʻi i manaʻo ʻia i kona wahi ponoʻī.

03

E hana a hahai i kahi hana hoʻoiho

No ka hana ʻana i ka hana, hoʻomaka ka YTSave me ka hoʻomākaukau asynchronous. Hoʻokaʻawale kāna moʻolelo hōʻike me kahi noi HTTP pōkole a pau me ka hoʻokō ʻana o ka limahana i kaupalena ʻia.

HOʻOKUʻU/v1/jobsKālepa: nā hana
KumuʻAnoPonoHōʻike
urlURL HTTPSʻAeʻO ka kumu maʻamau like i hoʻouna ʻia e hoʻoponopono.
format_idʻŌleloʻAeHe ID pololei mai ka pane hoʻoponopono.
tenantʻŌleloʻAʻoleMauka inoa ʻāina tenant i hāʻawi ʻia. Hoʻopau pinepine ʻia.
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 Ua ʻae ʻiaHoʻopālahalaha job_id.
2Kūlana noiʻiGET /v1/jobs/{job_id} me ka kī like.
3MākaukauE wehe i ka URL hoʻoiho i hōʻailona ʻia.
KūlanaʻIkepiliHana mea kūʻai
queuedUa ʻae ʻia i ka laina paʻa.Nīnau hou me ka hoʻihoʻi ʻana.
extractingKe hoʻomaikaʻi nei i ka ʻike kumu a i ʻole ke ala.E hoʻomau i ka nīnau ʻana.
processingKe hoʻoiho nei, ke hoʻohui ʻana a i ʻole ke hoʻohui pū ʻana.hōʻike i ka holomua kikowaena.
readyLoaʻa ka hoʻoiho i hōʻailona ʻia.E hoʻouna i ka URL i ka mea hoʻohana.
failedHe hewa kūkulu ʻia ma ka terminal.Heluhelu error_code. E hoʻāʻo hou wale nō i ka wā i ʻōlelo ʻia ai.
expiredUa hoʻokuʻu ʻia ka hopena manawa pōkole.E hana i kahi hana hou.
curl https://ytsave.app/v1/jobs/JOB_ID \
  -H "X-API-Key: $YTSAVE_API_KEY"

Hoʻolālā maʻalahi ʻo YTSave i ka nīnau hana. Hoʻomaka ka ʻaoʻao me ka kali mua he hoʻokahi kekona, hele i ka hoʻihoʻi hope i kaupalena ʻia, a hōʻike maopopo i ka lawe ʻana i kau inoa manawa pōkole.

04

Nā hewa hiki ke manaʻo ʻia

No ka pilikia Error contract, nānā ʻo YTSave i hoʻokahi ʻeke ʻole 2xx ma mua o kahi ID noi kākoʻo. Hoʻopuka pū kēia moʻolelo hōʻike i ka maʻalahi o ka mālama ʻana o ka mea kūʻai.

{
  "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": "…"
}
HTTPKa manaʻo maʻamauKānalua
400URL hewa, kino a i ʻole ʻano ʻole i loaʻa.Hoʻoponopono i ka noi. E hoʻoponopono hou no nā ʻano.
401Kāleka hāhai ʻole, hewa, pau ka manawa, a i ʻole he kiʻina hewa.Nānā i ka palapala hōʻoia ʻaoʻao kikowaena.
403Ua ʻae ʻole ka ʻaoʻao ʻāina a i ʻole ka kumu noi.Mai ʻoi aku ma luna o ke kānāwai. Hoʻokaʻaʻike i ke kākoʻo.
404ʻAʻohe ʻike i ka hana a i ʻole ua pau ka manawa.E hana i kahi hana hou inā kūpono.
429Ua piʻi ka palena noi a i ʻole ka hana hana.Hoʻohanohano retry_after_seconds.
503ʻAʻole loaʻa ka laina/ka hiki a i ʻole ka ʻoi aku ma luna i kēia manawa.Hoʻāʻo hou me ka hoʻihoʻi ʻoi aku a me ka ʻāwīwī.
05

Kontrak hana

Hoʻolako ka YTSave i kahi palena hana me kēlā me kēia ʻae ʻana e pale i ka mea hoʻohana API a me nā lawelawe media luna.

Hoʻokō ka YTSave i ke komo ʻana i ka Schema ma ka ʻike mua ʻana i ka hoʻouka ʻana ma mua o ka nānā ʻana. Hoʻolaha OpenAPI

KĀWILI HOʻOKĀKĀWAI ʻia e ka mea hana

Nīnau i kāu kī API

Hoʻopaʻa i ka mea ʻai API, kāna manaʻo noi mahina a me nā koi papahana i kākoʻo ʻia. Hoʻāʻo ʻo YTSave inā pono ke hoʻoponopono, ka hoʻouna ʻana i ka hana a i ʻole ʻelua ma mua o ka hāʻawi ʻana i kahi kī i ʻike ʻia hoʻokahi manawa.

Nīnau i ke komo ʻana i ka API Hoʻopili ʻia nā kī i ka pae tenant, hiki ke hoʻopau ʻia a hāʻawi ʻia ma o ka puka leka uila. ʻAʻole hiki i nā palapala inoa ʻole ke holo i ka hana hoʻoiho.