public
GET /v1/public/chat-agents/{publicKey}/config
What the widget on a customer's website needs in order to draw itself.
ავტორიზაცია
ეს ენდპოინტი საჯაროა. ის არ მოითხოვს არც რამედას და არც ორგანიზაციას — ეს არის ის, რასაც ჩვენი მარკეტინგული საიტი და AI პასუხების ძრავები კითხულობენ.
ეს ბოლო წერტილი არ იღებს ორგანიზაციის იდენტიფიკატორს. თქვენი გასაღები უკვე აიდენტიფიცირებს იმ ორგანიზაციას, რომელსაც ის ეკუთვნის, და პასუხი შემოფარგლულია მისით.
სცადეთ
შეSubstituted any value inside angle brackets with your own and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/public/chat-agents/{publicKey}/configშესული ხართ? თქვენი სამართავ პანელში არსებული API კონსოლი ავტომატურად ამატებს თქვენი რეალური ორგანიზაციის ID-სა და საკუთარ გასაღებს და ატარებს მოთხოვნას ცოცხალ API-ს წინააღმდეგ, რათა იხილოთ რეალური პასუხი. გაAღით ეს ენდპოინტი 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