PRODUKSHON REST API · v1

Krea descarga ku YTSave

Resolvé un URL di media públiko, selekshoná un formato eksakto, kreá un trabou asínkrono i duna e resultado firmá na bo usuario. E mesun pipeline di produksion limitado ta alimentá e website YTSave.

YTSaveClientJSON riba HTTPSTrabou asincrónikoKredensialnan ku limitashon
01

Komensamentu rapidu

YTSave ta maneha host di API pa kuminsá ku identifikashon di kredensialnan aktivá pa soporte. E ta sigui ku un endpoint di tenant asigná i ta mantene un ruta di yamada server solamente na bista.

URL di tenanthttps://ytsave.app
AutenticashonX-API-Key: ys_live_…
Perfil di klientYTSaveClient
Vershon 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"}'

Pa splika seguridat di Credensial, YTSave ta separá almacenamiento sekretu na server di no inkluí ningun bundel di klient. Un registro di evidencia no ta duna ningun log público òf repositorio su propio lugá.

02

Resolví un link

YTSave ta maneha operashon di Resolvé pa promé identifiká detekshon di fuente. E ta sigui ku formát for di un URL someté i no ta mantene output inventá den bista.

POST/v1/resolveAlcance: resolvé
KampoTipoRekisaDeskripshon
urlURL HTTPSSiPágina di media públiko òf autorizá pa analiza.
tenantstringNoDominio di tenant asigná. Normalmente no ta inkluí.
{
  "success": true,
  "platform": "youtube",
  "title": "Example video",
  "formats": [
    {"id":"18","type":"video","quality":"360p","container":"mp4"}
  ],
  "cached": false
}

Pa splika Identifikadó di Formato, YTSave ta separa e balor retorná sin kambia for di disponibilidad pa kada link. Un registro di evidencia no ta duna ningun label di kalidat ku ta suponé su propio lugá.

03

Krea i sigui un trabou di descarga

Pa kreashon di trabou, YTSave ta kuminsa ku preparashon asínkrono. Su rekord di evidensia ta kompará esaki ku un petishon HTTP kortiku i ta termina ku eksekushon delimitá di trabou.

POST/v1/jobsAlcance: trabou
KampoTipoRekisaDeskripshon
urlURL HTTPSSiE mesun fuente normalisá a wordu sometí pa resolvé.
format_idstringSiUn ID eksakto for di e respuesta di resolushon.
tenantstringNoDominio di tenant asigná. Normalmente no ta inkluí.
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 AceptáGuarda job_id.
2Estado di encuestaGET /v1/jobs/{job_id} ku e mesun yave.
3ListoHabri e URL di descarga firmá.
EstadoSignifikadoAccion di cliente
queuedAdmití na e cola delimitá.Hasi votashon di nobo ku retardo.
extractingTa refreskando metadato di fuente òf ruta.Sigui ku e sondeo.
processingTa descargá, remux of kombiná.Muestra progreso di server.
readyDescarga firmá ta disponibel.Manda e URL na e usuario.
failedError estructurá di terminal.error_code. Tenta di nobo solamente ora ta rekomendá.
expiredSalidanan temporal a wordu eliminá.Krea un trabou nobo.
curl https://ytsave.app/v1/jobs/JOB_ID \
  -H "X-API-Key: $YTSAVE_API_KEY"

YTSave ta hasi e sondeo di trabou fasil pa eskaneá. E página kuminsá ku un espera inicial di un segundo, pasa na un retroceso limitado, i kla ta indiká entrega temporal firmá.

04

Error ku por ta prevedí

Pa kontrakto di Error, YTSave ta kontrolá un sobre ku no ta 2xx promé di un ID di petishon di soporte. E rekord di evidensia aki tambe ta kla pa manejamentu predecibel di klient.

{
  "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": "…"
}
HTTPSignifikado típicoAccion
400URL no válido, kuerpo of formato no disponibel.Korektá e petishon. Resolvé di nobo pa formáto.
401Yave falta, inválido, caduká òf ku un ámbito inkorekt.Kontrolá e kredensial na server.
403Polisianan di tenant òf fuente a rejehá e petishon.No pasa riba e polítika. Kontakto soporte.
404Trabou no konosí of kaduKrea un trabou nobo si ta apropia.
429Límite di petishon òf trabou aktivo a yega.Honra retry_after_seconds.
503Fila/kapasidat òf upstream temporalmente no ta disponibel.Tenta di nobo ku un retraso eksponensial i jitter.
05

Kontrakt operacional

YTSave ta duna un kuota operashonal ku kada aprobashon pa protehá e konsumer API i e servisio di media riba e nivel ariba.

YTSave ta maneha akseso di Schema pa primé identifiká aktivashon promé ku eksplorashon. E ta sigui ku autentikashon asigná i ta mantene forma di petishon dokumentá den bista. Referensia OpenAPI

ACCESO REVISÁ PA OPERADOR

Pidi bo yave API

Dokumentá e konsumer di API, su estimashon di petishon mensual i e rekisito di plataforma soportá. YTSave ta revisá si resolvé, sumishon di trabou òf dos ta justifiká promé ku ta emité un yave ku tabata bista un biaha.

Pidi acceso API E llave ta limitado pa tenant, por wordu revoká i ta duna via e formulario di Kontakt. Script anónimo no por hasi trabou di downloader.