Chat API
Платформа JAICP предоставляет Rest API для интеграции в сторонние приложения. Например, для реализации чата в мобильном приложении, на сайте или в игре.
API предоставляет возможность вести диалог как с ботом, так и с оператором.
Подключение канала Chat API
Авторизуйтесь на платформе JAICP, перейдите в проект. Нажмите на панели управления Каналы > Входящие > Создать канал. Выберите канал для подключения Chat API.
Заполните поля:
- Название — укажите название канала.
- Токен — оставьте пустым.
- Блокировать ввод текста при использовании кнопок — выберите Да, если хотите заблокировать клиенту возможность ввода текстовых сообщений, когда используете кнопки в сценарии.
- Ветка — укажите ветку проекта, которую вы хотите развернуть в канал, по умолчанию
master. Вы также можете выбрать Git-тег или ввести хеш конкретного коммита. - Оператор — выберите операторский канал или оставьте пустым.
- Публикация — автоматически (после каждого сохранения внесенных в проект изменений) или вручную (с помощью кнопки Опубликовать в строке с описанием канала).
Публикацию или деплой сценария нужно выполнять перед запуском чат-бота. На этом этапе происходит сборка чат-бота, проверка синтаксиса сценариев и скриптов, а также проверка прохождения тестов.
Нажмите Создать. Дождитесь всплывающего окна с результатом деплоя. При успешном деплое чат-бот готов к использованию.
Токен
Токен конфигурируется при создании канала и необходим для предоставляемых методов Chat API.
Для получения токена перейдите в окно редактирования созданного канала Chat API. Здесь автоматически заполнилось поле Токен, скопируйте его и используйте для доступа к API.
Также здесь представлены примеры GET и POST запросов.