Ключи API

Управление ключами доступа к API

bg-dots
bg-dots

Раздел Система → Ключи API предназначен для создания и управления постоянными ключами доступа к API сервера с правами администратора. Ключи применяются для интеграции внешних систем и скриптов с API без интерактивного входа в веб-интерфейс.

Список ключей

Отображает созданные API-ключи. При отсутствии ключей таблица пуста (только заголовки столбцов). После создания в таблице появляются строки с параметрами ключа.

  • “Добавить” – открытие диалога “Создать новый ключ API”.
  • “ID” – системный идентификатор ключа.
  • “Название ключа” – имя, заданное при создании; используется для поиска ключа в списке.
  • “Создан” – дата и время создания ключа.
  • “Настройки безопасности” – сведения об ограничениях ключа (в том числе белый список IP, если он задан).

Создать новый ключ API

Открывается кнопкой “Добавить”. Заголовок диалога — “Создать новый ключ API”.

  • “Название ключа” – обязательное имя создаваемого ключа; отображается в столбце “Название ключа” списка.
  • “Белый список IP” – ограничение использования ключа адресами клиентов из списка. Белый список по IP-адресу клиента включается автоматически при добавлении хотя бы одной записи; без записей ограничение по IP не действует.
  • “Добавить” (в блоке белого списка) – добавление IP-адреса или диапазона в список разрешённых клиентов.
  • “Отменить” – закрытие диалога без создания ключа.
  • “Сохранить” – создание ключа и закрытие диалога.

Создание ключа

Шаг 1. Открыть Система → Ключи API.
Шаг 2. Нажать “Добавить”.
Шаг 3. Указать “Название ключа”.
Шаг 4. При необходимости ограничить доступ по IP: в блоке “Белый список IP” нажать “Добавить” и указать адреса клиентов.
Шаг 5. Нажать “Сохранить”. Ключ появляется в списке. Для отказа от создания — “Отменить”.

Oauth 2.0 Мультитенант