PRODUCTION REST API · v1

Gina saukewa tare da YTSave

Warware URL na kafofin watsa labarai na jama'a, zaɓi madaidaicin tsari, ƙirƙiri aikin asynchronous kuma ba da sakamakon da aka sanya hannu ga mai amfani da kai. Hanyar samarwa mai iyaka iri ɗaya ce ke ƙarfafa gidan yanar gizon YTSave.

YTSaveClientJSON ta HTTPSAyyuka marasa lokaci ɗayaTakardun shaida masu iyaka
01

Fara sauri

YTSave yana sarrafa mai masaukin API ta hanyar gano takardun shaida da aka kunna tallafi da farko. Yana bi da ƙarshen mai haya da aka sanya kuma yana riƙe hanyar kiran uwar garke kawai a gani.

URL ɗin mai hayahttps://ytsave.app
TabbatarwaX-API-Key: ys_live_…
Bayanan abokin cinikiYTSaveClient
Sigogin 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"}'

Don bayyana Tsaron Shaida, YTSave yana raba ajiya sirri na ɓangaren uwar garke daga rashin haɗa kayan abokin ciniki. Rikodin shaida baya ba da wurin rajistan jama'a ko ma'ajiyar bayanai.

02

Warware mahaɗi

YTSave yana sarrafa aikin Warwarewa ta hanyar fara gano gano tushen. Yana bi da tsarin daga URL ɗaya da aka gabatar kuma baya riƙe da fitarwa da aka ƙirƙira a cikin duba.

POST/v1/resolveIyakar aiki: warware
FilinNau'iAna BukataBayani
urlHTTPS URLIShafin kafofin watsa labarai na jama'a ko na izini don nazari.
tenantkirtaniA'aAn sanya yankin mai haya. Yawanci ana cire shi.
{
  "success": true,
  "platform": "youtube",
  "title": "Example video",
  "formats": [
    {"id":"18","type":"video","quality":"360p","container":"mp4"}
  ],
  "cached": false
}

Don bayyana mai gano Tsari, YTSave yana raba ƙimar da aka dawo ba tare da canji daga samuwar haɗin kai ba. Rikodin shaida baya ba da alamar inganci da aka hango wuri na kansa.

03

Ƙirƙiri kuma bi aikin saukarwa

Don ƙirƙirar Aiki, YTSave yana farawa da shiri mara lokaci. Rikodin shaidarsa yana haɗa wannan da gajeren buƙatar HTTP kuma yana ƙarewa da aiwatar da ma'aikaci mai iyaka.

POST/v1/jobsFage: ayyuka
FilinNau'iAna BukataBayani
urlHTTPS URLIAn gabatar da tushen da aka daidaita don warwarewa.
format_idkirtaniIID ɗin daidai daga amsar warwarewa.
tenantkirtaniA'aAn sanya yankin mai haya. Yawanci ana cire shi.
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 An karɓaAjiye job_id.
2Matsayin zaɓeGET /v1/jobs/{job_id} tare da mabuɗin iri ɗaya.
3ShiryeBude adireshin saukar da fayil mai sa hannu.
MatsayiMa'anaAikin abokin ciniki
queuedAn amince da shi cikin jerin iyaka.Yi zaɓe sake tare da jinkiri.
extractingAna sabunta bayanan tushe ko hanyar.Ci gaba da tambaya.
processingAna saukewa, sake haɗawa ko haɗawa.Nuna ci gaban uwar garke.
readySaukar da fayil mai sa hannu yana samuwa.Aika URL ɗin zuwa ga mai amfani.
failedKuskuren tsari na tashar jiragen ruwa.Karanta error_code. Sake gwadawa ne kawai idan an ba da shawara.
expiredAn cire fitarwa na ɗan lokaci.Ƙirƙiri sabon aiki.
curl https://ytsave.app/v1/jobs/JOB_ID \
  -H "X-API-Key: $YTSAVE_API_KEY"

YTSave yana sauƙaƙa duba aikin Job. Shafin yana farawa da jiran dakika ɗaya na farko, yana matsawa zuwa jinkirin da aka iyakance, kuma yana bayyana a fili isarwa ta wucin gadi da aka sanya hannu.

04

Kuskuren da za a iya hasashe

Don kwangilar Kuskure, YTSave yana duba akwatin wasiƙa ɗaya wanda ba na 2xx ba kafin ID na buƙatar tallafi. Wannan rikodin shaida yana kuma bayyana sarrafa abokin ciniki da aka tsara.

{
  "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": "…"
}
HTTPMa'anar al'adaAiki
400URL mara inganci, jiki ko tsarin da ba a samu ba.Gyara buƙatar. Sake warware don tsarukan.
401Mabuɗin da ya ɓace, mara inganci, ya ƙare ko mara daidai da iyaka.Duba takardun shaidar uwar garken.
403Manufar mai haya ko tushen ta ƙi buƙatar.Kada ku kauce wa manufar. Tuntuɓi goyon baya.
404Aikin da ba a sani ba ko wanda ya ƙare.Ƙirƙiri sabon aiki idan ya dace.
429An kai iyakar buƙata ko aikin da ke aiki.Girmama retry_after_seconds.
503Jeri/ƙarfin ko sama ba a samuwa na ɗan lokaci.Sake gwadawa tare da jinkirin exponential da jitter.
05

Kwantaragin aiki

YTSave yana bayar da ƙayyadadden aiki tare da kowane amincewa don kare mai amfani da API da sabis na kafofin watsa labarai na sama.

YTSave yana sarrafa samun damar Tsarin ta hanyar gano kunnawa kafin bincike. Yana bi da tabbatarwa da aka ba da izini kuma yana kiyaye siffofin buƙatun da aka rubuta a gani. Ma'anar OpenAPI

SAMUN DA AKA DUBA TA MAI AIKI

Nemi maɓallin API ɗinka

Rubuta mai amfani da API, kimanin buƙatun sa na wata-wata da bukatun dandamali da aka tallafa. YTSave yana duba ko warwarewa, gabatar da aiki ko duka biyun sun dace kafin bayar da maɓalli da aka gani sau ɗaya.

Nemi damar API Maɓallan suna da iyaka ga mai haya, ana iya soke su kuma ana bayar da su ta hanyar fom ɗin Tuntuɓi. Ba za a iya aiwatar da ayyukan mai sauke fayil ta rubutun ba tare da suna ba.