https://easyf.appUnda upakuaji kwa kutumia EasyF
EasyF inaonyesha interface mapema ili watengenezaji wanaweza kukadiria kazi zao. Mapitio ya msaada bado inahitajika kabla ya ufunguo wa kuishi na mipaka ya matumizi kuwepo.
Anza haraka
Ili kuelezea mwenyeji wa API, EasyF hutenganisha vitambulisho vilivyoamilishwa na msaada kutoka kwa mwisho wa mpangaji aliyeteuliwa. Mtiririko wa kazi wa lugha ya kawaida hutoa njia ya wito wa seva pekee mahali pake.
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"}'Usalama wa sifa huanza na uhifadhi wa siri wa upande wa seva kwenye EasyF. Mtazamo unaofuata unashughulikia hakuna uingizaji wa kifurushi cha mteja. Ukurasa huo hauhifadhi magogo ya umma au maghala yanayoonekana.
Tatua kiungo
Ili kuelezea operesheni ya Resolve, EasyF hutenganisha ugunduzi wa chanzo kutoka kwa muundo kutoka kwa URL moja iliyowasilishwa. Mtiririko wa kazi wa lugha ya kawaida hautoi matokeo yaliyozuliwa mahali pake.
/v1/resolveUpeo: suluhisha| Uga | Aina | Inahitajika | Maelezo |
|---|---|---|---|
asset_url | URL ya HTTPS | Ndiyo | Ukurasa wa vyombo vya habari wa umma au ulioidhinishwa kuchambuliwa. |
tenant | string | Hapana | Kikoa cha mpangaji kilichowekwa. Kawaida huachwa. |
{
"success": true,
"platform": "youtube",
"title": "Example video",
"formats": [
{"id":"18","type":"video","quality":"360p","container":"mp4"}
],
"cached": false
}Kitambulisho cha muundo huanza na thamani iliyorudishwa bila kubadilika kwenye EasyF. Mtazamo unaofuata unashughulikia upatikanaji wa kiungo kwa kila kiungo. Ukurasa huo unahifadhi hakuna lebo ya ubora wa kudhani inayoonekana.
Unda na fuata kazi ya upakuaji
EasyF inatoa hoja tatu za vitendo kwa ajili ya uundaji wa Ajira. Kwanza huja maandalizi ya asinkroni. Mtiririko wa kazi kwa lugha rahisi kisha unashughulikia ombi fupi la HTTP. Hoja yake ya mwisho ni utekelezaji wa mfanyakazi wenye mipaka.
/v1/jobsWigo: kazi| Uga | Aina | Inahitajika | Maelezo |
|---|---|---|---|
asset_url | URL ya HTTPS | Ndiyo | Chanzo kilekile kilichosanifishwa kilichowasilishwa ili kutatua. |
variant_code | string | Ndiyo | Kitambulisho kamili kutoka kwenye jibu la resolve. |
tenant | string | Hapana | Kikoa cha mpangaji kilichowekwa. Kawaida huachwa. |
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} na ufunguo uleule.| Hali | Maana | Kitendo cha mteja |
|---|---|---|
queued | Amekubaliwa kwenye foleni yenye kikomo. | Jaribu tena baadaye kwa kutumia kusubiri kwa muda unaoongezeka. |
extracting | Kusasisha metadata ya chanzo au njia. | Endelea kupiga kura. |
processing | Kupakua, kuunganishia upya au kuunganisha. | Onyesha maendeleo ya seva. |
ready | Upakuaji uliosainiwa unapatikana. | Tuma URL kwa mtumiaji. |
failed | Hitilafu iliyopangwa ya terminal. | Soma error_code. Jaribu tena tu unaposhauriwa. |
expired | Matokeo ya muda yameondolewa. | Unda kazi mpya. |
curl https://easyf.app/v1/jobs/DELIVERY_ID \
-H "X-API-Key: $EASYF_SERVICE_KEY"EasyF inakaribia kupiga kura ya Job kupitia kusubiri kwa mwanzo wa sekunde moja, kisha capped backoff. Mtiririko wa kazi wa lugha ya kawaida huhifadhi utoaji wa muda uliosainiwa wazi.
Makosa yanayotabirika
EasyF inapanga mkataba wa Hitilafu karibu na envelope moja isiyo ya 2xx. Mtiririko wake wa kazi wa lugha ya kawaida unalinganisha kitambulisho cha ombi la msaada. Ushughulikiaji wa mteja unaoweza kutabirika unabaki ukaguzi wa mwisho.
{
"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 | Maana ya kawaida | Kitendo |
|---|---|---|
| 400 | URL batili, mwili au umbizo halipatikani. | Rekebisha ombi. Tatua tena kwa ajili ya fomati. |
| 401 | Ufunguo haupo, si sahihi, muda wake umeisha, au una wigo usio sahihi. | Angalia kitambulisho cha upande wa seva. |
| 403 | Sera ya mpangaji au chanzo imekataa ombi. | Usipite sera. Wasiliana na usaidizi. |
| 404 | Kazi isiyojulikana au iliyokwisha muda wake. | Unda kazi mpya ikiwa inafaa. |
| 429 | Kikomo cha ombi au kazi inayotumika kimefikiwa. | Heshima retry_after_seconds. |
| 503 | Foleni/uwezo au huduma ya juu kwa muda haipatikani. | Jaribu tena kwa kutumia ucheleweshaji unaoongezeka kwa kasi na jitter. |
Mkataba wa uendeshaji
EasyF inakubaliana na mipaka ya matumizi ya vitendo na kila bidhaa iliyoidhinishwa ili kuhifadhi mtiririko wa kazi unaoongozwa unaoweza kutabirika.
- Tumia mantiki ya programu inayotumika mara moja bila kuathiri matokeo na usianzishe kamwe kazi rudufu kwa kubofya kwa mtumiaji mmoja.
- Hifadhi metadata ya kutatua kashe kwa muda mfupi, lakini daima chukulia URL za upakuaji zilizosainiwa kuwa zina muda wa kuisha.
- Tumia kurudi nyuma kwa kasi yenye mipaka na mtikisiko kwa
429,503na makosa yanayoweza kujaribiwa tena. - Chakata tu maudhui ya umma au maudhui ambayo umeidhinishwa kuyafikia. DRM na vidhibiti vya ufikiaji havipitiwi.
- Hifadhi vitambulisho vya ombi na vitambulisho vya kazi katika kumbukumbu za uendeshaji za faragha. Usirekodi URL zilizowasilishwa bila ulazima.
Ili kuelezea ufikiaji wa Schema, EasyF hutenganisha uanzishaji kabla ya utafiti kutoka kwa uthibitishaji uliowekwa. Mtiririko wa kazi wa lugha ya kawaida hutoa maumbo ya ombi yaliyoandikwa mahali pake.
Washa kupitia usaidizi
Mwambie EasyF unachojenga, itaita API mara ngapi na watoa huduma gani wana umuhimu. Uhakiki huamua shughuli zinazoruhusiwa, kisha hufichua kitambulisho mara moja huku ukihifadhi tu muhtasari wake salama.
Omba uanzishaji Vifunguo vinahusiana na mpangaji, vinaweza kufutwa na hutolewa kupitia fomu ya Mawasiliano. Hati zisizojulikana haziwezi kutekeleza kazi ya kipakua.