Доступ к API
Все запросы к API выполняются к хосту https://api360.yandex.net/
.
Создание OAuth-приложения и получение токена
Яндекс 360 для бизнеса авторизует приложения с помощью OAuth-токенов. Чтобы использовать протокол OAuth при работе с Яндекс 360:
-
Зарегистрируйте свое OAuth-приложение:
-
Авторизуйтесь на Яндексе. Укажите логин и пароль администратора организации, от имени которого будут выполняться запросы к API.
-
Откройте страницу создания приложения.
-
Укажите название вашего сервиса и при необходимости прикрепите иконку.
-
Выберите платформы, на которых будет работать ваше приложение, и укажите их параметры.
Если вы разрабатываете или тестируете приложение, используйте отладочный токен. Для получения такого токена выберите Веб-сервисы и в поле Redirect URI подставьте значение по умолчанию, которое появится в подсказке Подставить URL для отладки:
https://oauth.yandex.ru/verification_code
. -
Укажите необходимые права доступа. В API Яндекс 360 для бизнеса поддерживаются следующие права:
Яндекс 360 Directory API
- Чтение данных об организациях —
directory:read_organization
; - Управление организациями —
directory:write_organization
; - Чтение данных о подразделениях —
directory:read_departments
; - Управление подразделениями —
directory:write_departments
; - Чтение данных о группах —
directory:read_groups
; - Управление группами —
directory:write_groups
; - Чтение данных о сотрудниках —
directory:read_users
; - Управление сотрудниками —
directory:write_users
; - Чтение данных о доменах организации —
directory:read_domains
; - Управление доменами организации —
directory:write_domains
; - Управление 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
.
- Чтение данных об организациях —
-
Укажите электронную почту для связи.
-
Внизу страницы нажмите кнопку Создать приложение. На экране появится его описание.
-
Скопируйте идентификатор приложения из поля ClientID — он потребуется для получения OAuth-токена. В дальнейшем открыть страницу со всеми вашими приложениями вы сможете по ссылке oauth.yandex.ru.
-
-
Получите OAuth-токен одним из доступных способов.
Отладочный токен необходимо получить вручную:
-
Перейдите по ссылке
https://oauth.yandex.ru/authorize?response_type=token&client_id=<идентификатор_приложения>
Вместо
<идентификатор_приложения>
подставьте значение из пункта 1.8. -
Если токен вашему приложению выдается впервые, откроется экран авторизации. После входа Яндекс OAuth перенаправит вас на страницу с токеном. Подробнее об отладочных токенах.
-
Полученный токен следует передавать в HTTP-заголовке Authorization
при каждом вызове API, указывая тип токена перед его значением:
--header 'Authorization: OAuth <OAuth-токен>'
Подробнее об OAuth-авторизации читайте в документации OAuth-сервиса Яндекса.
Добавление прав доступа в существующее приложение
Если у вас уже есть OAuth-приложение для работы с API Яндекс 360 для бизнеса, но у приложение недостаточно прав для осуществления какого-либо запроса, вы можете изменить список доступных прав.
- Авторизуйтесь на Яндексе. Укажите логин и пароль администратора организации, от имени которого создано OAuth-приложение.
- Откройте страницу Мои приложения сервиса Яндекс OAuth.
- Выберите приложение, которое создано для работы с API Яндекс 360 для бизнеса.
- На странице приложения в правом верхнем углу нажмите значок с карандашом для перехода в режим редактирования.
- В разделе Доступ к данным укажите названия права, которое хотите добавить, и выберите нужное из предложенного списка. Чтобы удалить лишнее право, нажмите значок с корзиной напротив него.
- Нажмите Сохранить внизу страницы.
Измененный список прав будет доступен только с новым токеном. Получите его одним из доступных способов.
Если вы разрабатываете или тестируете приложение, используйте отладочный токен. Его необходимо получить вручную. Для этого перейдите по ссылке:
https://oauth.yandex.ru/authorize?response_type=token&client_id=<идентификатор_приложения>
где <идентификатор_приложения>
— идентификатор вашего приложения из поля ClientID.