Підключення ваших інструментів через API

API дозволяє сторонньому застосунку програмно отримувати доступ до даних вашої організації: склад учасників, календарі, бронювання та виставлення рахунків. Він активується у два кліки та захищається ключем, списком дозволених адрес і відстеженням споживання.

Дізнайтеся, чи потрібен вам API

API призначений для розробника, а не для керівника організації. Він служить для обміну даними між вашим обліковим записом і програмним забезпеченням, яке ви створюєте або налаштовуєте: індивідуальний вебсайт, бухгалтерський інструмент, власне інформаційне табло, шлюз до іншої системи.

Для поточних потреб — отримати список членів, масово оновити підписки, передати цифри правлінню — модулі імпорту, експорту та звітів вирішують завдання без жодного рядка коду.

API пропонується у бета-версії: його робота ще може змінюватися.

Активуйте API та отримайте свій ключ

1. Перейдіть до Адміністрування›Налаштування›API BETA.
2. Активуйте Активувати модуль API, потім натисніть Зберегти.
3. Відображається ваш Ключ API: скопіюйте його кнопкою Копіювати і передайте лише тому інструменту, який ви підключаєте.

Ключ передається в HTTP-заголовку X-API-Key кожного запиту. Виклики обов'язково виконуються через HTTPS; жоден незашифрований запит не приймається.

Захистіть ключ

Кілька правил варто нагадати інструменту або підряднику, який його використовує:

• ніколи не розміщуйте ключ у репозиторії коду; зберігайте його у файлі конфігурації за межами репозиторію або в менеджері секретів;
• обмежте дозволені адреси, щойно інструмент здійснює виклики з фіксованого сервера;
• згенеруйте ключ заново за найменшої підозри — випадкова публікація, витік журналів, завершення роботи підрядника.

Кнопка Перегенерувати запитує підтвердження, а потім негайно робить старий ключ недійсним. Усі застосунки, які його використовували, припинять працювати, доки не отримають новий: попередьте їх, перш ніж натискати.

Обмежте доступ за IP-адресою

Активуйте Обмеження за IP-адресою: приймаються лише запити з адрес, які ви перелічуєте, у межах 10 адрес IPv4. Введіть кожну адресу, потім підтвердьте за допомогою Додати; ваша поточна адреса відображається на екрані, щоб вам допомогти.

Це найефективніший і найчастіше занедбаний захист: навіть у разі розголошення ключ, обмежений адресою вашого підрядника, залишається непридатним для використання в іншому місці.

Відстежуйте споживання

Екран постійно показує, що споживає ваш ключ:

• Використання цієї хвилини і Використання сьогодні, кожен у співвідношенні зі своїм обмеженням, коли обмеження налаштоване;
• Статистика використання: Цього тижня, Цього місяця, Загалом та Останній запит.

Понад зазначені обмеження додаткові запити тимчасово відхиляються. Показник, який постійно наближається до своєї межі, зазвичай свідчить про погано налаштований інструмент, який раз за разом запитує ті самі дані замість того, щоб кешувати їх.

Дата останнього запиту корисна у зворотному сенсі: ключ, активований, але жодного разу не використаний упродовж місяців, — це ключ, який слід деактивувати.

Дізнайтеся, що дозволяє API

Повна документація з параметрами та прикладами викликів відображається внизу екрана модуля. У загальних рисах:

• Користувачі: це єдиний ресурс, який можна змінювати. Ви можете переглядати список, відкривати, створювати, змінювати та видаляти облікові записи.
• Конфігурація: підписки, профілі, групи та вікові категорії можна переглядати, але налаштовувати лише із застосунку.
• Бронювання: календарі, доступні часові слоти, бронювання та позначки блокування можна переглядати.
• Виставлення рахунків: рахунки для виставлення, замовлення та платежі можна переглядати.