Справочник SDK

Каждый SDK Keyda — Android, iOS, React Native, Flutter, Ionic — реализует один и тот же простой контракт. Если вы использовали один из них, вы освоили их все.

API

Мы намеренно не добавляли ничего лишнего. Ни API для отправки сообщений, ни счетчика непрочитанных, ни идентификации пользователя — потому что ни одна из этих функций пока не работает полноценно, а метод, который не работает, хуже, чем его отсутствие.

URL, который открывает каждый SDK

{baseUrl}/chat/{clientId}

baseUrl по умолчанию https://keyda.in/business и может быть переопределен на каждой платформе для staging или самостоятельной установки.

Почему веб-представление и сколько это вам стоит

Существует единый интерфейс чата, предоставляемый платформой, который загружается на всех поверхностях.

Что вы получаете: изменения, которые владелец вносит в панели управления — цвет акцента, приветственное сообщение, имя бота, запуск — мгновенно отображаются во всех приложениях без необходимости выпуска обновлений. Исправление применяется везде одновременно. Чат выглядит одинаково на всех платформах.

Стоимость: для работы чата требуется подключение. Офлайн-режима нет, push-уведомлений пока тоже.

Мы предпочитаем, чтобы вы знали об этом до запуска, а не обнаружили после.

Гарантирует, что каждый SDK делает

1. Выходы из навигации. Ссылка на любой другой источник открывается в системном браузере вместо замены чата. Без этого одно нажатие на ссылку в нижнем колонтитуле завершает разговор клиента без возможности вернуться.
2. Непрерывность диалога. DOM-хранилище включено, поэтому клиент, который закрыл приложение и вернулся, найдет свою переписку там, где остановился (в течение 24 часов).
3. Клавиатура никогда не закрывает поле ввода.
4. Безопасные зоны учитываются — чат не перекрывается вырезом экрана или индикатором «Домой».
5. Никакая ошибка не достигнет вашего приложения. При неудачной загрузке отображается возможность повторить попытку.
6. Никакой аналитики, никаких идентификаторов устройств, никаких сторонних зависимостей. Добавление SDK Keyda не добавляет трекеры в ваше приложение.

Формат Client ID

kb_live_ followed by 8-48 hexadecimal characters

Все остальное отклоняется при инициализации, а не открывает 404-ю страницу перед клиентом. Client ID является публичным по своей сути — он виден на любом сайте, где встроен виджет, — и не дает возможности читать или изменять ваш аккаунт. См. лимиты и безопасность.

Источник

Публичный репозиторий с лицензией MIT: github.com/KeydaAI/keyda-business-sdks. Общий контракт, которому должен соответствовать каждый пакет, находится в CONTRACT.md в корне этого репозитория.