API-ключи и документация API

API — способ, с помощью которого другая программа читает разрешённые данные PROChat. Если вы работаете только через сайт, настраивать его не нужно.

Ключи создают владелец и администратор в Интеграции → API-ключи, если действующая подписка включает эту возможность. Ключ храните как пароль.

Для управления ключами нужен действующий вход в выбранную команду. Если во время ожидания запроса сеанс завершён или заменён, войдите снова и повторите действие. Уже созданные API-ключи отзываются отдельно от браузерных сеансов.

Создание ключа

1. Нажмите Создать ключ и введите понятное название, например название подключаемой программы.
2. Выберите доступные подключения и разрешения. Давайте только то, что действительно нужно программе.
3. Укажите срок действия и подтвердите создание.
4. Скопируйте ключ из окна результата и передайте вашему разработчику безопасным способом.

Полное значение показывается при создании и не доступно повторно в общем списке. Если ключ потерян, отзовите его и создайте другой. Не вставляйте ключ в общедоступные страницы или переписку с клиентами.

Подключение внешней программы

Разработчику нужны адрес вашего PROChat, ключ и документация API. В справочнике описаны запросы, ответы, ограничения и примеры. Технические детали не требуется вводить в обычные диалоги.

Разрешения разделены: список обращений, тексты сообщений и сведения карточки могут требовать отдельного доступа. Внутренние заметки через этот API не передаются.

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

Список, состояния и отзыв

В списке видны название, срок и состояние. Истёкший или отозванный ключ не работает. Отозвать прекращает доступ; для замены создайте новый ключ с нужными разрешениями.

Действующие ключи учитываются в лимите тарифа. Список может показывать только часть старой истории; отсутствие старого ключа на странице не доказывает его удаление.

Ограничения и ошибки

Доступ программы не шире прав создателя ключа. Потеря доступа к подключению или окончание подписки может закрыть чтение. Ключ одной команды не открывает данные другой.

Если программа сообщает об ошибке, проверьте срок ключа, разрешения, подписку и доступность выбранного подключения. Ограничения числа запросов нужно учитывать в самой программе.

Для уведомлений о новых событиях используйте исходящие вебхуки. Открытие документации или создание ключа само по себе ничего не отправляет клиентам.