public
GET /v1/public/chat-agents/{publicKey}/config
What the widget on a customer's website needs in order to draw itself.
Πισtoποίηση
Αυτό το τελικό σημείο είναι δημόσιο. Δεν απαιτεί διαπιστευτήρια ούτε οργανισμό — είναι αυτό που διαβάζουν ο δικός μας ιστότοπος μάρκετινγκ και οι μηχανές απαντήσεων τεχνητής νοημοσύνης.
Αυτό το τελικό σημείο δεν δέχεται αναγνωριστικό οργανισμού. Το κλειδί σας προσδιορίζει ήδη τον οργανισμό στον οποίο ανήκει, και η απάντηση περιορίζεται σε αυτόν.
Δοκιμάστε το
Ατικatastήstε ό,τι βρίskεtai μέσα σe γώniaδeς μe τis δikές sas timές, kai to placeholder klεidioύ μe éna klεidi apó ton pinaka ελέgchou sas.
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.
Παράμετροι
| Όνομα | Τύpος | Υποχρεωτικό | Τι είναι |
|---|---|---|---|
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. |
Απάντηση
| Όνομα | Τύpος | Υποχρεωτικό | Τι είναι |
|---|---|---|---|
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