အကြောင်းအရာသို့ ကျော်ရန်

API request ကို အတည်ပြုရန်

Threetone API key ကို x-api-key header တွင် ပို့ပြီး client code ထဲ မထည့်ရန်။

တွင် အပ်ဒိတ်လုပ်ထားသည်

API key header ကို ပို့ရန်

Public programmatic API ကို https://api.threetone.in မှ ပေးသည်။ Key ကို request ၏ x-api-key header တွင် ပို့ပါ။

curl --request GET \
  --url 'https://api.threetone.in/v1/convai/agents' \
  --header "x-api-key: $THREETONE_API_KEY"

Key ကို header value အဖြစ်သာ သုံးပါ။ URL၊ query string သို့မဟုတ် request body ထဲ မထည့်ပါနှင့်။ Programmatic request တွင် x-api-key ပို့ရမည်။ Authorization header နှင့် အတူပို့ပါက အထောက်အထား မရှင်းလင်းသဖြင့် ပယ်ချသည်။

Key ကို server တွင် ထားရန်

Server-side secret manager သို့မဟုတ် environment variable မှ key ကို ယူပါ။ Frontend JavaScript၊ mobile app bundle၊ log သို့မဟုတ် error message ထဲ မထည့်ပါနှင့်။ Deploy လုပ်ထားသော integration တစ်ခုစီအတွက် သီးခြား၊ ခွင့်ပြုချက်ကန့်သတ်ထားသော key သုံးပါ။ Key တစ်ခု ပေါက်ကြားပါက အခြားလုပ်ဆောင်ချက်များ မထိခိုက်စေရန် ဖြစ်သည်။

Request ID ကို မှတ်ရန်

Threetone သည် response header X-Request-Id ကို ပြန်ပို့သည်။ ပြဿနာစုံစမ်းရန် request အချိန်၊ method၊ path နှင့် status တို့နှင့်အတူ သိမ်းပါ။ မှန်ကန်သော X-Request-Id ကို ကိုယ်တိုင်ပို့လျှင် API က response တွင် ပြန်ဖော်ပြသည်။

ဆက်စပ် ဆောင်းပါးများ