Как подключить вход через Яндекс в Encvoy ID#
📋 Эта инструкция входит в серию статей по настройке способов входа. Подробнее читайте в инструкции Способы входа и настройка виджета.
В этом руководстве вы узнаете, как подключить аутентификацию с помощью аккаунта Яндекс к системе Encvoy ID. Этот способ входа позволяет пользователям входить в приложения с помощью учётной записи сервиса Яндекс.
Настройка входа через Яндекс состоит из трёх ключевых этапов, которые выполняются в двух разных системах:
- Шаг 1. Настройка приложения в Яндекс
- Шаг 2. Создание способа входа
- Шаг 3. Добавление на виджет
- Описание параметров
- Смотрите также
Шаг 1. Настройка приложения в Яндекс#
Перед настройкой способа входа в Encvoy ID необходимо зарегистрировать ваше приложение в кабинете разработчика Яндекс и получить ключи доступа:
- Зарегистрируйтесь или авторизуйтесь в сервисе Яндекс OAuth.
-
Нажмите кнопку Создать.

-
Выберите вариант Для авторизации пользователей и нажмите Перейти к созданию.
-
Откроется форма создания.
-
На первом шаге формы укажите:
- Название сервиса,
- Иконку сервиса,
- Электронную почту.

-
На втором шаге установите чекбокс Веб-сервисы и укажите Возвратный URL #1 (
Redirect_uri) в форматеhttps://<your-domain>/api/interaction/code.
-
На третьем шаге установите чекбоксы:
- Доступ к адресу электронной почты;
- Доступ к логину, имени и фамилии, полу.

-
На четвертом шаге подтвердите создание приложения.

-
Скопируйте значения полей ID Приложения/Client ID и Секрет/Client Secret. Они понадобятся при создании приложения в Encvoy ID.

Шаг 2. Создание способа входа#
Теперь, имея ключи от Яндекс, создадим соответствующий провайдер в системе Encvoy ID.
-
Перейдите в кабинет администратора → вкладка Настройки.
💡 Чтобы создать способ входа для организации, откройте кабинет организации. Если способ входа нужен для конкретного приложения, откройте настройки этого приложения.
-
Найдите блок Способы входа и нажмите Настроить.
- В открывшемся окне нажмите кнопку Создать
. - Откроется окно со списком шаблонов.
- Выберите шаблон Яндекс.
-
Заполните форму создания:
Основная информация
- Имя — Название, которое увидят пользователи.
- Описание (опционально) — Краткое описание.
- Логотип (опционально) — Можно загрузить свою иконку, или будет использована стандартная.
Параметры аутентификации
- Идентификатор ресурса (client_id) — Вставьте скопированный ID Приложения (
Client ID). - Секретный ключ (client_secret) — Вставьте скопированный Секрет (
Client Secret). - Возвратный URL(Redirect URI) — Поле заполнится автоматически на основе вашего домена.
Дополнительные настройки
- Публичный способ входа — Включите, если хотите, чтобы этот способ входа можно было добавить в другие приложения системы (или организации), а также в профиль пользователя в качестве идентификатора внешнего сервиса.
- Публичность — Настройте уровень публичности по умолчанию для идентификатора внешнего сервиса в профиле пользователя.
-
Нажмите Создать.
После успешного создания новый способ входа появится в общем списке провайдеров.
Шаг 3. Добавление на виджет#
Чтобы пользователи увидели кнопку Войти через Яндекс на форме авторизации, нужно активировать эту функцию в настройках виджета:
- В общем списке провайдеров найдите созданный способ входа.
- Включите переключатель на панели с провайдером.
Проверка: После сохранения откройте форму входа в тестовом приложении. На виджете должна появиться новая кнопка с логотипом Яндекс.
Описание параметров#
Основная информация#
| Название | Описание | Тип | Ограничения |
|---|---|---|---|
| Имя | Название, которое будет отображаться в интерфейсе сервиса Encvoy ID | Текст | Макс. 50 символов |
| Описание | Краткое описание, которое будет отображаться в интерфейсе сервиса Encvoy ID | Текст | Макс. 255 символов |
| Логотип | Изображение, которое будет отображаться в интерфейсе сервиса Encvoy ID и виджете входа | JPG, GIF, PNG или WEBP | Макс. размер: 1 МБ |
Параметры аутентификации#
| Название | Параметр | Описание |
|---|---|---|
| Идентификатор ресурса (client_id) | Client_id |
ID приложения, созданного в Яндекс |
| Секретный ключ (client_secret) | Client_secret |
Секретный ключ доступа приложения, созданного созданного в Яндекс |
| Возвратный URL(Redirect URI) (не редактируемое) | Redirect URI |
Адрес Encvoy ID, на который пользователь перенаправляется после аутентификации в стороннем сервисе |
Дополнительные настройки#
| Название | Описание |
|---|---|
| Публичный способ входа | При активации настройки: - Способ входа станет доступен для добавления в другие приложения сервиса. - Способ входа станет доступен для добавления в качестве идентификатора внешнего сервиса в профиле пользователя. |
| Публичность | Задает уровень публичности по умолчанию для идентификатора внешнего сервиса в профиле пользователя |
Смотрите также#
- Способы входа и настройка виджета входа — руководство по способам входа и настройке виджета входа.
- Управление организациями — руководство по работе с организациями системы Encvoy ID.
- Личный профиль и управление разрешениями приложений — руководство по управлению личным профилем.