Перейти к основному содержимому
Версия: 2507.3

Управление API-ключами

Подаздел «Интеграции и API» предназначен для настройки доступа к интеграционному API на уровне организации. Через него можно создавать, просматривать и блокировать API-ключи, обеспечивающие интеграцию внешних систем с нашей системой.

Страница подраздела «Интеграции и API»​

На странице отображается список всех API-ключей, включая:

  • Активные - действующие и не заблокированные;
  • Заблокированные - заблокированные вручную или автоматически;
  • Просроченные - истёкшие по сроку действия.

Для каждого ключа отображается:

  • Название;
  • Дата создания;
  • Срок действия;
  • Сгенерированный ключ;
  • Статус (активен, заблокирован, просрочен);
  • Автор создания ключа;
  • Действия с ключом.

Создание и генерация нового API-ключа​

Чтобы создать новый ключ:

  1. На странице раздела «Интеграционное API» нажмите кнопку «Сгенерировать API-ключ».

    Результат шага: откроется форма создания нового ключа.

    Форма создания нового ключа»

    Форма создания нового ключа»

  2. Заполните поля формы:

    • Название — обязательное поле. Допускается ввод русских и латинских символов, цифр, а также символов «–» и «_».
    • Срок действия — обязательное поле. Выберите дату в формате дд.мм.гггг или значение «Без истечения срока».

  3. Нажмите кнопку «Сгенерировать».

    Результат шага: в списке появится новый ключ с автоматически сгенерированным значением.

    Список сгенерированных API-ключей»

    Список сгенерированных API-ключей»

  4. После создания ключа вы можете скопировать его значение прямо со страницы, нажав соответствующую кнопку.

Действия с API-ключами​

Для каждого ключа доступны действия:

  • «Заблокировать» — прекращает работу интеграции по данному ключу. После блокировки все запросы с использованием этого ключа становятся недействительными.
  • «Разблокировать» — возобновляет использование ключа (если срок действия не истёк).
  • «Редактировать» — позволяет изменить название.
к сведению

Срок действия и сгенерированное значение ключа изменить нельзя.

Правила работы с API-ключами​

  • Заблокированные или истёкшие ключи не могут использоваться для выполнения запросов к интеграционному API.
  • API-ключ каждой организации действует только в её пределах — использовать ключ другой организации для доступа к данным нельзя.
  • В одной организации может быть создано несколько действующих ключей.
  • При необходимости можно задать ключ без срока действия, но рекомендуется указывать конкретный период в целях безопасности.