Dokumentacja SDK

Każdy zestaw narzędzi Keyda SDK — Android, iOS, React Native, Flutter, Ionic — realizuje ten sam prosty kontrakt. Jeśli używałeś jednego, znasz je wszystkie.

API

Zadzwoń	Co to robi
`init` / `initialize`	Przechowuje Twój Client ID. Waliduje go i zgłasza błąd, jeśli jest nieprawidłowy.
`show`	Wyświetla czat w Twojej aplikacji.
`dismiss`	Zamyka to.
`isShowing`	Czy jest obecnie wyświetlany.

Celowo nie ma tu niczego innego. Żadnego API do wysyłania wiadomości, żadnego licznika nieprzeczytanych wiadomości, żadnego wywołania tożsamości użytkownika — ponieważ żadna z tych funkcji jeszcze nie działa w pełni, a metoda, która nie działa, jest gorsza niż jej brak.

Adres URL, który otwiera każdy pakiet SDK

{baseUrl}/chat/{clientId}

baseUrl domyślnie ustawia się na https://keyda.in/business i można to zastąpić na każdej platformie, w celach testowych lub przy instalacji we własnym zakresie.

Dlaczego widok webowy i ile Cię to kosztuje

Istnieje jeden interfejs czatu obsługiwany przez platformę i każda powierzchnia go ładuje.

Co otrzymujesz: każda zmiana wprowadzona przez właściciela w panelu – kolor akcentu, wiadomość powitalna, nazwa bota, uruchomienie – natychmiast dociera do każdej aplikacji, bez konieczności publikowania nowej wersji. Poprawka pojawia się wszędzie naraz. Czat wygląda identycznie na wszystkich platformach.

Ile to kosztuje: czat wymaga połączenia. Nie ma trybu offline ani jeszcze powiadomień push.

Wolimy, abyś wiedział o tym przed wdrożeniem, niż odkrył to później.

Gwarancje zapewniane przez poszczególne SDK

Wychodzenie poza nawigację. Link do innej domyślnej lokalizacji otwiera się w przeglądarce systemowej zamiast zastępować czat. Bez tego jedno kliknięcie w link w stopce kończy rozmowę klienta bez możliwości powrotu.
Ciągłość konwersacji. Pamięć DOM jest włączona, więc klient, który zamknie aplikację i wróci, znajdzie swój wątek w tym samym miejscu (przez 24 godziny).
Klawiatura nigdy nie zasłania pola wprowadzania.
Bezpieczne obszary są uwzględniane — czat nie jest rysowany pod wcięciem ekranu ani paskiem nawigacji.
Żaden błąd nie powoduje awarii Twojej aplikacji. Nieudane ładowanie wyświetla przycisk ponownej próby.
Żadnych analityk, żadnych identyfikatorów urządzeń, żadnych zależności od firm trzecich. Dodanie zestawu SDK Keyda nie dodaje trackera do Twojej aplikacji.

Format identyfikatora klienta (Client ID)

kb_live_ followed by 8-48 hexadecimal characters

Wszystko inne jest odrzucane podczas inicjalizacji zamiast otwierania błędu 404 przed klientem. Identyfikator klienta (Client ID) jest publiczny z założenia – jest widoczny na każdej stronie internetowej, która osadza widżet – i nie daje możliwości odczytu ani zmiany Twojego konta. Zobacz limity i bezpieczeństwo.

Źródło

Publiczne, na licencji MIT: github.com/KeydaAI/keyda-business-sdks. Wspólna umowa, której przestrzega każdy pakiet, znajduje się w CONTRACT.md na górze tego repozytorium.