https://easyf.appEhitage allalaadimised koos EasyF-ga
EasyF näitab liidest ette, et arendajad saaksid oma töö mahtu hinnata. Enne reaalset võtit ja kasutuspiirangut on siiski vaja tugitiimi ülevaatust.
Kiire algus
API hosti selgitamiseks eraldab EasyF tugiteenuse aktiveeritud mandaadid määratud üürniku lõpp-punktist. Lihtsas keeles töövoog annab ainult serverile mõeldud kõneteele omaette koha.
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"}'Volituste turvalisus algab serveripoolsest saladuste talletamisest EasyF-l. Järgmine vaade käsitleb, et kliendipoolsesse paketti ei ole midagi manustatud. Leht ei näita avalikke logisid ega hoidlaid.
Lingi lahendamine
Resolve-operationi selgitamiseks eraldab EasyF ühest esitatud URL-ist lähteandmete tuvastamise vormingutest. Lihtsas keeles töövoog ei anna väljamõeldud väljunditele nende endi kohta eraldi kohta.
/v1/resolveReguleerimisala: lahendada| Väli | Tüüp | Nõutav | Kirjeldus |
|---|---|---|---|
asset_url | HTTPS URL | Jah | Avalik või volitatud meedia leht analüüsimiseks. |
tenant | string | Ei | Määratud rentniku domeen. Tavaliselt jäetakse välja. |
{
"success": true,
"platform": "youtube",
"title": "Example video",
"formats": [
{"id":"18","type":"video","quality":"360p","container":"mp4"}
],
"cached": false
}Vormingu identifikaator algab tagastatud väärtusega muutmata kujul EasyF. Järgmine vaade hõlmab iga lingi saadavust. Leht ei kuva ühtegi oletatud kvaliteedimärgist.
Allalaadimistöö loomine ja jälgimine
EasyF esitab töö loomise jaoks kolm praktilist punkti. Esiteks tuleb asünkroonne ettevalmistus. Lihtsas keeles töövoog katab seejärel lühikese HTTP päringu. Selle viimane punkt on piiritletud töölise täitmine.
/v1/jobsReguleerimisala: töökohad| Väli | Tüüp | Nõutav | Kirjeldus |
|---|---|---|---|
asset_url | HTTPS URL | Jah | Sama normaliseeritud allikas esitati lahendamiseks. |
variant_code | string | Jah | Täpne ID lahendamisvastusest. |
tenant | string | Ei | Määratud rentniku domeen. Tavaliselt jäetakse välja. |
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} sama võtmega.| Olek | Tähendus | Kliendi tegevus |
|---|---|---|
queued | Lubatud piiratud järjekorda. | Küsitlus uuesti tagasilöögiga. |
extracting | Värskendatakse lähtemetaadata või marsruuti. | Jätkake küsitlemist. |
processing | Allalaadimine, remuxing või ühendamine. | Kuva serveri edenemine. |
ready | Allkirjastatud allalaadimine on saadaval. | Saada URL kasutajale. |
failed | Terminali struktureeritud viga. | Loe error_codeProovige uuesti ainult siis, kui seda soovitatakse. |
expired | Ajutine väljund eemaldati. | Looge uus töökoht. |
curl https://easyf.app/v1/jobs/DELIVERY_ID \
-H "X-API-Key: $EASYF_SERVICE_KEY"EasyF läheneb Job-i küsitlustele ühesekundilise esialgse ooteajaga, seejärel piiratud taandumisega. Lihtsas keeles töövoog hoiab ajutise allkirjastatud edastuse selgena.
Eeldatavad vead
EasyF korraldab Error lepingu ühe mitte-2xx ümbriku ümber. Selle lihtsas keeles töövoog võrdleb tugipäringu ID-d. Prognoositav kliendikäitlus jääb viimaseks kontrolliks.
{
"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": "…"
}| HTTP | Tüüpiline tähendus | Tegevus |
|---|---|---|
| 400 | Vigane URL, keha või kättesaamatu vorming. | Parandage taotlus. Lahendage uuesti vormingute jaoks. |
| 401 | Puuduv, kehtetu, aegunud või vale ulatusega võti. | Kontrollige serveripoolset mandaati. |
| 403 | Üürnik või allikapoliitika lükkas taotluse tagasi. | Ärge mööduge poliitikast. Võtke ühendust toega. |
| 404 | Tundmatu või aegunud töö. | Looge vajadusel uus töökoht. |
| 429 | Taotluste või aktiivsete tööde piirmäär on saavutatud. | Au. retry_after_seconds. |
| 503 | Järjekord/mahutavus või ülesvoolu ajutiselt kättesaamatu. | Proovige uuesti eksponentsiaalse tagasilöögi ja värisemisega. |
Tegevusleping
EasyF lepib iga heakskiidetud tootega kokku praktilised kasutuspiirid, et säilitada prognoositav juhitud töövoog.
- Kasutage idempotentset rakendusloogikat ja ärge kunagi käivitage sama kasutaja kliki jaoks duplikaattöid.
- Puhverda lahendamise metaandmeid lühidalt, kuid käsitle allkirjastatud allalaadimise URL-e alati kui aeguvat.
- Kasutage piiratud eksponentsiaalset tagasilööki koos värisemisega
429,503ja korratavaid vigu. - Töötle ainult avalikku meediat või meediat, millele sul on lubatud juurde pääseda. DRM- ja juurdepääsukontrolle ei mööda.
- Hoidke päringute ID-d ja tööde ID-d privaatses operatiivlogides. Ärge logige esitatud URL-e tarbetult.
Skeemi juurdepääsu selgitamiseks eristab EasyF aktiveerimist enne uurimist määratud autentimisest. Selges keeles töövoog annab dokumenteeritud päringuvormidele oma koha.
Aktiveerimine tugiteenuse kaudu
Räägi EasyF-ile, mida sa ehitad, kui sageli see API-t kutsub ja millised teenusepakkujad on olulised. Ülevaatus otsustab lubatud toimingud, seejärel näitab see mandaati ühe korra, salvestades samal ajal ainult selle turvalise räsi.
Taotle aktiveerimist Võtmed on üürniku ulatuses, tühistatavad ja väljastatakse kontaktivormi kaudu. Anonüümsed skriptid ei saa alla laadija tööd käivitada.