public
GET /v1/public/chat-agents/{publicKey}/config
What the widget on a customer's website needs in order to draw itself.
စစ်မှန်ကြောင်း အတည်ပြုခြင်း
ဤ အားထုတ်ရန်အမှတ်သည် လူတိုင်းသုံးနိုင်ပါသည်။ ၎င်းသည် အထောက်အထားအချက်အလက် သို့မဟုတ် အဖွဲ့အစည်း မည်သည့်အရာကိုမျှ မတောင်းခံပါ - ၎င်းသည် ကျွန်ုပ်တို့၏ ကိုယ်ပိုင်စျေးကွက်ရှာဖွေရေးဆိုက်နှင့် AI ဖြေဆိုသည့်အင်ဂျင်များ ဖတ်ရှုသည့်အရာပင် ဖြစ်ပါသည်။
ဤ အမှတ်ဆက် (endpoint) သည် အဖွဲ့အစည်း အိုင်ဒီ (organisation id) ကို မယူပါ။ သင်၏ သော့ချက် (key) သည် ၎င်းပိုင်ဆိုင်သည့် အဖွဲ့အစည်းကို အလိုအလျောက် ဖော်ထုတ်ပြီးဖြစ်ကာ တုံ့ပြန်ချက်ကိုလည်း ၎င်းနှင့်သာ ကန့်သတ်ထားမည် ဖြစ်သည်။
စမ်းကြည့်ရန်
ထောင့်ချိတ်များအတွင်းရှိ မည်သည့်အရာကိုမဆို သင်၏ကိုယ်ပိုင်တန်ဖိုးများဖြင့် အစားထိုးပြီး သင့်ဒက်ရှ်ဘုတ်မှ သော့ချက်တစ်ခုဖြင့် key ကို အစားထိုးပါ။
curl -X GET https://api.zinndigital.com/v1/public/chat-agents/{publicKey}/configဝင်ရောက်ပြီးပြီလား။ သင့်ဒက်ရှ်ဘုတ်ရှိ API ကွန်ဆိုးလ်တွင် သင့်၏ တကယ့်အဖွဲ့အစည်း ID နှင့် သင့်ကိုယ်ပိုင်သော့ချက်တို့ဖြင့် ဖြည့်သွင်းပေးပြီး တကယ့်တုံ့ပြန်ချက်ကို သင်မြင်နိုင်ရန် တိုက်ရိုက် API (live API) ကို အသုံးပြု၍ တောင်းဆိုမှုကို လုပ်ဆောင်ပေးပါသည်။ ဤအဆုံးသတ်အမှတ် (endpoint) ကို API ကွန်ဆိုးလ်တွင် ဖွင့်ပါ
အသေးစိတ်အချက်အလက်များ
Unauthenticated by necessity: a visitor on a customer's website has no account, and that is the product. Everything returned is already visible to whoever is reading that page — a name, a greeting and a colour. There is no secret here, no organisation id and no site id. ⛔ Answers 404 both when the key is unknown and when the calling Origin is not one the customer authorised. One answer for two causes, deliberately: a distinguishable refusal would tell a stranger that a key is real and merely mis-embedded, which is an enumeration oracle over every customer who owns this product.
ကန့်သတ်ဘောင်များ
| နာမည် | အမျိုးအစား | လိုအပ်သည် | ဘာလဲဆိုတာ |
|---|---|---|---|
publicKey (path) | string | ဟုတ်ကဲ့ | The agent's public key, as carried in the embed snippet. |
locale (query) | string | မဟုတ်ပါ | The visitor's language tag (the page's lang, else the browser's). Chooses the language of strings; an unknown tag answers in English. |
တုံ့ပြန်ချက်
| နာမည် | အမျိုးအစား | လိုအပ်သည် | ဘာလဲဆိုတာ |
|---|---|---|---|
name | string | ဟုတ်ကဲ့ | — |
greeting | string | ဟုတ်ကဲ့ | — |
brand_colour | string | မဟုတ်ပါ | — |
launcher_position | string<left, right> | မဟုတ်ပါ | — |
handoff_enabled | boolean | မဟုတ်ပါ | — |
strings | object | မဟုတ်ပါ | The widget's own words — button labels, placeholder, greeting fallback, error line — in the language asked for by ?locale= (the nearest of the 58 site locales, else English). ⛔… |
ဤအမှတ်ဆက်မှ ပြန်ပေးနိုင်သော အမှားများ
404 · 429