Налаштування API

Сторінка «Налаштування API» призначена для отримання та управління ключами доступу для інтеграції bims із зовнішніми системами. Тут ви можете переглядати поточні ключі, оновлювати їх у разі необхідності та отримувати приклади запитів для створення лідів через API. Це дозволяє автоматизувати процеси та інтегрувати систему з вашим сайтом або іншими сервісами.

Терміни

• API-ключ — унікальний ідентифікатор довжиною 32 символи для доступу до системи ззовні
• Client ID — ідентифікатор клієнта довжиною 26 символів, що використовується разом з API-ключем
• Інтеграція — підключення зовнішніх систем до bims для обміну даними
• Лід — вхідне звернення потенційного клієнта, яке можна створити через API
• POST-запит — метод відправки даних для створення нового запису в системі
• Заголовок запиту — службова інформація, що передається разом із запитом (Content-Type, Accept)
• Тіло запиту — основні дані, що надсилаються в системі у форматі JSON

Загальний огляд

Користувач бачить картку з двома основними блоками: API_KEY та CLIENT_ID. Кожен блок містить значення ключа, кнопку копіювання та (для API-ключ) кнопку оновлення. Нижче розташований розгортуваний блок з прикладом створення ліда через API, що містить URL, заголовки, параметри запиту та приклад cURL-команди. У верхній частині доступна кнопка «Зберегти» для користувачів з відповідними правами.

Основні можливості

Перегляд ключів доступу

Користувач бачить поточні значення API-ключ та Client ID у відповідних полях. Ключі відображаються у текстовому форматі для зручного копіювання. Ця інформація необхідна для налаштування інтеграцій з зовнішніми системами.

Копіювання ключів

Кожен ключ має кнопку копіювання з іконкою. Натискання кнопки миттєво копіює значення у буфер обміну. Це дозволяє швидко вставити ключ у код або налаштування зовнішньої системи без ризику помилок.

Оновлення API-ключ

Користувачі з правом api.edit можуть оновити API-ключ натисканням кнопки «Оновити». Перед оновленням система запитує підтвердження у діалоговому вікні. Новий ключ генерується автоматично та замінює попередній.

Збереження налаштувань

Кнопка «Зберегти» доступна у верхній частині сторінки для користувачів з відповідними правами. Натискання кнопки зберігає поточні налаштування на сервері. Зміни застосовуються миттєво після збереження.

Приклад використання API

Розгортуваний блок «Ліди» містить детальну інструкцію зі створення ліда через API. Вказано URL запиту, необхідні заголовки та параметри тіла запиту. Наведено готовий приклад cURL-команди з підставленими значеннями ключів.

Покрокові сценарії

Як скопіювати API-ключ

1. Відкрийте розділ Налаштування → API.
2. Знайдіть блок API_KEY у верхній частині картки.
3. Натисніть кнопку Копіювати з іконкою праворуч від значення ключа.
4. Ключ скопійовано у буфер обміну — вставте його у вашу систему.

Як оновити API-ключ

1. У розділі Налаштування → API натисніть кнопку Оновити біля API_KEY.
2. Підтвердіть дію у діалоговому вікні.
3. Система згенерує новий ключ та відобразить його у полі.
4. Оновіть інтеграції новим ключем — старий перестане працювати.

Як використати API для створення ліда

1. Скопіюйте API_KEY та CLIENT_ID з відповідних полів.
2. Підготуйте POST-запит на URL: https://bims.com.ua/api/i/lead.
3. Додайте заголовки: Content-Type: application/json, Accept: application/json.
4. У тілі запиту вкажіть: api_key, client_id, name, phone, body.
5. Надішліть запит — лід буде створено в системі.

Як налаштувати інтеграцію з сайтом

1. Отримайте ключі у розділі Налаштування → API.
2. Додайте ключі у код форми зворотного зв'язку на сайті.
3. Налаштуйте відправку даних через POST-запит при заповненні форми.
4. Протестуйте інтеграцію — ліди мають з'являтися у bims автоматично.

💡 Корисні поради

💡 Захист ключів — не передавайте API-ключ третім особам та не публікуйте його у відкритому доступі.

💡 Оновлення ключа — при зміні API-ключ усі існуючі інтеграції потрібно оновити новим значенням.

💡 Перевірка запиту — тестуйте API-запити перед впровадженням, щоб уникнути помилок у передачі даних.

💡 Ліміти символів — поле name обмежене 100 символами, phone — 20 символами, body — 1000 символів.

💡 Формат даних — використовуйте формат JSON для тіла запиту та вказуйте правильні заголовки Content-Type.

💡 Моніторинг — регулярно перевіряйте логи інтеграцій для своєчасного виявлення проблем з доступом.