Widget Ayarları
GET /settings/:id
Widget'ı modellemek için gereken config bilgilerini döner. Tema renkleri, ikonlar, form alanları, zorunlu alanlar ve karşılama mesajları bu yanıttan okunur. JWT gerekmez.
:id parametresi chat uygulamasının UUID'sidir (appId).
İstek
GET /settings/550e8400-e29b-41d4-a716-446655440000 HTTP/1.1
Host: widget-api.chatbot.aithinks.net
const settings = await fetch(`${BASE_URL}/settings/${APP_ID}`)
.then((r) => r.json());
Başarılı yanıt
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"botName": "Destek Botu",
"name": "Müşteri Destek",
"widgetConfigs": {
"requiredFields": ["email"],
"greetingMessages": [
{ "content": "Merhaba! Size nasıl yardımcı olabilirim?" }
],
"primaryBackgroundColor": "#007bff",
"primaryTextColor": "#FFFFFF",
"contentBackgroundColor": "#FFFFFF",
"sentMessageBubbleBgColor": "#007bff",
"sentMessageBubbleTextColor": "#FFFFFF",
"receivedMessageBubbleBgColor": "#f1f1f1",
"receivedMessageBubbleTextColor": "#000000",
"aiIconUrl": "https://cdn.example.com/bot-icon.png",
"widgetIconUrl": "https://cdn.example.com/widget-icon.png"
}
}
Alanlar
| Alan | Tip | Açıklama |
|---|---|---|
id | string (UUID) | Chat uygulaması kimliği |
botName | string | Botun görünen adı |
name | string | Chat uygulaması başlığı |
widgetConfigs | object | Widget'ı modellemek için config (tema, form, karşılama) |
widgetConfigs anahtarları
| Anahtar | Tip | Açıklama |
|---|---|---|
requiredFields | string[] | Ziyaretçi kaydı body'sinde zorunlu alan adları |
greetingMessages | { content: string }[] | Kayıt sonrası sohbete eklenen karşılama mesajları |
formInputs | string[] | Formda gösterilecek alanlar (ör. firstName, lastName, email) |
primaryBackgroundColor | string | Ana renk |
primaryTextColor | string | Ana metin rengi |
inputTextColor / inputBackgroundColor | string | Giriş alanı renkleri |
footerBackgroundColor / contentBackgroundColor | string | Footer ve içerik arka planı |
sentMessageBubbleBgColor / sentMessageBubbleTextColor | string | Ziyaretçi balonu renkleri |
receivedMessageBubbleBgColor / receivedMessageBubbleTextColor | string | Bot/agent balonu renkleri |
formBackgroundColor | string | Form arka planı |
aiIconUrl / widgetIconUrl / userIconUrl | string | İkon URL'leri |
widgetConfigs içeriği uygulamaya göre değişebilir; bilinmeyen anahtarları yok sayın.
Hatalar
| Durum | Anlamı |
|---|---|
404 | Verilen id ile chat uygulaması bulunamadı |