https://easyf.appSestavte 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.
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.
X-API-Key: pending_activation_…EasyfClientv1# 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ářů.
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í.
/v1/resolveRozsah: vyřešit| Pole | Typ | Povinné | Popis |
|---|---|---|---|
asset_url | HTTPS | Ano | Veřejná nebo autorizovaná mediální stránka k analýze. |
tenant | řetězec | Ne. | 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ý.
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.
/v1/jobsRozsah: pracovní místa| Pole | Typ | Povinné | Popis |
|---|---|---|---|
asset_url | HTTPS | Ano | Stejný normalizovaný zdroj předložený k vyřešení. |
variant_code | řetězec | Ano | Přesné ID z odpovědi na překlad. |
tenant | řetězec | Ne. | 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"}'delivery_id.GET /v1/jobs/{delivery_id} se stejným klíčem.| Stav | Význam | Akce klienta |
|---|---|---|
queued | Připuštěn do ohraničené fronty. | Anketa znovu s backoff. |
extracting | Obnovování zdrojových metadat nebo trasy. | Pokračujte v hlasování. |
processing | Stahování, remixování nebo slučování. | Zobrazit průběh serveru. |
ready | Podepsané stažení je k dispozici. | Odešlete uživateli adresu URL. |
failed | Chyba struktury terminálu. | Přečtěte si error_codeZkuste to znovu pouze v případě, že je to doporučeno. |
expired | Doč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í.
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 Protocol | Typický význam | Akce |
|---|---|---|
| 400 | Neplatná adresa URL, tělo nebo nedostupný formát. | Opravte požadavek. Znovu vyřešte formáty. |
| 401 | Chybějící, neplatný, vypršený nebo nesprávný rozsah klíče. | Zkontrolujte pověření na straně serveru. |
| 403 | Klient nebo zdrojové zásady požadavek zamítly. | Nepřekračujte pravidla. Kontaktujte podporu. |
| 404 | Neznámá nebo vypršela pracovní pozice. | V případě potřeby vytvořte novou úlohu. |
| 429 | Dosáhli jste limitu požadavků nebo aktivních úloh. | Honor retry_after_seconds. |
| 503 | Fronta/kapacita nebo upstream dočasně nedostupné. | Zkuste to znovu s exponenciálním zpětným odstupem a jitterem. |
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.
- Používejte idempotentní aplikační logiku a nikdy nespouštějte duplicitní úlohy pro stejné uživatelské kliknutí.
- Cache krátce vyřeší metadata, ale vždy považuje podepsané adresy URL ke stažení za vypršení platnosti.
- Použijte ohraničený exponenciální backoff s jitter pro
429,503a opakovatelné chyby. - Zpracovávejte pouze veřejná média nebo média, ke kterým máte oprávnění. DRM a přístupová omezení nejsou obcházena.
- ID požadavků a ID úloh uchovávejte v soukromých provozních protokolech. Nezapisujte do protokolů odeslané adresy URL zbytečně.
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ů.
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.