Ruka hadi kwenye maudhui makuu

Tuma ombi lako la kwanza la API

Mwongozo huu hutumia mradi wa Developer Platform na Sandbox yake yenye matokeo yanayojirudia. Unajaribu mchakato uleule wa uthibitishaji wa utambulisho wa Production bila kusababisha mabadiliko katika mazingira halisi.

Kabla ya kuanza​

Unahitaji:

  • akaunti ya Alkax yenye ufikiaji wa Developer Console;
  • mradi na mazingira yake ya Sandbox;
  • kitambulisho cha Sandbox chenye delivery:read kwa data ya majaribio ya kwanza;
  • backend au mazingira salama ya seva;
  • URL ya msingi ya API: https://api.alkax.io.

Weka vitambulisho katika kidhibiti cha siri na uvifiche kwenye kumbukumbu za programu.

Fungua https://alkax.io/developers, unda mradi na utoe kitambulisho cha Sandbox kutoka Credentials (Vitambulisho). Nakili siri inapooneshwa; haiwezi kurejeshwa baadaye.

Weka vigeu vya ombi lako​

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

Tuma ombi la Sandbox lenye matokeo yanayojirudia​

Ita data ya majaribio yenye toleo ambayo ni salama kutumia kwenye maendeleo ya ndani na CI:

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

Jibu lina matokeo thabiti ya majaribio na kichwa cha X-Request-Id. Tumia kitambulisho hicho cha ombi kutafuta ombi kwenye kichupo cha Logs (Kumbukumbu) cha Developer Console.

Data nyingine thabiti za majaribio ni ambiguous, weak-access, not-found na conflicting-evidence. Eneo la majaribio la dashibodi linaweza kuendesha data hizohizo na kuzalisha mifano ya curl, TypeScript, Python na C#.

Endelea kwenye endpoint ya biashara​

Toa kitambulisho chenye ruhusa inayohitajika tu, kisha ita endpoint kwa kutumia kichwa kilekile cha X-Alkax-Key. Kwa uthibitisho wa mpokeaji kabla ya kutuma mzigo, fuata mwongozo wa Delivery Intelligence.

Usitumie ufunguo wa Sandbox katika Production. Uunganishaji unapokuwa tayari, washa usajili wa kulipia na utoe kitambulisho tofauti cha ak_live_ kutoka mazingira ya Production.

Shughulikia jibu​

  • Chukulia hali ya HTTP kuwa matokeo ya msingi.
  • Hifadhi vitambulisho thabiti, misimbo ya hitilafu inayosomeka na mashine na kitambulisho cha ombi.
  • Tumia vitambulisho salama kwa majaribio ya kurudia pale mwongozo unapohitaji.
  • Ongeza muda wa kusubiri kwa majibu ya 429 na 5xx za muda.
  • Usirudie kamwe ombi batili bila kulibadilisha.

Tazama Hitilafu na majaribio ya kurudia kwa muundo wa kawaida wa jibu.

Endelea​

Kamilisha uunganishaji unaofanya kazi​

Baada ya ombi la kwanza la Sandbox, endelea na uunganishaji wa uwasilishaji na urejeshaji na mwongozo wa webhook. Data ya majaribio ni mfano wa anwani; haiundi shehena. Tumia API zenye matoleo na taratibu za Sandbox zilizoandikwa kujaribu mzunguko mzima wa maisha kwa data bandia kabla ya kuhamia Production.