PRODUKTIOUN REST API · v1

Bauen Downloads mat YTSave

Léist eng ëffentlech Medien-URL op, wielt en exakte Format, erstellt eng asynchron Aufgab a gitt dem Benotzer d'ënnerschriwwen Resultat. Déiselwecht ofgegrenzte Produktiounspäifline ënnerstëtzt d'Websäit YTSave.

YTSaveClientJSON iwwer HTTPSAsynchron AarbechtenScoped Referenzen
01

Schnell Start

YTSave geréiert den API-Host andeems et als éischt support-aktivéiert Umeldungsinformatiounen identifizéiert. Duerno benotzt et en zougewiseene Tenant-Endpunkt a behält e nëmme fir de Server gëeegente Opruff-Wee am Bléck.

Locataire URLhttps://ytsave.app
AuthentifikatiounX-API-Key: ys_live_…
ClientsprofilYTSaveClient
API Versiounv1
# 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"}'

Fir d'Zertifikatsécherheet z'erklären, trennt YTSave d'Server-Säit-Geheimspäicherung vun der net an de Client-Bundle agebettter. En Beweisdokument gëtt kee fräie Logbuch oder Repository säin eegene Plaz.

02

E Link opléisen

YTSave behandelt d’Resolve-Operatioun, andeem et fir d’éischt d’Quellenerkennung identifizéiert. Duerno iwwerhëlt et d’Formater aus enger agereechter URL a behält keng erfonnte Ausgabe am Bléck.

POST/v1/resolveËmfang: opléisen
FeldTypErfuerderlechBeschreiwung
urlHTTPS URLJoËffentlech oder autoriséiert Medien Säit fir ze analyséieren.
tenantstringNeeZougewisen Tenant-Domain. Normalerweis ausgeloss.
{
  "success": true,
  "platform": "youtube",
  "title": "Example video",
  "formats": [
    {"id":"18","type":"video","quality":"360p","container":"mp4"}
  ],
  "cached": false
}

Fir de Format-Identifikator z'erklären, trennt YTSave de zréckgiwwene Wäert onverännert vun der Verfügbarkeet pro Link. En Beweis-Opzeechnung gëtt keng geroden Qualitéitsbezeechnung en eegene Plaz.

03

Erstellt an verfollegt en Download-Job

Fir d'Job-Erstellung fänkt YTSave mat asynchroner Virbereedung un. Säi Beweisprotokoll verbënnt dat mat enger kuerzer HTTP-Ufro a schléisst mat begrenzter Worker-Ausféierung of.

POST/v1/jobsËmfang: Aarbechtsplazen
FeldTypErfuerderlechBeschreiwung
urlHTTPS URLJoDéiselwecht normaliséiert Quell fir d'Léisung agereecht.
format_idstringJoEng exakt ID aus der Resolve-Antwert.
tenantstringNeeZougewisen Tenant-Domain. Normalerweis ausgeloss.
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 AkzeptéiertSpäicheren job_id.
2OfstëmmungsstatusGET /v1/jobs/{job_id} mat der selwechter Taste.
3BereetÖffnen déi ënnerschriwwen Download URL.
StatusBedeitungClient Aktioun
queuedZougelaf an d'gebonne Queue.Ëmfro nach emol mat Backoff.
extractingQuell-Metadaten oder Route ginn aktualiséiert.Fuert weider mat Polling.
processingEroflueden, remuxen oder fusionéieren.Server Fortschritt weisen.
readyËnnerschriwwen Download ass verfügbar.Sende d'URL un de Benotzer.
failedTerminal strukturéiert Feeler.Liesen error_code. Probéiert nëmmen erëm wann Dir berode gëtt.
expiredTemporär Ausgab gouf ewechgeholl.Erstellt eng nei Aarbecht.
curl https://ytsave.app/v1/jobs/JOB_ID \
  -H "X-API-Key: $YTSAVE_API_KEY"

YTSave mécht Job-Polling einfach ze iwwerblécken. D'Säit fänkt mat enger initialer Waardezäit vun enger Sekonn un, wiesselt op eng begrenzte Backoff-Strategie, a seet kloer, datt et sech ëm eng temporär ënnerschriwwe Liwwerung handelt.

04

Viraussiichtlech Feeler

Fir de Fehlkontrakt iwwerpréift YTSave eng Net-2xx-Enveloppe virun enger Support-Ufro-ID. Dëse Beweisdokument mécht och dat viraussiichtlecht Client-Handling kloer.

{
  "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": "…"
}
HTTPTypesch BedeitungAktioun
400Ongëlteg URL, Text oder net disponibelt Format.Korrigéiert d'Ufro. Erëm opléisst fir Formater.
401Schlëssel feelt, ass ongëlteg, ofgelaf oder huet de falsche Beräich.Préift d'Credential op der Server-Säit.
403D'Mieter- oder Quellpolitik huet d'Ufro refuséiert.Net d'Politik ëmgoen. Kontaktéiert de Support.
404Onbekannt oder ofgelaf Aarbecht.Schaf eng nei Aufgab wann et passend ass.
429Ufro- oder aktiv-Aarbechtslimit erreecht.Éier retry_after_seconds.
503Warteschlaang/Kapazitéit oder Upstream temporär net verfügbar.Probéiert et erëm mat exponentiellem Réckzuch an Jitter.
05

Operatiounskontrakter

YTSave gëtt mat all Geneemegung eng operationell Quote aus, fir den API-Consommateur an d'upstream Mediendéngschter ze schützen.

YTSave geréiert Schema-Zougang andeems et als éischt d'Aktivéierung identifizéiert, ier et d'Exploratioun ugeet. Et geet weider mat zougewisener Authentifikatioun a behält dokumentéiert Ufroformen am Bléck. OpenAPI Referenz

OPERATOR-REVIEWED ACCESS

Frot Ären API Schlëssel

Dokumentéiert den API-Konsument, seng monatlech Ufro-Schätzung an déi ënnerstëtzt Plattform-Ufuerderungen. YTSave iwwerpréift, ob resolve, Job-Ofginn oder béides gerechtfäerdegt sinn, ier en en eemol sichtbare Schlëssel ausgëtt.

API Zougang ufroen Schlëssele sinn tenant-scoped, revocable an ausgestallt duerch de Kontaktformular. Anonyme Skripte kënnen net Downloader Aarbecht ausféieren.