Доступ к API

Все запросы к API выполняются к хосту https://api360.yandex.net/.

Яндекс 360 для бизнеса авторизует приложения с помощью OAuth-токенов. Чтобы использовать протокол OAuth при работе с Яндекс 360:

  1. Зарегистрируйте свое OAuth-приложение:

    1. Авторизуйтесь на Яндексе. Укажите логин и пароль администратора организации, от имени которого будут выполняться запросы к API.

    2. Откройте страницу создания приложения.

    3. Укажите название вашего сервиса и при необходимости прикрепите иконку.

    4. Выберите платформы, на которых будет работать ваше приложение, и укажите их параметры.

      Если вы разрабатываете или тестируете приложение, используйте отладочный токен. Для получения такого токена выберите Веб-сервисы и в поле Redirect URI подставьте значение по умолчанию, которое появится в подсказке Подставить URL для отладки: https://oauth.yandex.ru/verification_code.

    5. Укажите необходимые права доступа. На текущий момент в API поддерживаются следующие права:

      Яндекс 360 Directory API

      • Чтение данных об организациях — directory:read_organization;
      • Чтение данных о подразделениях — directory:read_departments;
      • Чтение данных о группах — directory:read_groups;
      • Чтение данных о сотрудниках — directory:read_users;
      • Управление организациями — directory:write_organization;
      • Управление подразделениями — directory:write_departments;
      • Управление группами — directory:write_groups;
      • Управление сотрудниками — directory:write_users;
      • Управление DNS-записями — directory:manage_dns.

      Яндекс 360 Admin API

      • Чтение настроек антиспама для организации — ya360_admin:mail_read_antispam_settings;
      • Управление настройками антиспама для организации — ya360_admin:mail_write_antispam_settings;
      • Чтение настроек почты пользователя — ya360_admin:mail_read_user_settings;
      • Управление настройками почты пользователя — ya360_admin:mail_write_user_settings;
      • Чтение правил обработки почты для домена — ya360_admin:mail_read_routing_rules;
      • Управление правилами обработки почты для домена — ya360_admin:mail_write_routing_rules;
      • Чтение информации о правах доступа к почтовым ящикам — ya360_admin:mail_read_shared_mailbox_inventory;
      • Управление правами доступа к почтовым ящикам — ya360_admin:mail_write_shared_mailbox_inventory.

      Яндекс 360 Security API

      • Управление обязательной 2FA для пользователей — ya360_security:domain_2fa_write;
      • Чтение информации о настройках cookie сессий пользователей — ya360_security:domain_sessions_read;
      • Управление настройками и авторизационными cookie сессиями пользователей — ya360_security:domain_sessions_write;
      • Чтение информации о параметрах паролей пользователей — ya360_security:domain_passwords_read;
      • Управление параметрами паролей пользователей — ya360_security:domain_passwords_write;
      • Чтение списка сервисных приложений — ya360_security:service_applications_read;
      • Управление списком сервисных приложений — ya360_security:service_applications_write;
      • Чтение событий аудит лога Диска — ya360_security:audit_log_disk;
      • Чтение событий аудит лога Почты — ya360_security:audit_log_mail.
    6. Укажите электронную почту для связи.

    7. Внизу страницы нажмите кнопку Создать приложение. На экране появится его описание.

    8. Скопируйте идентификатор приложения из поля ClientID — он потребуется для получения OAuth-токена. В дальнейшем открыть страницу со всеми вашими приложениями вы сможете по ссылке oauth.yandex.ru.

  2. Получите OAuth-токен одним из доступных способов.

    Отладочный токен необходимо получить вручную:

    1. Перейдите по ссылке

      https://oauth.yandex.ru/authorize?response_type=token&client_id=<идентификатор_приложения>
      Скопировано

      Вместо <идентификатор_приложения> подставьте значение из пункта 1.8.

    2. Если токен вашему приложению выдается впервые, откроется экран авторизации. После входа Яндекс OAuth перенаправит вас на страницу с токеном. Подробнее об отладочных токенах.

Полученный токен следует передавать в HTTP-заголовке Authorization при каждом вызове API, указывая тип токена перед его значением:

--header 'Authorization: OAuth <OAuth-токен>'
Скопировано

Подробнее об OAuth-авторизации читайте в документации OAuth-сервиса Яндекса.