Dokumentacja
Osadzenie widgetu
Jeden znacznik skryptu przed zamknięciem strony. Bez zależności, bez pobierania czegokolwiek z serwerów innych firm, bez zmian w Waszym kodzie.
Snippet
Klucz organizacji znajdziecie w panelu. Jest publiczny z założenia i leży w kodzie Waszej strony.
<script src="https://aivatary.com/assets/caip-widget.js"
data-tenant-key="pw_0123456789abcdef"
data-api-base="https://app.aivatary.com"
defer></script>Dlaczego klucz może być publiczny
Klucz organizacji nie jest sekretem. Widget wymienia go na krótkotrwały token sesji, a dostęp jest dodatkowo ograniczony listą dozwolonych domen. Żaden sekret nigdy nie trafia do przeglądarki, więc skopiowanie snippetu na cudzą stronę niczego nie daje.
Atrybuty opcjonalne
| Atrybut | Domyślnie | Znaczenie |
|---|---|---|
| data-tenant-key | wymagany | Publiczny klucz Waszej organizacji |
| data-api-base | wymagany | Adres, pod którym działa platforma |
| data-theme-attr | data-theme | Nazwa atrybutu na elemencie html, z którego czytany jest motyw |
| data-locale | język strony, potem pl | Język sesji: pl albo en |
| data-auto-open | desktop | Automatyczne otwarcie panelu: desktop dla okna od 900 pikseli, always, never |
| data-avatar-selector | [data-caip-avatar] | Selektor kontenera, w którym ma stanąć awatar w trybie hero |
Motyw
- Jak jest czytany
- Widget patrzy na atrybut wskazany przez data-theme-attr na elemencie html. Wartość light oznacza motyw jasny, każda inna i brak atrybutu oznaczają ciemny.
- Zmiana bez przeładowania
- Przełącznik motywu na Waszej stronie działa od razu, bo widget śledzi zmianę atrybutu.
- Preferencja systemu
- Widget celowo nie czyta systemowego ustawienia jasnego i ciemnego trybu, tak samo jak ta strona. Decyduje Wasz atrybut, żeby widget nie rozjechał się z resztą strony.
Lista dozwolonych domen
- Gdzie się ustawia
- W ustawieniach organizacji, osobno dla każdej domeny, na której widget ma odpowiadać.
- Co się dzieje poza listą
- Żądanie z domeny spoza listy nie jest obsługiwane. To jest właśnie powód, dla którego publiczny klucz nie musi być sekretem.
- Środowisko testowe
- Domenę testową trzeba dopisać osobno. Adres lokalny też jest domeną.
Widget się nie pokazuje
Czy domena jest na liście dozwolonych?
Najczęstsza przyczyna. Sprawdźcie, czy wpisana jest dokładnie ta domena, z której otwieracie stronę, razem z ewentualnym przedrostkiem www.
Czy skrypt się wczytał?
W karcie sieci narzędzi przeglądarki powinien być widoczny plik widgetu. Blokada przez rozszerzenie do blokowania reklam bywa drugą najczęstszą przyczyną.
Czy klucz jest poprawny?
Klucz zaczyna się od przedrostka pw_ i pochodzi z panelu Waszej organizacji. Klucz z innego środowiska nie zadziała.
Czy strona nie ładuje widgetu dwa razy?
Widget ma zabezpieczenie przed podwójnym załadowaniem, ale dwa różne klucze na jednej stronie to konflikt konfiguracji, a nie sytuacja do obsłużenia.
Czy widget nie jest przykryty?
Element o bardzo wysokiej wartości warstwy potrafi go zasłonić. Widget rysuje się we własnym drzewie, więc nie da się tego poprawić Waszym stylem, tylko trzeba obniżyć warstwę elementu zasłaniającego.
Następny krok: awatar w treści strony
Jeśli chcecie, żeby rozmowa startowała w miejscu postaci, a nie w dymku w rogu, przejdźcie do trybu hero.