Для подключения сторонних сервисов или разработки собственных интеграций с keyCRM вам понадобится API-ключ (API Token). Вы можете сгенерировать его самостоятельно в личном кабинете CRM.
Где найти API ключ
- Перейдите в «Настройки» → «Основные»;
- В строке «API-ключ» нажмите «Сгенерировать API-ключ» (если ключ ещё не создан):
Ключ нельзя редактировать, но вам доступны два действия:
- «Копировать» — кнопка для копирования значения ключа;
- «Обновить» — кнопка (доступна только владельцу CRM), которая аннулирует текущий ключ и генерирует новый.
Важно! Если вы обновили API-ключ, старый ключ полностью удаляется и перестает работать. Вам нужно будет указать новый ключ во всех действующих интеграциях, где он использовался.
Как использовать API-ключ
Сгенерированный ключ используется для авторизации запросов к нашей системе через API. Для этого необходимо передавать заголовок в формате Bearer + APIkey:
"headers":{"authorization":["Bearer ваш-API-ключ"]}Ограничения и лимиты API:
- Лимит: до 20 запросов в минуту на один API-ключ (делайте интервал в 3 секунды между запросами);
- Превышение: при превышении лимита запросы начнут возвращать ошибку «429 Too Many Requests»;
- Блокировка: за регулярное нарушение лимитов доступ к API для CRM может быть заблокирован.
Полезные ссылки:
- Документация API: Ссылка на техническую документацию находится прямо под значением ключа в личном кабинете. В ней собраны все доступные методы, параметры, а также примеры запросов и ответов;
- Возможности API: Чтобы узнать, какие именно данные можно передавать и какие процессы автоматизировать, ознакомьтесь с этой статьёй.
- Часто задаваемые вопросы: Если у вас возникли сложности при настройке, ознакомьтесь с FAQ, особо обратите внимание на советы по оптимизации запросов, чтобы не получить блокировку из-за превышения лимитов API.
KeyCRM - с нами создавать надежное подключение просто!
Теги: ключ API, APIkey, API token, API токен, подключение API, ключ интеграции, авторизация API.
