Облачная платформаEvolution

Аутентификация в API


Для аутентификации в API:

  1. Создайте сервисный аккаунт.

  2. Сгенерируйте API-ключ или токен доступа.

1. Создайте сервисный аккаунт

  1. На верхней панели слева нажмите Кнопка с изображением девяти точек и перейдите в раздел Пользователи → Сервисные аккаунты.

    ../_images/s__service_account.webp
  2. В правом верхнем углу нажмите Создать аккаунт.

    ../_images/s__service_account_create.webp
  3. Задайте для сервисного аккаунта название и описание.

  4. Выберите уровень аккаунта:

    • Организация — чтобы назначить роли в организации, проектах или сервисах. Управлять таким сервисным аккаунтом сможет только администратор организации.

    • Проект — можно назначить роли в рамках только одного проекта.

    Примечание

    Уровень аккаунта нельзя изменить после создания.

  5. Нажмите Продолжить.

  6. Назначьте роль внутри проекта — Администратор проекта или Пользователь проекта.

    Роль определяет права доступа сервисного аккаунта.

    ../_images/s__service_account_roles.webp
  7. Нажмите Создать.

Созданный сервисный аккаунт появится в списке со статусом «Активен».

2. Сгенерируйте API-ключ или токен доступа


Для создания персонального API-ключа:

  1. На верхней панели слева нажмите Кнопка с изображением девяти точек и перейдите на вкладку Пользователи → Сервисные аккаунты.

  2. Нажмите на название сервисного аккаунта, который будете использовать для отправки запроса.

  3. В разделе Учетные данные доступа на вкладке API-ключи нажмите Создать API-ключ.

    ../_images/s__api-ref__authentication1.webp
  4. Введите название и описание API-ключа, которое поможет в будущем идентифицировать его среди других ключей.

  5. Заполните параметры API-ключа:

    • Сервисы — Evolution AI Agents.

    • Адреса (опционально) — перечень IP-адресов и подсетей, из которых может использоваться API-ключ. Поддерживаются форматы протоколов IPv4 и IPv6.

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

    • Интервал работы ключа — один или несколько интервалов времени, в которые можно использовать API-ключ.

  6. Нажмите Создать.

  7. Сохраните данные API-ключа — Key Secret.

    После закрытия окна Key Secret будет недоступен. Созданный API-ключ появится в списке ключей со статусом «Активен». Подробнее о работе с API-ключом.