Widget API — Keyda Business docs

Geliştiriciler veya sohbetin kendi butonlarından açılmasını isteyen herkes için.

Yükleme

<script src="https://keyda.in/business/widget.js"
        data-key="kb_live_your_key_here" async></script>

Betik etiketinin yalnızca src ve data-key'e ihtiyacı vardır. Geri kalan her şey — renkler, konum, karşılama mesajı, dil — panelinizden gelir, böylece bunları değiştirmek için sitenizi asla yeniden dağıtmanız gerekmez.

Widget, Yükle → Botunuzun konuştuğu dil'de ayarlanan dilde çizilir: butonu, yer tutucuları ve bildirimleri ile yerleşimin yönü (Arapça ve Urduca sağdan sola). Metinler, widget'ın yapılandırmasıyla birlikte gelir; bu yüzden ikinci bir istek olmaz ve sizin tarafınızda çevrilecek bir şey kalmaz.

Modlar

Yüzen (varsayılan). Köşede yer alan ve sohbet panelini açan bir başlatıcı düğme.

Satır içi. Sayfaya boş bir kapsayıcı yerleştirin, sohbet penceresi oraya yerleşecektir:

<div data-keyda-bot style="height:520px"></div>

Kapsayıcının bir yüksekliğe ihtiyacı vardır. Satır içi modda sohbet her zaman görünür durumdadır, bu nedenle açılacak veya kapanacak bir şey yoktur.

JavaScript API

Komut dosyası yüklendiğinde window.KeydaBot üzerinde kullanılabilir:

Ara	Ne işe yarar
`KeydaBot.open()`	Sohbet panelini açar
`KeydaBot.close()`	Kapatır
`KeydaBot.toggle()`	Açar veya kapatır
`KeydaBot.expand()`	Paneli pencere yüksekliğinde ve 760 piksele kadar genişlikte yapar
`KeydaBot.shrink()`	Standart karta dön
`KeydaBot.isOpen`	`true` sohbet görünür olduğunda
`KeydaBot.isExpanded`	`true` panel genişletilmişken
`KeydaBot.clientId`	Bu sayfanın kullandığı Client ID

Örnek — sohbeti kendi "Bizimle sohbet edin" düğmenizden açın:

<button onclick="KeydaBot.open()">Chat with us</button>

Script asenkron olarak yüklendiğinden, sayfa yüklendikten hemen sonra window.KeydaBot mevcut olmayabilir. Sayfa ayrıştırılırken çağırmak yerine, işleyicileri bir tıklamaya bağlayın.

Sayfanızda nasıl davranır

Panel, yerinde kalan ve kapatma kontrolü haline gelen başlatıcı butonunun üzerinde açılır. Butona tekrar dokunmak, başlıktaki ✕ işaretine basmak veya Escape tuşuna basmak sohbeti kapatır.
Bir ziyaretçi paneli başlıktan genişletebilir — panel pencere yüksekliğine ve 760 piksel genişliğe kadar büyür — ve bu tercih tarayıcılarında hatırlanır. Telefonlarda panel zaten tam ekran olduğu için bu kontrol orada gösterilmez.
Logo boyutu ayarınız butonu değil, logoyu değiştirir: başlatıcı boyutunu korur, logo ise bunun içinde büyür. Butonun kendisini yeniden boyutlandıran Buton boyutu'dur (Yükle → Görünüm) — küçük, orta veya büyük, şekli ne olursa olsun.
Dört buton şekli: etiketinizle bir hap, yuvarlak bir baloncuk, yuvarlatılmış bir kare ve kuyruklu bir sohbet baloncuğu. Kuyruk, sayfanıza bakan tarafta yer alır.
Her şey bir shadow root içinde oluşturulur, böylece CSS'iniz widget'ı bozamaz ve widget'ın CSS'i sitenize müdahale edemez.
Panel yalnızca bir ziyaretçi açtığında yüklenir, bu nedenle sayfanızı yavaşlatmaz.
Bir ziyaretçi geri dönerse konuşması 24 saat boyunca devam eder, ardından sıfırdan başlar. Paneli yeniden açmak konuşmayı geri yükler — dosyalar dahil, ve hâlâ yanıt bekleyen bir karşılama akışı sorusu dahil.
Ataç, yazı alanında bir ziyaretçinin bir mesaja en fazla üç fotoğraf veya belge eklemesine izin verir (boyutlar ve türler için Limitler ve güvenlik). Fotoğraflar yüklenmeden önce tarayıcıda küçültülür, böylece 12 megapikselik bir görüntü sayfadan yalnızca birkaç yüz kilobayt olarak çıkar. Dosyaları Yükle altından kapatırsanız buton kaybolur.
Bir karşılama akışı, sıradan baloncuklar olarak çalışır: seçenekler baloncuğun altında butonlara dönüşür, bir adım isteğe bağlı olduğunda bir Atla butonu belirir ve yazı alanının yer tutucusu soru haline gelir. Tamamlanmış bir akış, ziyaretçinin tarayıcısında 30 gün boyunca hatırlanır.
Asistan'a ulaşılamazsa, widget kısa bir mesaj gösterir ve sayfanızda asla hata vermez.

Uygulama SDK'larının içinde

Aynı sohbet her SDK'da çalışır, bu yüzden ekler ve karşılama akışları uygulamanıza bir sürüm çıkarmanıza gerek kalmadan ulaşır — bir istisna dışında. Bir web görünümünden dosya seçici açmak, uygulamanın işidir. iOS, React Native ve Ionic paketleri bunu zaten yapar; Android ve Flutter için SDK 0.1.4 veya sonrası gerekir. Eski sürümlerde widget kabuğu tanır ve hiçbir şey yapmayan bir buton göstermek yerine ataç simgesini gizler.

iOS'ta, görsellerin kabul edildiği her durumda sistem sayfası Fotoğraf Çek seçeneğini sunar; bunu seçmek, Info.plist dosyasında NSCameraUsageDescription bulunmayan bir uygulamayı çökertir. Sohbeti içeren bir build göndermeden önce bu anahtarı ekleyin.