API-токен — представляет собой уникальный идентификатор. Он даёт ограниченный доступ к определённым ресурсам и сервисам, которые доступны через API приложения. Эти токены играют важную роль в обеспечении безопасности и конфиденциальности пользователей, особенно когда речь идёт о доступе к данным или действиях внутри приложения. Они служат для аутентификации запросов, отправленных на endpoint API, и обычно передаются как параметр или заголовок при отправке запроса на сервер. Сервер сравнивает полученный токен со своей базой данных и либо разрешает, либо запрещает доступ к ресурсам или сервисам.
Для перехода в данную панель необходимо в меню навигации выбрать "Пользователи -> API токены" (Рисунок 1).
Рисунок 1 — Переход в подраздел “API токены”
После этого, откроется страница со списком всех токенов, которые есть в системе (Рисунок 2).
Рисунок 2 — Главная страница с API токенами
Главная страница с токенами
Вся информация отображается в табличном виде. При нажатии на любое "Имя" токена откроется модальное окно, в котором можно отредактировать данные выбранного токена (Рисунок 3, 4).
Рисунок 3, 4 — Настройки токена
Фильтры
В верхней части страница расположены "Фильтры", которые помогут найти конкретный токен, с помощью одного из параметров (Рисунок 5):
- Имя;
- Пользователи;
- Срок действия истекает менее чем через;
- Создано пользователями;
- Состояние.
Рисунок 5 — Результат поиска с помощью фильтра
Создание нового пользователя
Для создания нового токена необходимо нажать кнопку в правом верхнем углу “Создать API токен” (Рисунок 6).
Рисунок 6 — Кнопка “Создать API токен”
Далее откроется модальное окно, в котором необходимо указать следующие данные (Рисунок 7):
- Имя — название API токена;
- Пользователь — пользователь, к которому будет присвоен данный токен. Для выбора пользователя необходимо нажать на кнопку "Выбрать" или начать вводить "Имя пользователя" в текстовое поле;
- Описание — краткое описание для данного токена;
- Задать дату и время срока действия — включение / выключение функции. Позволяет задать время, на которое действителен данный токен;
- Истекает — указывается время, на которое действителен данный токен (активно, если включена функция "Задать дату и время срока действия");
- Активировано — включение / выключение API токена.
Рисунок 7 — Создание нового токена
Введя, все необходимые данные нужно нажать на кнопку "Добавить" (Рисунок 8).
Рисунок 8 — Сохранение нового токена
После этого, появится окно, которое сообщит, что токен успешно добавлен. Закрыв данное окно Вас перебросит на главную страницу с токенами, где Вы сможете увидеть новый API токен (Рисунок 9, 10).
Рисунок 9, 10 — Новый API токен
Проверка работоспосбоности API токена
Для тестирования токена API Zabbix с использованием cURL выполните следующие шаги:
-
Откройте терминал или командную строку.Введите команду cURL, заменив заполнители на реальные значения:
-
curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer YOUR_API_TOKEN" -d '{"jsonrpc":"2.0","method":"user.login","params":{"user":"YOUR_USERNAME","password":"YOUR_PASSWORD"},"id":1}' http://YOUR_ZABBIX_SERVER/api_jsonrpc.php
-
Замените YOUR_API_TOKEN на сгенерированный токен API.
-
Замените YOUR_USERNAME на ваше имя пользователя Zabbix.
-
Замените YOUR_PASSWORD на ваш пароль Zabbix.
-
Замените YOUR_ZABBIX_SERVER на URL или IP-адрес вашего сервера Zabbix.
-
Нажмите Enter для выполнения команды.
После выполнения команды проверьте ответ от API Zabbix. Если все прошло успешно, вы должны получить ответ, указывающий на успешность вашего запроса.