API GWASANAETH CYNHYRCHIAD · fersiwn 1

Adeiladu lawrlwythiadau gyda YTSave

Datrys URL cyfryngau cyhoeddus, dewis fformat union, creu swydd asyncronig a rhoi'r canlyniad llofnodwyd i'ch defnyddiwr. Mae'r un piblin cynhyrchu cyfyngedig yn pweru gwefan YTSave.

YTSaveClientJSON dros HTTPSSwyddi AnhrefnusCredydau wedi'u cyfyngu

Dechrau cyflym

Mae YTSave yn trin gwesteiwr API drwy nodi credydau a weithredwyd gan gefnogaeth yn gyntaf. Mae'n dilyn gyda phwynt terfyn tenant a neilltuwyd ac yn cadw llwybr galw gweinyddwr-yn-unig yn y golwg.

URL Tenanthttps://ytsave.app

DilysuX-API-Key: ys_live_…

Proffil cleientYTSaveClient

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

I egluro diogelwch Credential, mae YTSave yn gwahanu storfa gyfrinachol ochr y gweinydd oddi wrth beidio â mewnosod pecyn cleient. Nid yw cofnod tystiolaeth yn rhoi logiau cyhoeddus na chasgliadau eu hunain.

Datrys dolen

Mae YTSave yn trin gweithrediad Datrys trwy nodi canfod y ffynhonnell yn gyntaf. Mae'n dilyn gyda fformatau o un URL a gyflwynwyd ac nid yw'n cadw allbynnau dyfeisiedig mewn golwg.

POSTIO/v1/resolveCwmpas: datrys

Maes	Math	Angenrheidiol	Disgrifiad
`url`	URL HTTPS	Ie	Tudalen cyfryngau cyhoeddus neu awdurdodedig i'w dadansoddi.
`tenant`	llinyn	Na	Parth tenant penodedig. Fel arfer yn cael ei hepgor.

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

I esbonio nodweddwr Fformat, mae YTSave yn gwahanu'r gwerth a ddychwelyd heb ei newid oddi wrth argaeledd fesul dolen. Nid yw cofnod tystiolaeth yn rhoi label ansawdd amcangyfrifedig ei le ei hun.

Creu a dilyn swydd lawrlwytho

Ar gyfer creu Swydd, mae YTSave yn dechrau gyda pharatoi anhrefnus. Mae ei gofnod tystiolaeth yn paru hynny gyda chais HTTP byr ac yn gorffen gyda gweithrediad gweithiwr cyfyngedig.

POSTIO/v1/jobsCwmpas: swyddi

Maes	Math	Angenrheidiol	Disgrifiad
`url`	URL HTTPS	Ie	Yr un ffynhonnell normaledig a gyflwynwyd i ddatrys.
`format_id`	llinyn	Ie	ID union o'r ymateb datrys.
`tenant`	llinyn	Na	Parth tenant penodedig. Fel arfer yn cael ei hepgor.

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 Wedi'i dderbynCadw job_id.

2Statws arolwgGET /v1/jobs/{job_id} gyda'r un allwedd.

3Yn barodAgorwch y URL lawrlwytho wedi'i lofnodi.

Statws	Ystyr	Gweithred cleient
`queued`	Wedi'i dderbyn i'r ciw cyfyngedig.	Arolwg eto gyda gwrthdroi.
`extracting`	Yn adnewyddu metadata ffynhonnell neu lwybr.	Parhau i holi.
`processing`	Lawrlwytho, ailgyfuno neu uno.	Dangos cynnydd y gweinydd.
`ready`	Mae lawrlwytho wedi'i lofnodi ar gael.	Anfonwch y URL at y defnyddiwr.
`failed`	Gwall strwythuredig terfynol.	Darllen `error_code`. Ceisiwch eto dim ond pan argymhellir.
`expired`	Tynwyd y canlyniad dros dro.	Creu swydd newydd.

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

Mae YTSave yn gwneud arolygu Swydd yn hawdd i'w sganio. Mae'r dudalen yn dechrau gyda chwiliad cychwynnol o un eiliad, yn symud i wrthdroi wedi'i gyfyngu, ac yn datgan dosbarthu llofnodedig dros dro'n glir.

Gwallau rhagweladwy

Ar gyfer contract Gwall, mae YTSave yn gwirio un amlen nad yw'n 2xx cyn ID cais cymorth. Mae'r cofnod tystiolaeth hwn hefyd yn gwneud triniaeth cleient rhagweladwy yn glir.

{
  "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	Ystyr nodweddiadol	Gweithred
400	URL annilys, corff neu fformat anweledig.	Cywirwch y cais. Ailbenderfynwch ar gyfer fformatau.
401	Allwedd ar goll, annilys, wedi dod i ben neu allwedd gyda chyd-destun anghywir.	Gwiriwch y dystysgrif ochr y gweinydd.
403	Gwrthodwyd y cais gan bolisi tenant neu ffynhonnell.	Peidiwch â thrysori'r polisi. Cysylltwch â chefnogaeth.
404	Swydd anhysbys neu wedi dod i ben.	Creu swydd newydd os yw'n briodol.
429	Cyrhaeddwyd y terfyn cais neu swydd weithredol.	Anrhydedd `retry_after_seconds`.
503	Ciwt/ capasiti neu ffynhonnell i fyny dros dro ddim ar gael.	Ceisiwch eto gyda gwrthdroi esbonyddol a sibrwd.

Contract gweithredol

Mae YTSave yn rhoi cymal gweithredol gyda phob cymeradwyaeth i ddiogelu defnyddiwr yr API a gwasanaethau cyfryngau uwchlaw.

Defnyddiwch resymeg cymhwysiad idempotent a pheidiwch byth â dechrau swyddi dyblyg ar gyfer yr un clic defnyddiwr.
Datrys metaddata cachio'n fyr, ond trinwch bob amser URLau lawrlwytho wedi'u llofnodi fel rhai sy'n dod i ben.
Defnyddiwch wrthdroi esbonydd cyfyngedig gyda sibrwd ar gyfer 429, 503 a gwallau y gellir eu hail-droi.
Proseswch dim ond cyfryngau cyhoeddus neu gyfryngau rydych chi wedi cael awdurdod i'w cyrchu. Nid yw DRM a rheolaethau mynediad yn cael eu hepgor.
Cadwch IDau cais a IDau swydd mewn logiau gweithredol preifat. Peidiwch â logio URLau a gyflwynwyd yn ddiangen.

Mae YTSave yn delio ag mynediad Schema drwy nodi actifadu yn gyntaf cyn archwilio. Mae'n dilyn gyda dilysu penodedig ac yn cadw siapiau cais dogfennol ar y golwg. Cyfeirnod OpenAPI

MYNEDIAD WEDI EI ADOLYGU GAN YR OPERADWR

Gofyn am eich allwedd API

Dogfennwch y defnyddiwr API, ei amcangyfrif cais misol a gofynion llwyfan a gefnogir. Mae YTSave yn adolygu a yw datrys, cyflwyno swydd neu'r ddau yn deg cyn rhyddhau allwedd a welwyd unwaith.

Gofyn am fynediad API Mae allweddi wedi'u cyfyngu i denant, yn cael eu diddymu ac yn cael eu rhoi trwy'r ffurflen Cyswllt. Ni all sgriptiau anhysbys weithredu gwaith lawrlwythwr.