API-токены
API-токен открывает программный доступ к вашему кабинету APX Chat. С его помощью внешние сервисы и ваши скрипты могут работать с данными платформы через API — например, получать диалоги, создавать сделки или управлять клиентами.
Где найти
Откройте Управление → API токены. Здесь можно создать новый токен, посмотреть существующие и отозвать те, что больше не нужны.
Как создать токен
Откройте раздел
Перейдите в Управление → API токены и нажмите «Создать токен».
Назовите токен
Дайте понятное название — например, «Интеграция с сайтом» или «Синхронизация заказов». Так вы поймёте, где он используется.
Выберите права (scope)
Ограничьте токен только теми правами, которые реально нужны интеграции.
Скопируйте и сохраните
Скопируйте токен сразу после создания и сохраните в надёжном месте — повторно полное значение может не показываться.
Права доступа (scope)
Scope определяет, что разрешено делать с токеном. Принцип тот же, что и с правами сотрудников: выдавайте минимально необходимый набор. Если интеграции нужно только читать диалоги — не давайте ей право на изменение данных.
Токен — это секрет, равносильный паролю. Не публикуйте его в открытом коде, репозиториях и чатах. Если токен мог утечь — отзовите его и создайте новый.
Подробное техническое описание методов API и работы с токенами доступно в документации для разработчиков: /docs/api-tokens.
Отзыв токена
Если токен больше не нужен или скомпрометирован, удалите его в том же разделе. После отзыва запросы с этим токеном перестают работать сразу.
Приложения для переписки — Messaging API
Права переписки назначает только владелец кабинета в этом же разделе. Новые scopes не добавляются старым токенам автоматически. Администратор продолжает управлять обычными CRM/AI-токенами, но не приложениями с правами Messaging API.
При создании выберите тип приложения:
- Автоматизация / бот соблюдает паузу автоматизации. Ответ от имени приложения не требует выбора сотрудника.
- Рабочее место сотрудника — явно разрешённое владельцем внешнее приложение. Оно может отвечать при паузе бота только от имени выбранного сотрудника с действующим правом ответа. Тип приложения после создания неизменяем; для другого типа создайте отдельное приложение.
Выберите доступные каналы. Пустой список полностью закрывает доступ к диалогам. Чтобы разрешить отправку от имени сотрудника, выдайте messaging_send_as_employee и выберите существующих авторов APX. Пустой список авторов отключает такую отправку, но не выдаёт и не отзывает права самого сотрудника. Эти права меняются только в едином центре «Сотрудники и доступ». Подпись «API: название приложения» сохраняется во всех случаях.
| Scope | Возможность |
|---|---|
messaging_read | Чтение доступных диалогов и публичной истории |
messaging_send | Отправка сообщения в диалог |
messaging_send_as_employee | Отправка от имени явно разрешённого сотрудника |
messaging_start | Первый контакт, если его поддерживает канал |
messaging_handoff | Передача сотруднику с остановкой автоматизации |
messaging_response_resolve | Снятие ожидания ответа с проверкой актуальной версии |
messaging_upload | Загрузка файлов для публичного ответа |
messaging_events_read | Чтение событий переписки |
Ответ API по умолчанию сохраняет ожидание ответа. Принятие запроса не означает доставку клиенту. Повторять отправку нужно с тем же идентификатором сообщения и ключом идемпотентности. При конфликте версии настроек обновите карточку, проверьте актуальные разрешения и сохраните заново.
В настройках webhook событие «Переписка Messaging API» подключает доставку событий сообщения, его доставки, ожидания ответа, передачи и управления ботом. Для подписки нужны secret и действующее приложение со scopes messaging_read и messaging_events_read. Подпиской управляет владелец. Внутренние заметки и их файлы в Messaging API не передаются.