Jenga na endesha uunganishaji wa Alkax

Developer Platform ya Alkax huweka kila uunganishaji katika mradi. Kila mradi huanza na mazingira yaliyotenganishwa ya Sandbox na Production, ili shughuli za majaribio, vitambulisho, migao, kumbukumbu na webhook zisivuke mipaka ya mazingira.

Fungua Developer Console kwenye https://alkax.io/developers kuunda na kusimamia miradi.

Muundo wa mradi

Mradi unamilikiwa na akaunti yako au shirika. Sera ya shirika inaweza kuweka mipaka ya kuunda miradi, ruhusa zinazopatikana, mgao, muda wa kitambulisho na ufikiaji wa Production.

Majukumu ya mradi ni:

Jukumu	Ufikiaji wa kawaida
Owner (Mmiliki)	Mzunguko mzima wa maisha ya mradi, wanachama, vitambulisho na mipangilio
Developer (Msanidi programu)	Kujenga na kuendesha uunganishaji
Analyst (Mchambuzi)	Kukagua matumizi, afya ya mfumo na kumbukumbu za maombi
Billing viewer (Mtazamaji wa utozaji)	Kukagua matumizi yanayohusiana na utozaji

Unda mradi wako wa kwanza

1. Fungua Developer Console.
2. Chagua New project (Mradi mpya) na uchague akaunti au shirika litakalomiliki.
3. Fungua Credentials (Vitambulisho) na utoe kitambulisho cha Sandbox chenye ruhusa unazohitaji tu.
4. Nakili siri mara moja. Alkax huhifadhi hashi yake tu na haiwezi kuionesha tena.
5. Ita data ya majaribio ya Sandbox au tumia eneo la majaribio la dashibodi.
6. Kagua Usage (Matumizi) na Logs (Kumbukumbu) kwa kutumia kitambulisho cha ombi kilichorudishwa.

Vitambulisho na ruhusa

Tuma kitambulisho cha upande wa seva katika kichwa cha X-Alkax-Key:

X-Alkax-Key: ak_test_<key-id>.<secret>

Funguo za Sandbox huanza na ak_test_; funguo za Production huanza na ak_live_. Ruhusa zinazopatikana ni pamoja na:

Ruhusa	Inaruhusu
places:read	Kusoma data ya mahali
geocode:read	Kutafuta na kupata viwianishi
delivery:read	Kusoma hali ya uthibitisho wa uwasilishaji
delivery:write	Kuunda na kubadilisha uthibitisho wa uwasilishaji

Kugeuza na kufungua Grid kunapatikana kama operesheni tofauti za API kwa kutumia X-Alkax-Key na ruhusa ya places:read; tazama mwongozo wa anwani za Alkax Grid.

Kubadilisha kitambulisho huunda mbadala. Sambaza mbadala kabla ya kubatilisha ufunguo wa awali. Ubatilishaji, kuisha muda, kusimamishwa kwa mradi na kusimamishwa kwa mazingira huanza kuathiri maombi yanayofuata.

Usajili na haki ya matumizi

Matumizi ya API ya wasanidi yanatawaliwa na usajili wa mwenye mradi na sera husika ya shirika.

Mpango	Haki ya API ya wasanidi
Free	Sandbox pekee, hadi maombi 1,000 kwa mwezi
Pro Monthly au Annual	Sandbox na Production, hadi maombi 50,000 kwa mwezi
Enterprise	Sandbox na Production, bila kikomo kwa chaguo-msingi

Mgao wa mpango unashirikiwa katika miradi na mazingira yote yanayotozwa kwa akaunti ileile. Vikomo vya mradi, shirika na mazingira vinaweza kuweka kiwango cha chini zaidi. Haviwezi kuongeza mgao wa usajili.

Usajili wa kulipia unapoisha au kuacha kutumika, vitambulisho vya Production vilivyopo hupokea 402 subscription_required. Mgao wa mwezi unapoisha, maombi hupokea 429 quota_exceeded hadi kipindi kijacho cha utozaji au uboreshaji wa mpango.

Sandbox yenye matokeo yanayojirudia

Vitambulisho vya Sandbox hutumia mchakato uleule wa uthibitishaji wa utambulisho na mikataba ya endpoint ya Production huku vikitenganisha athari na matumizi.

export ALKAX_API="https://api.alkax.io"
export ALKAX_KEY="ak_test_<key-id>.<secret>"

curl "$ALKAX_API/api/v1/sandbox/fixtures/valid-high-confidence" \
  --header "X-Alkax-Key: $ALKAX_KEY" \
  --header "Accept: application/json"

Vitambulishi thabiti vya data ya majaribio ni pamoja na:

Data ya majaribio	Matokeo
valid-high-confidence	Inaweza kuwasilishiwa kwa uhakika wa juu
ambiguous	Ufafanuzi unapendekezwa
weak-access	Anwani halali yenye uhakika mdogo wa kiingilio au ufikiaji
not-found	Anwani isiyojulikana
conflicting-evidence	Ushahidi unaokinzana na uhakika mdogo

Tumia hali za hitilafu za Sandbox error-403, error-404, error-409, error-429 na error-500 kujaribu ushughulikiaji wa kushindwa. Tumia kitambulisho batili au kilichobatilishwa kujaribu njia halisi ya 401.

Vitambulisho vya maombi, matumizi na kumbukumbu

Kila jibu la API ya wasanidi linajumuisha X-Request-Id. Thamani hiyo hiyo huunganisha jibu na kumbukumbu za maombi na uchunguzi wa usaidizi.

Dashibodi hurekodi metadata salama kwa faragha kama kiolezo cha njia, mbinu, hali, muda wa kujibu, athari kwa mgao, mazingira na jina la kitambulisho. Vitambulisho na sehemu nyeti za data hazijumuishwi.

Webhook

Fungua Webhooks, chagua mazingira, ingiza mahali pa kupokea pa umma pa HTTPS na uchague aina ya tukio kutoka orodha. Matukio ya miradi yanayotumika ni pamoja na:

• delivery.confirmation.created
• delivery.confirmation.cancelled

Siri ya kutia sahihi huoneshwa mara moja. Sandbox na Production hutumia kanuni zilezile za kutia sahihi lakini siri tofauti.

Maombi ya webhook yanajumuisha:

X-Alkax-Event-Id: <UUID>
X-Alkax-Timestamp: <Unix seconds>
X-Alkax-Signature: v1=<lowercase HMAC-SHA256>

Hesabu sahihi inayotarajiwa juu ya <timestamp>.<raw-body>, kataa mihuri ya muda iliyopitwa, linganisha sahihi kwa muda usiobadilika na uondoe urudiaji kwa kitambulisho cha tukio. Dashibodi inaweza kutuma tukio la majaribio, kuonesha majaribio ya kuwasilisha na sehemu salama za majibu, na kutuma tena kwa mkono tukio lililoshindwa.

Alkax hukataa anwani za loopback, binafsi, link-local na zinazoelekezwa na DNS kwenye anwani binafsi. Uelekezaji mwingine haufuatwi.

Utayari wa Production

Kabla ya kutoa kitambulisho cha Production:

• thibitisha usajili wako na ufikiaji wa Production;
• punguza ruhusa za kitambulisho;
• kamilisha ombi la Sandbox lililofanikiwa;
• jaribu ushughulikiaji wa kushindwa na majibu ya mgao;
• hakiki ufikikaji na sahihi za webhook;
• sanidi vizuizi vya ufikiaji vinavyopatikana inapofaa;
• thibitisha hakuna ufunguo wa ak_test_ katika usanidi wa Production.

Endelea na mwongozo wa kuanza kutumia API, mwongozo wa uthibitishaji wa utambulisho au marejeleo ya API.