REST API

REST API tawk.to позволяет сэкономить время, автоматизируя задачи от имени ваших операторов.

Каждый администратор проекта tawk.to может использовать наши вебхуки для отправки данных с tawk.to в стороннюю систему. Например, вы можете использовать вебхуки для добавления новой записи в электронную таблицу или панель управления проектом каждый раз, когда создается заявка.

Вебхуки могут быть созданы для трех типов событий:

• начало чата
  
• завершение чата
• создание заявки

Наш REST API позволяет запрашивать дополнительные данные у tawk.to.

Примечание. Чтобы использовать REST API, вам потребуется разработчик или умение писать код.

Чтобы использовать REST API, вам для начала нужно запросить доступ: https://www.tawk.to/rest-api-beta-access-request/

Когда ваш запрос будет одобрен, вы получите ссылку на документацию с логином и паролем.

Что вы можете использовать REST API?

Вы можете использовать REST API для извлечения, создания, обновления и удаления ресурсов. Вот лишь несколько способов использования REST API на tawk.to:

• Автоматически создавать проекты для ваших клиентов
• Автоматически приглашать клиента в проект
• Читайте историю переписки
• Управлять веб-хуками
• Автоматически создавать новую вкладку
• Управлять своей базой знаний
• Создавать новую статью в базе знаний
• Получать список статей и категорий базы знаний для проекта
• Создавать или удалять новый виджет чата для своего проекта
• Добавлять, удалять или обновлять карточку виджета
• Получать отфильтрованный список заявок, чатов или членов проекта
• Получать определенную статистику чата
• Фильтровать статистику чата для проекта по агенту, тегу, отделу, дате и т. д.

API состоит из методов в стиле HTTP RPC, все формы имеют вид https://api.tawk.to/v1/METHOD.

Все методы должны вызываться с использованием HTTPS. Аргументы могут быть переданы в теле запроса POST. Ответ будет содержать объект JSON, который всегда будет содержать логическое свойство верхнего уровня ok, указывающее, был ли ответ успешным или нет. В случае сбоя свойство ошибки будет содержать короткий машиночитаемый код ошибки.

Вы должны проходить аутентификацию для всех запросов, и все запросы должны выполняться через HTTPS.

Ключ API

Если вы используете ключ API, запросы будут аутентифицироваться с помощью базовой аутентификации HTTP.

Обратитесь в службу поддержки, чтобы запросить бета-доступ к REST API. После включения выполните следующие действия, чтобы получить ключ REST API:

1. Войдите в свою панель управления tawk.to.

2. Выберите изображение своего профиля в правом верхнем углу.

3. Выберите Редактировать профиль в выпадающем меню.

4. Выберите ключи REST API.

5. Нажмите Создать ключ, чтобы получить новый ключ.

Если вы используете OAuth2, вам потребуется получить токен доступа, следуя процедуре OAuth2.

В настоящее время мы поддерживаем два потока авторизации: код авторизации и поток неявного предоставления разрешения.

При использовании кода авторизации сначала необходимо получить код. Затем вы обменяете его на токен доступа и токен обновления. Обмен требует от вас ввода секретного ключа клиента и должен выполняться на стороне сервера. Секретный ключ клиента должен храниться в тайне. Не распространяйте свой клиентский секретный ключ по электронной почте, распространяемым собственным приложениям, клиентскому JavaScript или общедоступным репозиториям кода. Вы можете использовать токен обновления, чтобы продлить срок действия токена доступа.

При использовании потока неявного предоставления разрешения вы можете получить токены доступа, которые недолговечны и не могут быть продлены. Неявный поток предоставления следует использовать, если клиент не может поддерживать конфиденциальность своих учетных данных (например, при работе с распределенными собственными приложениями, клиентским JavaScript и т. д.).

Запросите доступ к REST API здесь: Получить бета-доступ к REST API

Ознакомьтесь с нашей документацией по JavaScript API на платформе разработчиков tawk.to.