Подключение ваших инструментов через API
API позволяет стороннему приложению программно обращаться к данным вашей организации: составу участников, календарям, бронированиям и биллингу. Он включается в два клика и защищается ключом, списком разрешённых адресов и контролем потребления.
Понять, нужен ли вам API
API предназначен для разработчика, а не для руководителя организации. Он служит для связи вашего аккаунта с программой, которую вы заказываете или настраиваете: индивидуальным сайтом, бухгалтерским инструментом, собственным информационным экраном, шлюзом к другой системе.
Для повседневных задач — получить список участников, массово обновить абонементы, передать цифры правлению — модули импорта, экспорта и отчётов справятся без единой строчки кода.
API предлагается в бета-версии: его работа ещё может меняться.
Включить API и получить ключ
- Перейдите в Администрирование›Настройки›API BETA.
- Включите Активировать модуль API, затем нажмите Сохранить.
- Отобразится ваш Ключ API: скопируйте его кнопкой Копировать и передайте только тому инструменту, который вы подключаете.
Ключ передаётся в HTTP-заголовке X-API-Key каждого запроса. Вызовы выполняются исключительно по HTTPS; незашифрованные запросы не принимаются.
Защитить ключ
Несколько правил стоит напомнить инструменту или подрядчику, который его использует:
- никогда не сохранять ключ в репозитории кода; хранить его в конфигурационном файле вне репозитория или в менеджере секретов;
- ограничивать разрешённые адреса, как только инструмент обращается с постоянного сервера;
- перегенерировать ключ при малейшем сомнении — случайная публикация, утечка журналов, завершение работы подрядчика.
Кнопка Перегенерировать запрашивает подтверждение, затем немедленно аннулирует старый ключ. Все приложения, которые его использовали, перестают работать, пока не получат новый: предупредите их до нажатия.
Ограничить доступ по IP-адресу
Включите Ограничение по IP-адресу: принимаются только запросы с перечисленных вами адресов, не более 10 адресов IPv4. Введите каждый адрес и подтвердите кнопкой Добавить; ваш текущий адрес показан на экране для подсказки.
Это самая эффективная и чаще всего забываемая защита: даже раскрытый ключ, ограниченный адресом вашего подрядчика, останется непригодным в другом месте.
Следить за потреблением
Экран постоянно показывает, сколько потребляет ваш ключ:
- Используется в эту минуту и Использование сегодня, каждый в сопоставлении со своим лимитом, если лимит настроен;
- Статистика использования: Эта неделя, В этом месяце, Итого и Последний запрос.
При превышении указанных лимитов дополнительные запросы временно отклоняются. Счётчик, постоянно упирающийся в потолок, обычно указывает на плохо настроенный инструмент, который циклически запрашивает одни и те же данные вместо их кэширования.
Дата последнего запроса полезна в обратную сторону: ключ, включённый, но ни разу не использованный за несколько месяцев, — это ключ, который стоит отключить.
Узнать возможности API
Полная документация с параметрами и примерами вызовов отображается внизу экрана модуля. В общих чертах:
- Пользователи: это единственный изменяемый ресурс. Вы можете выводить список аккаунтов, просматривать, создавать, изменять и удалять их.
- Конфигурация: абонементы, профили, группы и возрастные категории доступны для просмотра, но настраиваются только в приложении.
- Бронирование: календари, доступные слоты, бронирования и метки доступны для просмотра.
- Биллинг: биллинговые аккаунты, заказы и платежи доступны для просмотра.
