PRODUKSIE REST API · v1

Bou aflaaie met YTSave

Los 'n openbare media-URL op, kies 'n presiese formaat, skep 'n asynchrone taak en gee die ondertekende resultaat aan jou gebruiker. Dieselfde beperkte produksiepyplyn dryf die YTSave-webwerf aan.

YTSaveClientJSON oor HTTPSAsinkrone takeGeskaalde geloofsbriewe

Vinnige begin

YTSave hanteer API-gasheer deur eers ondersteunings-geaktiveerde geloofsbriewe te identifiseer. Dit volg met 'n toegewese huurder-eindpunt en hou 'n serser-slegs oproeppad in sig.

Huurder URLhttps://ytsave.app

VerifikasieX-API-Key: ys_live_…

KliëntprofielYTSaveClient

API weergawev1

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

Om Kredensiaalveiligheid te verduidelik, skei YTSave bediener-kant geheime berging van geen kliëntbundel-inbedding nie. 'n Bewysrekord gee geen openbare logboeke of bewaarplekke 'n eie plek nie.

Los 'n skakel op

YTSave hanteer Oplos-operasie deur eers bronopsporing te identifiseer. Dit volg met formate van een ingedien URL en hou geen uitgevonde uitsette in sig nie.

POS/v1/resolveBestek: oplos

Veld	Tipe	Vereis	Beskrywing
`url`	HTTPS-URL	Ja	Openbare of gemagtigde media bladsy om te ontleed.
`tenant`	string	Nee	Toegewese huurderdomein. Gewoonlik weggelaat.

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

Om Formaatidentifiseerder te verduidelik, skei YTSave die teruggegewe waarde onveranderd van per-skakel beskikbaarheid. 'n Bewysrekord gee geen geraamde kwaliteitslabel sy eie plek nie.

Skep en volg 'n aflaai-taak

Vir Taak skepping begin YTSave met asynchrone voorbereiding. Sy bewysrekord koppel dit met 'n kort HTTP-versoek en eindig met beperkte werkeruitvoering.

POS/v1/jobsBestek: werke

Veld	Tipe	Vereis	Beskrywing
`url`	HTTPS-URL	Ja	Dieselfde genormaliseerde bron ingedien om op te los.
`format_id`	string	Ja	’n Presiese ID van die oplosrespons.
`tenant`	string	Nee	Toegewese huurderdomein. Gewoonlik weggelaat.

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

2PeilingstatusGET /v1/jobs/{job_id} met dieselfde sleutel.

3GereedMaak die ondertekende aflaai-URL oop.

Status	Betekenis	Kliëntaksie
`queued`	Toegelaat tot die beperkte waglys.	Stem weer met terugslag.
`extracting`	Verfris bron metadata of roete.	Gaan voort met peiling.
`processing`	Laai af, remux of voeg saam.	Vertoon bediener vordering.
`ready`	Ondertekende aflaai is beskikbaar.	Stuur die URL na die gebruiker.
`failed`	Terminal gestruktureerde fout.	Lees `error_code`. Probeer weer slegs wanneer dit aanbeveel word.
`expired`	Tydelike uitvoer is verwyder.	Skep 'n nuwe taak.

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

YTSave maak Taakpolling maklik om te skandeer. Die blad begin met 'n een-sekonde aanvanklike wag, beweeg na gekapte terugslag, en dui duidelik tydelike ondertekende aflewering aan.

Voorspelbare foute

Vir Foutkontrak, kontroleer YTSave een nie-2xx koevert voor 'n ondersteuningsversoek-ID. Hierdie bewysrekord maak ook voorspelbare kliënthantering duidelik.

{
  "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	Tipiese betekenis	Aksie
400	Ongeldige URL, liggaam of onbeskikbare formaat.	Korrigeer die versoek. Los weer op vir formate.
401	Ontbrekend, ongeldig, verval of verkeerde omvang sleutel.	Kontroleer die bediener-kant geloofsbrief.
403	Huurder- of bronpolis het die versoek verwerp.	Moet nie die beleid omseil nie. Kontak ondersteuning.
404	Onbekende of vervalde taak.	Skep 'n nuwe taak indien toepaslik.
429	Versoek- of aktiewe taaklimiet bereik.	Eer `retry_after_seconds`.
503	Ry/kapasiteit of opwaartse stroom tydelik onbeskikbaar.	Probeer weer met eksponensiële terugslag en variasie.

Operasionele kontrak

YTSave gee 'n operasionele kwota uit met elke goedkeuring om die API-verbruiker en opstroom-media-dienste te beskerm.

Gebruik idempotente toepassingslogika en begin nooit duplikaat take vir dieselfde gebruikerkliek nie.
Kas oplos metadata kortliks, maar behandel altyd ondertekende aflaai-URL's as verval.
Gebruik beperkte eksponensiële terugslag met jitter vir 429, 503 en herhaalbare foute.
Verwerk slegs openbare media of media waartoe jy gemagtig is om toegang te hê. DRM en toegangsbeheer word nie omseil nie.
Hou versoek-ID's en taak-ID's in privaat operasionele logboeke. Moet nie ingediende URL's onnodig log nie.

YTSave hanteer Skema-toegang deur eers aktivering te identifiseer voordat verkenning plaasvind. Dit volg met toegekende verifikasie en hou gedokumenteerde versoekvorms in sig. OpenAPI verwysing

OPERATEUR-GEËVALUEERDE TOEGANG

Vra jou API-sleutel aan

Dokumenteer die API-verbruiker, sy maandelikse versoekskatting en ondersteunende platformvereistes. YTSave hersien of oplos, taakindiening of albei geregverdig is voordat 'n eenmalige sigbare sleutel uitgereik word.

Versoek API-toegang Sleutels is huurder-geskop, herroepbaar en word deur die Kontakvorm uitgereik. Anonieme skripte kan nie aflaaiwerk uitvoer nie.