Для підключення сторонніх сервісів або розробки власних інтеграцій з 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, ключ інтеграції.
