Funguo za API za Msanidi Programu

Msanidi programu ni nini?API ?

LeyApp hufichua API ya REST ya umma chini ya /api/v1 ambayo hukuruhusu kutafuta wanasheria, kusoma upatikanaji, na kuanza kuweka nafasi kutoka kwa tovuti yako mwenyewe, programu, au zana ya ndani. Ufikiaji wa msingi wa kusoma hufanya kazi bila sifa zozote, lakini ufunguo wa API huongeza mipaka yako ya viwango, hufungua sehemu za ziada za mwisho, na hukupa dashibodi yenye funguo na matumizi yako.

Akaunti yoyote ya LeyApp inaweza kuunda funguo za API — huhitaji aina maalum ya akaunti. Uwekaji nafasi unaoanzishwa kupitia API hautozwi kiotomatiki kamwe: mteja huthibitisha na kulipa kila wakati kwenye leyapp.es, kwa hivyo ujumuishaji wako haushughulikii kamwe maelezo ya pesa au kadi.

Kuunda ufunguo wa API

Funguo zinadhibitiwa kutoka kwenye dashibodi yako:

1. Fungua Dashibodi → Msanidi Programu kutoka kwenye upau wa pembeni.
2. Bonyeza "Unda ufunguo" na uupe jina linaloelezea, k.m. "Wijeti ya tovuti (uzalishaji)".
3. Chagua aina ya ufunguo: Ishi kwa maombi halisi, au Jaribu kujaribu kwa usalama.
4. Nakili ufunguo mara moja na uuhifadhi mahali salama, kama vile kidhibiti cha nenosiri au hifadhi ya siri ya mtoa huduma wako wa mwenyeji.

Funguo za majaribio dhidi ya funguo za moja kwa moja

Funguo za majaribio (leyk_test_...) hutenda kama funguo za moja kwa moja — sehemu za mwisho zinazofanana, majibu sawa, uthibitisho sawa — zikiwa na tofauti moja muhimu: hakuna kitu halisi kinachotokea. Ombi la kuweka nafasi ya majaribio huangaliwa kikamilifu dhidi ya upatikanaji halisi, lakini hakuna nia ya kuweka nafasi iliyoundwa na hakuna wakili anayearifiwa.

Funguo za moja kwa moja (leyk_...) huunda nia halisi za kuweka nafasi. Mteja anapofuata kiungo cha uthibitisho wa nia ya moja kwa moja, hupelekwa kwenye hali ya kawaida.LeyApp mtiririko wa malipo na uthibitisho.

Funguo imara

Ikiwa wewe ni mwanachama wa kampuni ya sheria kwenye LeyApp, Dashibodi → Msanidi programu anaonyesha orodha mbili tofauti: funguo zako binafsi na funguo za kampuni yako. Ufunguo wa kampuni ni wa kampuni, si wa mtu aliyeuunda, kwa hivyo unaendelea kufanya kazi mtu huyo anapobadilisha nafasi au anapoondoka.

Wamiliki na wasimamizi wanaweza kudhibiti funguo za kampuni mara moja. Kila mwanachama mwingine anaanza bila ufikiaji wowote na lazima apewe uwezo mmoja baada ya mwingine, kutoka kwenye orodha ya wanachama wa kampuni:

• Tazama — tazama funguo za kampuni, viambishi awali vyake, na kila moja ilipotumika mara ya mwisho. Siri yenyewe haionyeshwi tena kwa mtu yeyote, ikiwa ni pamoja na wamiliki.
• Dhibiti — kuunda, kubatilisha, kusimamisha, na kuzuia funguo za kampuni.
• Webhooks — dhibiti sehemu za mwisho za webhook za kampuni.

Vidhibiti viwili vya ziada hutumika kwa funguo imara. Unaweza kuzuia ufunguo kwenye orodha ya anwani za IP au masafa, ili hata ufunguo uliovuja ukataliwe kutoka mahali pengine popote. Na unaweza kusimamisha ufunguo ili kuusimamisha bila kuuharibu, jambo ambalo ni muhimu unapochunguza jambo lisilo la kawaida.

Kutumia ufunguo wako

Tuma ufunguo katika kichwa cha Uidhinishaji cha kila ombi: "Uidhinishaji: Mbebaji leyk_...". Maombi yasiyo na ufunguo bado yanafanya kazi kwa sehemu za mwisho za umma, lakini kwa viwango vya chini vya kiwango kisichojulikana.

Kila jibu linajumuisha kichwa cha X-Request-Id. Ikiwa kitu kitaenda vibaya bila kutarajia, jumuisha kitambulisho hicho unapowasiliana na usaidizi — kinatuwezesha kupata ombi lako kamili ndani ya sekunde chache.

Vikomo vya viwango

Funguo mpya huanza kwenye kiwango cha bure: maombi 60 kwa dakika na 5,000 kwa siku. Kila jibu linakuambia uko wapi kupitia vichwa vya habari vya X-RateLimit-Limit na X-RateLimit-Remaining; ukizidi kikomo unapokea jibu la 429 huku kichwa cha habari cha Retry-After kikikuambia wakati wa kujaribu tena.

Viwango vya juu vya washirika vipo na vinatolewa na timu ya LeyApp — wasiliana nasi kupitia fomu ya usaidizi ikiwa ujumuishaji wako unahitaji nafasi zaidi ya uongozi.

Kuweka funguo salama

Ufunguo wa API ni nenosiri la ujumuishaji wako. Lichukulie kama nenosiri:

• Usiweke ufunguo katika msimbo wa upande wa mteja, programu za simu, au hazina za umma — mtu yeyote anayeweza kuusoma anaweza kutumia kikomo chako cha kiwango na kutenda ndani ya wigo wa ufunguo.
• Tumia ufunguo tofauti kwa kila muunganisho au mazingira, ili uweze kubatilisha mmoja bila kuvunja mingine.
• Batilisha funguo ambazo hutumii tena. Kubatilisha ni mara moja — maombi yenye ufunguo uliobatilishwa hushindwa kwenye simu inayofuata.
• Ikiwa ufunguo unaweza kuwa umevuja, ubatilishe mara moja katika Dashibodi → Msanidi Programu na uunde mbadala. Mzunguko ni wa muda usio na kazi: unda ufunguo mpya kwanza, utumie, kisha ubatilishe ule wa zamani.

Utatuzi wa matatizo

Ninapata 401 "Ufunguo batili wa API".

Hakikisha kwamba kichwa cha habari ni "Uidhinishaji: Mbebaji leyk_..." bila nafasi za ziada, na kwamba ufunguo haujafutwa. Kumbuka kwamba tokeni za MCP (ley_...) kutoka kwa Mipangilio → Tokeni za API ni sifa tofauti na si halali kwenye REST API.

Ninapata 429 "Kikomo cha kiwango kimezidi".

Umefikia kiwango cha kila dakika au kila siku cha daraja lako. Heshimu kichwa cha Jaribu-Baada ya Kurudia na ujaribu tena kwa kurudi nyuma kwa kasi. Ukifikia kikomo cha kila siku mara kwa mara, tuulize kuhusu kiwango cha juu zaidi.

Nafasi zangu za majaribio hazionekani popote.

Hiyo ni kwa muundo — funguo za majaribio huthibitisha kila kitu lakini hazitengenezi chochote. Badilisha hadi ufunguo wa moja kwa moja ili kuunda nia halisi za kuweka nafasi.

Siwezi kuinua funguo kwenye mojawapo ya funguo za kampuni yangu.

Ufunguo unaweza kusimamishwa na kampuni yako au na LeyApp. Usimamishwaji wa kampuni yako mwenyewe unaweza kuinuliwa na mmiliki au msimamizi yeyote. Usimamishwaji uliowekwa na LeyApp — kwa mfano tunapochunguza trafiki isiyo ya kawaida — unaweza kuinuliwa na sisi pekee, kwa hivyo wasiliana na support@leyapp.es.