FRAMLEIÐSLU REST API · v1

Bygg niðurstøður við YTSave

Loyst ein almennan miðlavevslóð, vel eitt nágreiniligt snið, skapa eitt asynkront arbeiði og handa undirskrivaða úrslitið til brúkaran. Sama avmarkaða framleiðslulínan drivur YTSave heimasíðuna.

YTSaveClientJSON yvir HTTPSAsynkrón arbeiðiAvmarkaðar loyvir

Skjótt byrjan

YTSave handfar API-vertin við fyrst at eyðkenna stuðulsvirkað viðurkenningargögn. Hann fylgir við ein úthildnan leigaraendapunkt og heldur einari bert servara-kalli leið í sjón.

Leigari URLhttps://ytsave.app

ViðurkenningX-API-Key: ys_live_…

KundaprofílurYTSaveClient

API útgávav1

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

At greiða frá Trygd fyri innskráning, skilur YTSave millum loyndarmál goymslu á servara síðuni og onga innbygging í klient pakkum. Ein prógvskrá gevur ongar almennar dagføringar ella goymslur sítt egna pláss.

Loyst eina leinkju

YTSave handfer Loysnarvirksemið við fyrst at eyðmerkja kelduupptøku. Hon fylgir við sniðum frá einum innsendum URL og heldur ongar ímyndaðar úttøkur í skíggjanum.

POST/v1/resolveUmfang: loysa

Øki	Slag	Nauðsynligt	Lýsing
`url`	HTTPS URL	Ja	Almenn ella góðkend miðlaportal at greina.
`tenant`	strengur	Nei	Útvald leigjariøki. Vanliga útloyst.

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

At greiða frá Formát kennara, skilur YTSave tann vardi virðið óbroytt frá per-leinkju tøkniligari atgongd. Ein prógvsskrá gevur ongan giskaðan góðsku merki sítt egna pláss.

Stovna og fylgja einum niðurhalisverkætlan

Fyri at skapa arbeiði byrjar YTSave við asynkrónari fyrireiking. Bevisupptøkan hjá tí parar tað við eina stutta HTTP-umbøn og endar við avmarkaðari arbeiðsframførslu.

POST/v1/jobsUmfang: arbeiði

Øki	Slag	Nauðsynligt	Lýsing
`url`	HTTPS URL	Ja	Sama normeraða upprunin sendur inn til at loysa.
`format_id`	strengur	Ja	Eitt nágreiniligt ID frá svarinum frá resolve.
`tenant`	strengur	Nei	Útvald leigjariøki. Vanliga útloyst.

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

2KanningarstøðaGET /v1/jobs/{job_id} við sama lykli.

3KlárurOpna undirskrivaða niðurhal URL-in.

Støða	Merking	Kundahandling
`queued`	Innritaður í avmarkaða raðfylgju.	Kanna aftur við afturhaldi.
`extracting`	Endurnýggja upprunaliga metadata ella leið	Halda áfram at kanna.
`processing`	Niðurhal, remux ella samanseting.	Vís framgongd á servaranum.
`ready`	Undirskrivað niðurhal er tøkt.	Send URL-in til brúkaran.
`failed`	Terminalstruktureraður feilur.	Les `error_code`. Royn aftur bert tá ráðlagt verður.
`expired`	Bráðfeingis úttak varð tikið burtur.	Stovna eitt nýtt arbeiði.

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

YTSave ger Job polling lætt at skanna. Síðan byrjar við ein-sekunds byrjanarventi, fer víðari til takmarkaða afturhald, og greiður frá bráðabirgda undirskrivaðari levering.

Fyrireikaðar villur

Fyri Error contract, kannar YTSave eina ikki-2xx umbúð áðrenn stuðulsumsóknar ID. Hetta prógvsskráseting ger eisini fyrisigandi viðgerð hjá klientinum greiða.

{
  "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	Vanlig týdning	Rokning
400	Ógyldigur URL, innihald ella ófáanligur format.	Rættið fyrispurningin. Royn aftur fyri snið.
401	Manglandi, ólóglig, útrunnin ella skeivur rávur.	Kanna server-enda loyniorð.
403	Leigari ella keldustýring avvísti fyrispurningin.	Far ikki framvið reglunum. Set teg í samband við stuðul.
404	Ókendur ella útrunnin uppgáva.	Stovna eitt nýtt arbeiði um tað er hóskandi.
429	Fyrimunur á fyrispurningum ella virknu arbeiði er náddur.	Heiður `retry_after_seconds`.
503	Biilur/kapasitetur ella uppstreymur er brádliga ikki tøkur.	Royn aftur við eksponentiellari afturgongd og óregluligheit.

Rakstraravtala

YTSave gevur eitt virkandi kvotu við hvørjum góðkenning fyri at verja API brúkaran og miðla tænastur uppstrímmar.

Brúka idempotent umsóknarlogikk og byrja ongantíð dupult arbeiði fyri sama brúkara-klikk.
Goym metadata stuttvarandi, men viðgerð altíð undirskrivaðar niðurhal URL-slóðir sum at tær ganga út.
Brúka avmarkaða eksponentiella afturgongd við jitter til 429, 503 og feilir, sum kunnu roknast um aftur.
Viðgerð bert almennan miðil ella miðil, tú hevur loyvi atgongd til. DRM og atgongdarskipanir verða ikki kringgingnar.
Halt fyrispurnings-ID og arbeiðs-ID í privatum rakstrarloggum. Logga ikki innsendar URL-adrssur óneyðugt.

YTSave handfar Schema-atgongd við fyrst at eyðkenna virking áðrenn kanning. Hann fylgir við úthildnum sannprógvi og heldur skrásettar fyrispurningsformar í sjón. OpenAPI viðmerking

FÁSTUÐUR AV OPERATORI

Hevja tín API lykil

Dokumentera API brúkaran, mánaðarliga fyrimynd av fyrispurningum og stuðlaðar pallkrøv. YTSave metir um loysn, arbeiðsinnlegging ella bæði eru rættvís, áðrenn ein einaferð sjónligur lykil verður útgivin.

Bið um API atgongd Lyklarnir eru leigutakara-avmarkaðir, afturkallandi og útfluttir gjøgnum Kontaktformulin. Anonymir skriptar kunnu ikki framføra niðurhalararbeiði.