REST API DI PRODUZION · v1

Costruî scaricaments cun YTSave

Risolv un URL public di media, selezionâ un format precis, creâ un lavôr asincron e dâ il risultât firmât al to utent. La stesse pipeline di produzion vincolade al alimenta il sit web YTSave.

YTSaveClientJSON su HTTPSLavori asincronsCredenziais a scopo specific
01

Inizi svelte

YTSave al gestîs il host API prin di dut identificant i credenzials ativâts dal suport. Dopo al seguite cun un endpoint assignât al tenant e al tien in viste un percors di clam dome par il server.

URL dal tenanthttps://ytsave.app
AutenticazionX-API-Key: ys_live_…
Profil dal clientYTSaveClient
Version 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"}'

Par spiegâ la sigurece dai Credenzials, YTSave al separa la memorizzazion segrete dal server dal no incjodiment di pacjêt client. Un registr di prove nol dâs gnûf un loc propit par logs o repositoris publics.

02

Risolv un link

YTSave gestìs l'operazion Resolve identificant prime la rilevazion de sorgjente. Dopo al segûts dai formats di une URL inviade e nol tegn nissun output inventât in viste.

POST/v1/resolveAmbit: risolvi
CampTipoNecessariDescrizion
urlURL HTTPSPagjine media publiche o autorizzade par analisi.
tenantstringNoDominio dal tenant assignât. Di solit a ven omis.
{
  "success": true,
  "platform": "youtube",
  "title": "Example video",
  "formats": [
    {"id":"18","type":"video","quality":"360p","container":"mp4"}
  ],
  "cached": false
}

Par spiegâ il identificadôr dal Format, YTSave al separa il valor tornât intat dal disponibilitât par colegament. Un registr di prove nol dâs gnûf un loc propit par une etichete di qualitât stimade.

03

Crijâ e seguî un lavôr di scaricament

Par la creazion di Lavor, YTSave tacje cun une preparazion asincrone. Il so registru di prove al met in coppie cheste cun une domande HTTP curte e al finîs cun une esecuzion delimitade dal lavoradôr.

POST/v1/jobsAmbit: lavors
CampTipoNecessariDescrizion
urlURL HTTPSLa stesse sorgjente normalizade inviade par risolvi.
format_idstringUn ID esat dal rispueste di risoluzion.
tenantstringNoDominio dal tenant assignât. Di solit a ven omis.
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 AccetâtSalve job_id.
2Stât dal sondâlGET /v1/jobs/{job_id} cun la stesse ciave.
3ProntVèrzi il URL di scaricamento firmât.
StâtSignificâtAzion dal client
queuedAmess al code bounded.Fâ un vot di gnûf cun ritard.
extractingA je in cors la rinfrescade dai metadâts o dal percors.Continua a interrogar.
processingScaricant, remuxant o unî.Mostre il progres dal server.
readyIl scaricamento firmât al è disponibil.Mandi il URL al utent.
failedErôr strutturât dal terminal.Leç error_code. Provâ dome cuant che al è cunsigliât.
expiredIl risultât temporar al è stât cjatât via.Crea un gnûf lavôr.
curl https://ytsave.app/v1/jobs/JOB_ID \
  -H "X-API-Key: $YTSAVE_API_KEY"

YTSave al rend il sondâ dai Lavoris facil di scjari. La pagjine e cumence cun un spiet inizial di un second, al va a un ritorn limitât, e al dichiara clar la consegne temporarie firmade.

04

Erôrs prevedibii

Par contrat di erôr, YTSave al control un invielop no 2xx prime di un ID di domande di suport. Chest registr di prove al rend ancje clar il manegjament prevedibil dal client.

{
  "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": "…"
}
HTTPSignificât tipicAzion
400URL no valide, contenût o format no disponibil.Corregi la domande. Torne a provâ par i formâts.
401Clâf mancant, invalide, scadût o cun scope sbagliât.Verifiche la credenziali dal server.
403La politiche dal tenant o de sorgjente e je stade rifiutate la domande.No saltâ la politiche. Contate il suport.
404Lavor sconossût o scadût.Crea un lavôr gnûf se al è adeguât.
429Limite di domande o di lavôr ativ rivât.Onôr retry_after_seconds.
503Coda/capacitât o mont in su temporariman no disponibil.Riprove cun ritard esponenzial e jitter.
05

Contrât operativ

YTSave rilasce une quote operativie cun ogni aprovazion par protegî il consumadôr API e i servizis media a monte.

YTSave al gestisce l'accesso a Schema prin di dut identificant l'ativazion prime di esplorazion. Dopo al seguite cun autentificazion assignade e al tien in viste i forms di domande documentadis. Referenze OpenAPI

ACCESS REVIST DAL OPERATÔR

Domande il to cjave API

Documentâ il consumadôr API, la stime mensile di domandis e i requisits di piattaforme suportadis. YTSave al rivuarde se risolviment, sottomission di lavôr o ducj doi a son giustificâts prime di emetti un cjave visibil une volte dome.

Domande di access API I cjaves a son limitadis a un tenant, revocabils e rilasadis tramite il form di contat. I script anonims no puedin esegui il lavor di scaricament.