Kusimamia funguo zako za API
Pata funguo yako ya API chini ya API & Webhooks kwenye console, iweke upande wa server, tumia programu tofauti ya sandbox kwa majaribio, na urekebishe hitilafu za 401 na 403.
API & Webhooks, inahusiana na programu uliyochagua. Funguo moja kwa kila programu, na funguo hiyo ndiyo mazingira - hakuna funguo tofauti ya majaribio kwenye programu ya live. Ni siri ya upande wa server: kamwe isiwe kwenye msimbo wa frontend au ndani ya app bundle.
Funguo yako ya API iko chini ya API & Webhooks kwenye upau wa pembeni wa console, ikihusiana na programu unayofanyia kazi. Itendee kama nywila - inatoa ufikiaji kamili wa API kwa niaba ya programu hiyo.
#Kupata funguo yako
- Ingia kwenye Business Console
Nenda business.didit.me na uingie.
- Chagua programu yako
Chagua programu unayotaka kutoka kwenye orodha juu ya console. Kila programu ina funguo yake.
- Fungua API & Webhooks
Funguo yako ya API ipo hapa, pamoja na maeneo yako ya webhook na siri zao za kusaini.
- Create API key inatengeneza funguo mpya; funguo ni za kila programu.
- Siri inaonyeshwa hapa mara moja tu - inakili kwenye hifadhi yako ya siri.
- Rotate secret inabadilisha siri bila kubadilisha jina la funguo.
- Last used ndiyo njia ya kutofautisha funguo hai na iliyosahauliwa kabla ya kuibatilisha.
#Funguo ya API na siri ya kusaini ni vitu tofauti
Inafaa kusema hili wazi, kwa sababu kuvichanganya hutokeza hitilafu za kutatanisha:
| Inatumika kwa nini | Wapi | |
|---|---|---|
| Funguo ya API | Kuthibitisha maombi yako kwa Didit, kwenye kichwa cha x-api-key | Kwa kila programu |
| Siri ya kusaini ya webhook | Kuthibitisha kuwa webhook inayoingia kweli imetoka kwa Didit | Kwa kila eneo lengwa |
Kutuma siri ya kusaini kama funguo yako ya API hutokeza 401. Kuthibitisha webhook ukitumia funguo yako ya API hutokeza kutolingana kwa saini. Zote mbili ni za kawaida.
Funguo yako ya API ni siri. Kamwe usiiweke kwenye msimbo wa frontend, hifadhi ya umma, au ndani ya app bundle ya simu - iweke upande wa server pekee. Funguo iliyomo ndani ya app bundle iliyosambazwa ni funguo ambayo mshambuliaji tayari anayo. Angalia uthibitishaji wa API.
#Kupata funguo kwa ajili ya majaribio
Usijaribu dhidi ya production. Tengeneza programu tofauti katika hali ya sandbox - session za sandbox huiga kila ukaguzi wa nje, hazitozwi kamwe, na hazigusi data halisi ya mtumiaji. Tumia funguo yake wakati unajenga, na uendelee kuwa na programu tofauti ya live kwa uthibitishaji halisi.
Hakuna "funguo ya majaribio" kwenye programu ya live. Funguo ndiyo mazingira, kwa hivyo inafaa kupa funguo zako majina yasiyo na utata popote unapohifadhi siri zako. Angalia kujaribu kwenye sandbox.
#Kubadilisha funguo yako
Kama funguo huenda ilifichuliwa, itengeneze upya kutoka ukurasa uleule wa API & Webhooks. Kutengeneza upya kunabatilisha funguo ya zamani papo hapo, kwa hivyo isasishe kila mahali inapotumika kwanza - vinginevyo trafiki yako ya production itaanza kushindwa mara tu unapobonyeza kitufe hicho.
Kubadilisha funguo kwa ratiba ni tabia nzuri. Ipange kama deploy, si bonyezo la haraka.
#Kurekebisha 401 na 403
| Hitilafu | Chanzo | Suluhisho |
|---|---|---|
401 | Funguo haipo, imeharibika, au imetengenezwa upya | Nakili funguo ya sasa kutoka API & Webhooks kwa programu hiyo. Angalia nafasi zisizohitajika au alama za nukuu, na kwamba hukubandika siri ya kusaini badala yake |
403 | Funguo ni sahihi lakini ombi hili haliruhusiwi | Kwa kawaida ni programu isiyo sahihi, sehemu ya sandbox-pekee kwenye funguo ya live (au kinyume chake), ruhusa ambayo funguo yako haina, au kipengele kisichowashwa kwenye akaunti yako |
403 kwenye workflow mahususi mara nyingi humaanisha funguo inamilikiwa na programu tofauti na ile inayomiliki workflow hiyo. Badilisha programu kwenye console na unakili funguo yake badala yake. Maelezo kamili: hitilafu za API na maana yake.
#Kuzuia kile funguo inachoweza kufanya
Kama hitaji lako ni kupunguza aina za data ambazo funguo inaweza kufikia - kwa mfano kuzuia huduma isipate picha za hati - hilo ni swali la ruhusa badala ya mpangilio wa funguo, na kinachopatikana kinategemea akaunti yako. Uliza usaidizi badala ya kudhani funguo haina vizuizi au kudhani ina vizuizi; mawazo yote mawili ni hatari kwa mielekeo tofauti.
#Nani kwenye timu yako anaweza kuona funguo
Uonekano wa funguo unafuata jukumu. Jukumu la Developer linahusisha funguo za API; Reader halihusishi. Kama mwenzako hawezi kuipata ukurasa, angalia jukumu lake kabla ya kuripoti tatizo. Angalia kualika wanachama wa timu na kuweka majukumu.
#Kila ombi linarekodiwa
Maombi ya funguo ya API yanaonekana kwenye Audit Logs yakihusishwa na programu badala ya mtu - ndiyo sababu funguo moja inayoshirikiwa na huduma kadhaa hufanya tukio kuwa gumu zaidi kuchunguza. Funguo moja kwa kila mtumiaji ni rahisi zaidi kuelewa. Angalia kutumia audit logs.