public
GET /v1/public/chat-agents/{publicKey}/config
What the widget on a customer's website needs in order to draw itself.
प्रमाणीकरण
यो इन्डपइन्ट सार्वजनिक हो। यसले कुनै पनि प्रमाण पत्र र संस्था लिँदैन — यो हाम्रो आफ्नै मार्केटिङ साइट र AI उत्तर इन्जिनहरूले पढ्ने कुरा हो।
यो इन्डपोइन्टले कुनै संस्थाको आइडी लिँदैन। तपाईंको कुञ्जीले यस अन्तर्गत पर्ने संस्थालाई पहिल्यै पहिचान गर्छ, र प्रतिक्रिया त्यसैमा सीमित हुन्छ।
प्रयास गर्नुहोस्
कोणीय कोष्ठकभित्र भएका जुनसुकै कुरालाई आफ्नो मानहरूद्वारा बदल्नुहोस्, र मुख्य स्थानहोल्डरलाई तपाईंको ड्यासबोर्डको कुञ्जीद्वारा बदल्नुहोस्।
curl -X GET https://api.zinndigital.com/v1/public/chat-agents/{publicKey}/configलगइन गर्नुभएको छ? तपाईंको ड्यासबोर्डमा रहेको API कन्सोलले तपाईंको वास्तविक संस्थाको आईडी र आफ्नै कुञ्जी भरिदिन्छ, र लाइभ API विरुद्ध अनुरोध चलाउँछ ताकि तपाईंले वास्तविक प्रतिक्रिया हेर्न सक्नुहोस्। यो एन्डपोइन्टलाई 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