Для чого
API — спосіб, у який інша програма, наприклад ваша CRM, сама бере дані з системи або щось у ній змінює. Така програма підключається не логіном людини, а окремим ключем зі своїм переліком прав, лімітом запитів і слідом у журналі. Тут адміністратор видає й відкликає ключі та налаштовує вебхуки — повідомлення, які система сама надсилає вашому серверу, коли щось стається. Ключі API входять не в кожен тариф.
Що на екрані
- 1
Якщо API не входить у тариф
На місці форм ключів і підписок на події — замок із назвою тарифу, з якого API стає доступним, і посилання «Подивитися тарифи». Підписки, створені раніше, видно й під замком: вони далі отримують події, і їх можна видалити.
- 2
Новий ключ
Назва, права й ліміт запитів на хвилину. «Готові набори» ставлять типові права одним натисканням; права з позначкою ⚠ дозволяють змінювати дані, а не лише читати.
- 3
Ключі
Усі видані ключі: початок ключа, права, ліміт, скільки разів ним користувалися й коли востаннє. «Відкликати» вимикає ключ одразу й назавжди — інтеграція, що на ньому працює, зупиниться.
- 4
Підписки на події
Вебхук — повідомлення, яке система сама надсилає на адресу вашого сервера, наприклад коли завершився дзвінок. Секрет підпису показується один раз: за ним ваш сервер перевіряє, що повідомлення справді від нас. «Видалити» просить підтвердження: видалену підписку не відновити, лише додати заново з новим секретом.
- 5
Як підключитися
Довідка для того, хто налаштовує інтеграцію: як передати ключ, основні адреси запитів із потрібними правами й що означають відмови 401, 403 і 429. Ключ бачить дані лише свого воркспейсу.
Типові дії
Підключити CRM лише на читання
- У картці «Новий ключ» впишіть «Назву ключа», наприклад «HubSpot відділу продажів».
- Натисніть готовий набір «Тільки читання».
- Натисніть «Створити ключ» і одразу скопіюйте його кнопкою «Копіювати» — пізніше його вже не показати.
- Передайте ключ тому, хто налаштовує CRM, разом із карткою «Як підключитися».
Відкликати ключ, який більше не потрібен
- Знайдіть ключ у переліку «Ключі» за назвою й початком.
- Натисніть «Відкликати» й підтвердіть.
- Якщо інтеграція ще потрібна — створіть новий ключ і передайте його.
Отримувати повідомлення про завершені дзвінки
- У «Підписках на події» впишіть адресу свого сервера, що починається з https.
- Розгорніть «Обрати теми (порожньо — усі)» і позначте call.completed.
- Натисніть «Додати підписку» й одразу збережіть секрет підпису — його показують один раз.
Часті питання
Я не встиг скопіювати ключ. Можна подивитися його ще раз?
Ні. Система зберігає не сам ключ, а лише його зашифрований відбиток, тому показати його повторно не може ніхто, навіть адміністратор. Відкличте цей ключ і створіть новий.
Чому інтеграція отримує відмову, хоча ключ правильний?
Відповідь 403 означає, що ключу бракує права, і в повідомленні сказано, якого саме. Права не включають одне одного: «leads:write» не дає читати ліди, для цього окремо потрібне «leads:read». Відповідь 429 — перевищено ліміт запитів на хвилину.
Що буде, якщо наш сервер не приймає вебхуки?
Кожне повідомлення система пробує доставити кілька разів із дедалі довшими паузами. Біля підписки видно, скільки невдач поспіль; після 20 невдалих доставок поспіль підписка вимикається з поясненням причини. Щоб отримувати події знову, видаліть її й додайте заново.
Чи бачить ключ дані інших воркспейсів?
Ні. Ключ бачить дані лише того воркспейсу, в якому його створили, і це обмеження стоїть у самій базі даних, а не лише в програмі.