public
GET /v1/public/chat/{publicKey}/config
What the chat widget on this site should look like.
Authentification
Cet point de terminaison est public. Il ne nécessite aucun identifiant ni aucune organisation : c'est ce que notre propre site marketing et nos moteurs de réponse IA lisent.
Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.
Essayer
Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.
curl -X GET https://api.zinndigital.com/v1/public/chat/{publicKey}/configConnecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API
Détails
Anonymous — no credential, no tenant. The widget calls this to learn its greeting, colour, position and whether a person is likely to answer right now. The publicKey names a widget and authorises nothing: it ships in the page source of every site that embeds the widget, exactly like a publishable key. What actually gates the call is the Origin header, which must be one the customer listed on the widget. An unknown key, a disabled widget and an unlisted origin all answer 404 alike — which of the three it is is the customer's business, and distinguishing them would make this an oracle about other people's accounts. ⭐ The WordPress plugin never calls this: it already holds these settings server-side and inlines them into the page, so a WordPress visitor's browser makes no request at all until they open the chat.
Paramètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
publicKey (path) | string | Oui | The widget's public key. Public by design — it ships in the page source of every site that embeds the widget — so it NAMES a widget and authorises nothing; the Origin header is… |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
widget_id | string | Oui | — |
team_name | string | Non | — |
greeting | string | Non | — |
accent_colour | string | Non | — |
position | string<left, right> | Non | — |
branding | boolean | Oui | Whether "Powered by Zinn® Chat" is shown. Decided by the TIER, not by the widget's own flag — a customer who downgrades stops hiding our mark without anybody editing their… |
ai_enabled | boolean | Non | — |
online | boolean | Oui | Whether a person is likely to answer, from the customer's declared business hours. Not operator presence: that would need the dashboard to hold a socket open, which this design… |
Erreurs que cet point de terminaison peut renvoyer
404 · 429