PRODUCTION REST API · v1

YTSave белән йөкләүләр төзү

Җәмәгать медиа URLын чишегез, төгәл формат сайлагыз, асинхрон эш булдырыгыз һәм имзаланган нәтиҗәне кулланучыга тапшырыгыз. Шул ук чикләнгән җитештерү процессы YTSave сайтына көч бирә.

YTSaveClientHTTPS аша JSONАсинхрон эшләрЧикләнгән таныклыклар

Тиз башлау

YTSave API хуҗасын беренче чиратта ярдәм активлаштырылган таныклыкларны билгеләү белән башкара. Аннан соң билгеләнгән арендачы очрагын үтәп, серверга гына чакыру юлын күзәтеп тора.

Кирәкле URLhttps://ytsave.app

АутентификацияX-API-Key: ys_live_…

Клиент профилеYTSaveClient

API версиясеv1

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

Credential куркынычсызлыгын аңлату өчен, YTSave сервер ягындагы серле саклауны клиент пакетына кертүдән аера. Дәлил язмасы үз урынын җәмәгать логлары яки репозиторийларына бирми.

Сылтаманы чишү

YTSave Чишү операциясен башта чыганакны ачыклау белән башкара. Ул бер тапшырыла торган URL форматларыннан соң килә һәм уйдырылган чыгышларны күренештә тотмый.

POST/v1/resolveКүләм: чишү

Кыр	Төре	Таләп ителә	Тасвирлама
`url`	HTTPS URL	Әйе	Анализ өчен җәмәгать яки рөхсәт ителгән медиа бит
`tenant`	юл	Юк	Билгеләнгән арендачы домены. Гадәттә кертелми.

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

Формат идентификаторын аңлату өчен, YTSave кайтарылган кыйммәтне һәр сылтама буенча мөмкинлекләрдән үзгәрешсез аера. Дәлил язмасы фаразланган сыйфат билгесенә үз урынын бирми.

Йөкләү эшен булдыру һәм күзәтү

Эш булдыру өчен, YTSave асинхрон әзерлек белән башлый. Аның доказлар язмасы моны кыска HTTP соравы белән берләштерә һәм чикләнгән эшче башкару белән тәмамлана.

POST/v1/jobsКүләм: эш урыннары

Кыр	Төре	Таләп ителә	Тасвирлама
`url`	HTTPS URL	Әйе	Чишү өчен бер үк нормалаштырылган чыганак тапшырылды.
`format_id`	юл	Әйе	Чишелеш җавабыннан төгәл ID.
`tenant`	юл	Юк	Билгеләнгән арендачы домены. Гадәттә кертелми.

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 Кабул ителдеСаклау job_id.

2Сораштыру статусыGET /v1/jobs/{job_id} шулай ук ачкыч белән.

3ӘзерИмзаланган йөкләү URL адресын ачу.

Хәл	Мәгънә	Клиент гамәле
`queued`	Чикләнгән чиратка кабул ителде.	Кире чигенү белән яңадан тавыш бирү.
`extracting`	Чыганак метадатасын яки маршрутны яңарту.	Сорау алуны дәвам итү.
`processing`	Йөкләү, ремукслау яки кушу.	Сервер үсешен күрсәтү.
`ready`	Имзаланган йөкләү мөмкинлеге бар.	URL-ны кулланучыга җибәрегез.
`failed`	Терминал структуралы хата.	Уку `error_code`. Тик киңәш ителгәндә генә кабатларга.
`expired`	Вакытлыча чыгару бетерелде.	Яңа эш булдырырга.

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

YTSave Эшне тикшерүне җиңел сканерлау өчен ясый. Бит бер секундлык башлангыч көтү белән башлана, чикләнгән артка чигенүгә күчә һәм вакытлы имзаланган тапшыруны ачык күрсәтә.

Алдан фаразланучы хаталар

Хата килешүе өчен, YTSave ярдәм соравы ID-сы алдыннан бер 2xx булмаган конвертны тикшерә. Бу дәлил язмасы клиентны алдан күрүне ачык итә.

{
  "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	Гадәти мәгънә	Хәрәкәт
400	Дөрес булмаган URL, эчтәлек яки формат юк.	Сорауны төзәтегез. Форматлар өчен яңадан чишегез.
401	Югалган, дөрес булмаган, вакыты чыккан яки дөрес булмаган даирә ачкычы.	Сервер ягыннан аутентификацияне тикшерегез.
403	Кирәкле таләпне арендачы яки чыганак сәясәте кире какты.	Сәясәтне узып китмәгез. Ярдәм хезмәте белән элемтәгә керегез.
404	Белгесез яки вакыты узган эш.	Кирәк булса яңа эш булдырыгыз.
429	Сорау яки актив эш чикләүе җитте.	Хөрмәт `retry_after_seconds`.
503	Көтү/сыйдырышлык яки югары агым вакытлыча кулланылмый.	Экспоненциаль арттыру һәм тибрәнү белән кабатлау.

Эш килешүе

YTSave һәр расланган чакта API кулланучысын һәм өске медиа хезмәтләрен саклау өчен эшләү квотасын бирә.

Идемпотент кушымта логикасын кулланыгыз һәм бер үк кулланучы басуы өчен бер үк эшләрне кабат башламагыз.
Кэшны кыска вакытка чишегез, ләкин имзаланган йөкләү URL-ларын һәрвакыт вакытлы дип карагыз.
Jitter белән бәйләнгән экспоненциаль кире кагу куллану 429, 503 һәм кабатланырга мөмкин хаталар.
Фәкать җәмәгатьчелеккә ачык булган яки сезгә керү рөхсәте бирелгән медиа белән эш итегез. DRM һәм керү контрольләре узып кителми.
Сорау IDлары һәм эш IDларын шәхси операция журналларында саклагыз. Җибәрелгән URLларны кирәксез рәвештә журналга язмагыз.

YTSave Схемага керүне башта активлаштыруны ачыклау белән башкара, аннары билгеләнгән аутентификацияне үтәп, документлаштырылган сорау формаларын күзәтеп тора. OpenAPI сылтамасы

ОПЕРАТОР ТИКШЕРГӘН КЕРҮ

API ачкычыңны сора

API кулланучысын, аның айлык сорау бәяләмәсен һәм хупланган платформа таләпләрен документлаштырыгыз. YTSave бер тапкыр күрсәтелгән ачкычны бирү алдыннан чишелеш, эш тапшыру яки икесенең дә нигезле булуын карый.

API керүен сорау Төп ачкычлар арендачыга караган, кире кагылырга мөмкин һәм Контакт формасы аша бирелә. Аноним скриптлар йөкләүче эшен башкара алмый.