public
GET /v1/public/chat/{publicKey}/config
What the chat widget on this site should look like.
Նույնականացում
Այս վերջնակետը հանրային է: Այն չի պահանջում որևէ հավատարմագիր կամ կազմակերպություն. դա այն է, ինչ կարդում են մեր սեփական մարքեթինգային կայքը և արհեստական բանականության պատասխանների շարժիչները:
Այս վերջնակետը կազմակերպության ID չի ընդունում: Ձեր բանալին արդեն իսկ նույնականացնում է այն կազմակերպությունը, որին պատկանում է, և պատասխանը սահմանափակված է դրանով:
Փորձել
Փոխարինեք անկյունային փակագծերում գտնվող ցանկացած բան ձեր սեփական արժեքներով, և բանալու տեղապահը՝ ձեր վահանակի բանալիով:
curl -X GET https://api.zinndigital.com/v1/public/chat/{publicKey}/configՄուտք գործե՞լ եք: Ձեր վահանակի API վահանակը լրացնում է ձեր իրական կազմակերպության ID-ն և ձեր սեփական բանալին և գործարկում է հարցումը ուղիղ API-ի դեմ, որպեսզի կարողանաք տեսնել փաստացի պատասխանը: Բացեք այս վերջնակետը API վահանակում
Մանրամասներ
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.
Պարամետրեր
| Անուն | Տեսակ | Պահանջվում է | Ինչ է դա |
|---|---|---|---|
publicKey (path) | string | Այո | 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… |
Պատասխան
| Անուն | Տեսակ | Պահանջվում է | Ինչ է դա |
|---|---|---|---|
widget_id | string | Այո | — |
team_name | string | Ոչ | — |
greeting | string | Ոչ | — |
accent_colour | string | Ոչ | — |
position | string<left, right> | Ոչ | — |
branding | boolean | Այո | 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 | Ոչ | — |
online | boolean | Այո | 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… |
Այս վերջնակետի կողմից վերադարձվող սխալները
404 · 429