API-токены и REST API

Владелец и Администратор компании открывают Администратор компании → Продажи и интеграции → Интеграции → API и вебхуки. Подключите сайт, ERP или другие инструменты: читайте и записывайте контакты, лиды и сделки через REST API и получайте события в свои системы.

#Создание токена

1. В разделе API-токены выберите Новый токен.
2. Введите Название, например название системы, которая будет его использовать.
3. В поле Действует от имени выберите, от чьего имени вносятся изменения: - Компания: Изменения не привязаны к человеку. Продолжает работать, когда сотрудники уходят. - Я: В изменениях указывается Ваше имя. Перестаёт работать, если Вы потеряете права администратора.
4. В разделе Права отметьте то, что нужно другой системе, например Контакты · чтение или Контакты · запись. Запись включает чтение. Выдавайте только то, что нужно другой системе.
5. Выберите Срок действия и нажмите Создать токен.
6. Скопируйте токен и выберите Я сохранил(а). Токен показывается только сейчас. Сохраните его в настройках секретов Вашей другой системы. Передавайте его так: Authorization: Bearer <token>

Создавайте отдельный токен для каждой системы, чтобы отзывать их по отдельности.

#Работа с API

Выберите Документация API, чтобы увидеть методы, поля и примеры. API охватывает контакты, лиды, сделки и компании: список, чтение, создание и изменение. Удалять записи через API нельзя.

• Списки возвращают до 50 записей на страницу (не более 100 с limit) и nextCursor для следующей страницы.
• Каждый токен может делать 120 запросов в минуту. При превышении API отвечает 429 с заголовком Retry-After.
• Каждое изменение через токен записывается в журнал аудита с названием токена.

#Отзыв токена

Выберите Отозвать рядом с токеном. Системы, использующие этот токен, сразу перестанут работать. У каждого токена видно, когда он использовался последний раз, — так легко найти ненужные.