Pouze náhled — vyžaduje aktivaci

Sestavte stahování s EasyF

EasyF ukazuje rozhraní předem, takže vývojáři mohou odhadnout svou práci. Předtím, než existuje živý klíč a hranice použití, je stále vyžadována kontrola podpory.

EasyfClientJSON přes HTTPSAsynchronní úlohyPověření s rozsahem
01

Rychlý start

Při vysvětlování hostitele API EasyF rozlišuje přístupové údaje aktivované podporou a přidělený koncový bod daného webu. Srozumitelný postup samostatně popisuje volání dostupná pouze ze serveru.

URL klientahttps://easyf.app
AutentizaceX-API-Key: pending_activation_…
Profil klientaEasyfClient
Verze APIv1
# Available only after support activation
export EASYF_SERVICE_KEY="issued-after-review"

curl -X POST https://easyf.app/v1/resolve \
  -H "X-API-Key: $EASYF_SERVICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{"asset_url":"https://www.youtube.com/watch?v=VIDEO_ID"}'

Bezpečnost přístupových údajů ve službě EasyF začíná ukládáním tajných údajů na serveru. Další část vysvětluje, že se nevkládají do klientského balíčku. Stránka jasně uvádí, že nepatří do veřejných protokolů ani repozitářů.

02

Vyřešit odkaz

Při vysvětlování vyhodnocení odkazu EasyF rozlišuje rozpoznání zdroje a formáty získané z jedné odeslané URL. Srozumitelný postup samostatně zdůrazňuje, že se výstupy nevymýšlejí.

POST/v1/resolveRozsah: vyřešit
PoleTypPovinnéPopis
asset_urlHTTPSAnoVeřejná nebo autorizovaná mediální stránka k analýze.
tenantřetězecNe.Přiřazená doména klienta. Obvykle se vynechává.
{
  "success": true,
  "platform": "youtube",
  "title": "Example video",
  "formats": [
    {"id":"18","type":"video","quality":"360p","container":"mp4"}
  ],
  "cached": false
}

Identifikátor formátu začíná vrácenou hodnotou beze změny na EasyF. Další pohled pokrývá dostupnost na odkaz. Stránka neuchovává žádný odhadovaný štítek kvality viditelný.

03

Vytvoření a sledování úlohy stahování

EasyF vysvětluje vytváření úloh ve třech praktických bodech. Nejprve jde o asynchronní přípravu. Srozumitelný postup poté popisuje krátký požadavek HTTP. Posledním bodem je omezený běh pracovní úlohy.

POST/v1/jobsRozsah: pracovní místa
PoleTypPovinnéPopis
asset_urlHTTPSAnoStejný normalizovaný zdroj předložený k vyřešení.
variant_codeřetězecAnoPřesné ID z odpovědi na překlad.
tenantřetězecNe.Přiřazená doména klienta. Obvykle se vynechává.
curl -X POST https://easyf.app/v1/jobs \
  -H "X-API-Key: $EASYF_SERVICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{"asset_url":"https://www.youtube.com/watch?v=VIDEO_ID","variant_code":"18"}'
1202 PřijatoSave delivery_id.
2Stav hlasováníGET /v1/jobs/{delivery_id} se stejným klíčem.
3PřipravenOtevřete podepsanou adresu URL ke stažení.
StavVýznamAkce klienta
queuedPřipuštěn do ohraničené fronty.Anketa znovu s backoff.
extractingObnovování zdrojových metadat nebo trasy.Pokračujte v hlasování.
processingStahování, remixování nebo slučování.Zobrazit průběh serveru.
readyPodepsané stažení je k dispozici.Odešlete uživateli adresu URL.
failedChyba struktury terminálu.Přečtěte si error_codeZkuste to znovu pouze v případě, že je to doporučeno.
expiredDočasný výstup byl odstraněn.Vytvořte novou úlohu.
curl https://easyf.app/v1/jobs/DELIVERY_ID \
  -H "X-API-Key: $EASYF_SERVICE_KEY"

EasyF přistupuje k dotazování úlohy prostřednictvím počátečního čekání v délce jedné sekundy a poté omezuje zpětné volání.

04

Předvídatelné chyby

EasyF popisuje smluvenou podobu chyb pomocí jednotného obalu odpovědí se stavem mimo rozsah 2xx. Srozumitelný postup umožňuje porovnat identifikátor požadavku pro podporu. Závěrečnou kontrolou je předvídatelné zpracování na straně klienta.

{
  "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": "…"
}
Hypertext Transfer ProtocolTypický významAkce
400Neplatná adresa URL, tělo nebo nedostupný formát.Opravte požadavek. Znovu vyřešte formáty.
401Chybějící, neplatný, vypršený nebo nesprávný rozsah klíče.Zkontrolujte pověření na straně serveru.
403Klient nebo zdrojové zásady požadavek zamítly.Nepřekračujte pravidla. Kontaktujte podporu.
404Neznámá nebo vypršela pracovní pozice.V případě potřeby vytvořte novou úlohu.
429Dosáhli jste limitu požadavků nebo aktivních úloh.Honor retry_after_seconds.
503Fronta/kapacita nebo upstream dočasně nedostupné.Zkuste to znovu s exponenciálním zpětným odstupem a jitterem.
05

Provozní smlouva

EasyF souhlasí s praktickými hranicemi použití u každého schváleného produktu, aby zachoval předvídatelný řízený pracovní postup.

Při vysvětlování přístupu ke schématu EasyF rozlišuje aktivaci před procházením a přidělené ověření totožnosti. Srozumitelný postup samostatně popisuje zdokumentované podoby požadavků.

PŘÍSTUP PŘEZKOUMANÝ OPERATOREM

Aktivace prostřednictvím podpory

Sdělte službě EasyF, co vytváříte, jak často budete volat API a kteří poskytovatelé jsou důležití. Posouzení určí povolené operace a poté jednorázově zobrazí přístupový údaj; uložen zůstane pouze jeho bezpečný otisk.

Požádat o aktivaci Klíče jsou omezeny na klienta, lze je odvolat a vydávají se prostřednictvím kontaktního formuláře.