Публичный API Chatway позволяет подключать ваши приложения и сервисы к Chatway.
Используя API, вы можете управлять контактами, получать доступ к переписке и отправлять сообщения, не используя панель управления Chatway. Ваша система может отправлять запросы непосредственно в Chatway для автоматического выполнения этих действий. Это полезно, если вы хотите связать Chatway с такими инструментами, как:
- МРС
- Платформы электронной коммерции
- Инструменты поддержки клиентов
И многое другое.
Обратите внимание, что эта функция доступна во всех тарифных планах, включая бесплатный.
Пожалуйста, ознакомьтесь с официальной документацией API Chatway здесь.
Что можно делать с API Chatway
Вы можете использовать API Chatway для автоматизации распространенных рабочих процессов в чате. Примеры включают:
• Создание и обновление контактных данных посетителей
• Получение переписок и сообщений в чате
• Отправка сообщений из вашей системы
• Автоматическое завершение диалогов
• Синхронизация данных чата с внешними инструментами, такими как CRM-системы.
Это позволяет интегрировать Chatway в ваши существующие системы и рабочие процессы.
Генерация ключа API в Chatway
Для использования API необходимо сначала создать ключ API. Чтобы сгенерировать его:
Шаг 1 : Откройте панель управления Chatway и нажмите «Настройки»:
Обратите внимание, что генерировать ключи API могут только администраторы и владельцы .
Шаг 2 : Нажмите на «Инструменты разработчика».
Шаг 3 : Нажмите здесь на кнопку «Сгенерировать ключ API» и на следующем шаге присвойте ключу API имя.
Шаг 4: После создания ключа обязательно скопируйте его и надежно сохраните.
Chatway отобразит полный API-ключ только один раз при его создании. После создания в вашей панели управления будет отображаться лишь его часть. Например:
Важные ограничения:
• Вы можете иметь до 5 активных API-ключей.
• Вы можете отозвать ключи в любое время.
• Отозванные ключи восстановить невозможно.
Аутентификация API-запросов
В каждом API-запросе в заголовке запроса должен содержаться ваш API-ключ. Например:
X-API-KEY: ваш_ключ_API_здесь
Если ключ API отсутствует или недействителен, запрос не будет обработан. Вместо этого будет возвращена ошибка 401 Unauthorized. Например:
Базовый URL
Все запросы к API Chatway используют следующий базовый URL:
https://developers.chatway.app/api/v1Примеры URL-адресов запросов, которые вы можете использовать:
https://developers.chatway.app/api/v1/contacts (lists contacts)Ограничения скорости
Для обеспечения стабильной работы API Chatway ограничивает количество запросов. API Chatway допускает до 60 запросов в минуту на один API-ключ. Если ваше приложение превысит этот лимит, дополнительные запросы могут быть временно отклонены.
Основные области API
API Chatway организован по нескольким основным направлениям.
Контакты
API контактов позволяет управлять информацией о посетителях. Примеры использования:
| Экшн | Конечная точка | Пример использования |
| Создать контакт | POST | Добавляйте новых посетителей, когда кто-то регистрируется на вашем сайте. |
| Обновить контакт | PATCH | Обновляйте информацию о посетителях, когда они меняют свой адрес электронной почты или тарифный план. |
| Получить контакт | GET | Получите полный профиль и историю чатов пользователя. |
| Список контактов | GET | Получите доступ ко всем своим контактам из Chatway. |
Conversations
API для работы с диалогами позволяет получать доступ к чатам и управлять ими. Примеры использования:
| Экшн | Конечная точка | Пример использования |
| Получить список бесед | GET | Отображение чатов Chatway в панели управления CRM. |
| Получайте сообщения в диалоге | GET | Получить всю историю переписки в чате. |
| Разрешить разговор | POST | Автоматическое разрешение чатов при закрытии заявки в другой системе. |
Сообщения
API сообщений позволяет вашей системе отправлять сообщения через Chatway, например:
• Подтверждение заказа
• Уведомления о доставке
• Обновления поддержки
Например:
| Экшн | Конечная точка | Пример использования |
| Отправить | POST | После завершения заказа отправьте благодарственное сообщение. |
Кроме того, вы можете управлять виджетами и данными агентов, используя API Chatway.
Обработка ошибок
Если запрос не удается, API возвращает ответ с ошибкой и кодом состояния. К распространенным кодам состояния относятся:
• 200 — Запрос выполнен успешно
• 201 — Ресурс успешно создан
• 401 — Несанкционированный запрос
• 404 — Ресурс не найден
• 422 — Ошибка проверки
Для получения дополнительной информации об ошибке проверьте тело ответа.
Справочник по API
В этом руководстве представлен обзор API Chatway.
Полную техническую информацию, включая параметры запроса, примеры ответов и определения схем, см. в документации по API Chatway.