API ключи доступа¶
В этой статье
Информация
API-ключ — это удобный способ авторизации для работы с API-запросами к Invapi.
Ключ доступа к API генерируется в личном кабинете панели управления Invapi для доступа ко всему аккаунту или к конкретному серверу. Для получения API ключа для аккаунта нужно следовать следующим инструкциям:
Получение API-ключа для всего аккаунта Invapi¶
-
Зайдите в Invapi в раздел Имя пользователя >> API ключи доступа.
-
Создайте API-ключ, нажав на кнопку
Add new API-key;
- Введите имя ключа для его идентификации в поле Name;
- В выпадающем списке Restrict a new API key only for the server выберите, будет ли ключ относиться ко всему аккаунту (
Any) или к конкретному серверу; - В поле IP ACL укажите IP адреса только с которых будет разрешен доступ по этому ключу или оставьте его пустым для доступа без ограничений;
- В выпадающем списке Set login notification method укажите способ оповещения о доступе к аккаунту по данному API-ключу. Вы можете выбрать из следующих вариантов:
- None - не оповещать о логине;
- E-mail - на электронную почту;
- Webhook - передать информацию о логине через HTTP-вызов (вебхук) на ваш сайт.
- При выборе последних двух вариантов, в поле Notification address (email/URL) введите e-mail или URL для оповещения.
- Отметьте чекбокс Active для активации ключа;
- Нажмите кнопку
Add new API key.
После этого вам будет показан API-ключ.
Внимание
Ключ будет показан только один раз. Обязательно скопируйте и сохраните значение API-ключа. В Invapi хранится только его хэш-значение и если исходный ключ будет утрачен, то его надо будет создать заново!
Редактирование/удаление API-ключа аккаунта Invapi¶
Для редактирования или удаления API-ключа зайдите или в аккаунт или на конкретный сервер, как описано выше при его генерации и кликните на нужный API-ключ. В открывшемся окне во вкладке General info вы можете: - изменить имя ключа (поле Name); - задать IP-адреса, с которых будут запрещены вызовы с его использованием (поле IP ACL); - изменить/установить способ оповещения о входе с данным API-ключом (поле Notification address (email/URL), только для ключей, выдаваемых на весь аккаунт) - включить или временно отключить его (чекбокс Active)
Далее вы можете нажать на кнопку Save API key с сохранить изменения.
Для удаления API-ключа нажмите на кнопку Delete API key
Внимание
API-ключ удаляется без возможности его восстановления.
Использование API-ключа аккаунта Invapi¶
API ключ можно использовать для авторизации в Invapi и получения сессионного токена, необходимого для последующих API-запросов к аккаунту или серверу. Авторизацию через API-ключ можно получить для доступа как ко всему аккаунту через вызов auth/login в зависимости от применяемого API-ключа. Если авторизация прошла успешно и такой ключ найден в базе данных, то система вернет сессионный токен $HOSTKEY_TOKEN.
Просмотр информации об использовании API-ключа aккаунта Invapi¶
Выбрав конкретный ключ для аккаунта и кликнув на него, во вкладке Usage history вы можете посмотреть все логины, произведенные с данным API-ключом за определенный период времени. В выводе будет указан e-mail и IP адрес, с которого производился логин, его успешность, а также дата и время события.
Получение API-ключа аккаунта Invapi без веб-панели¶
Вы также можете получить API-ключ, не использую веб панель управления. Для этого вам необходимо использовать API методы работы с API-ключами. Данные методы можно вызывать из командной строки или встраивать вызовы в ваши веб-решения.