Вход через VK ID и Яндекс ID
Создано для приложения Invision Community 5.0.20, должно работать в предыдущих будущих версиях IPS 5.
Добавляет два способа входа и регистрации: VK ID и Яндекс ID (OAuth 2).
Кроме входа оно умеет:
запрашивать адрес электронной почты, аватар, дату рождения и номер телефона;
ограничивать регистрацию и вход по возрасту;
не принимать адреса электронной почты из чёрных списков IPS;
хранить историю телефонов участников и отдавать её через методы IPS\clogin\Auth.
🔵На VK надо иметь статус предпринимателя или самозанятого. В обеих соц сетях надо подтверждать учетную запись через Госуслуги.
🔴Внимание!!! Приложение может не работать на иностранных серверах потому-что они блокируются на стороне VK и Яндекса. Если у вас иностранный сервер и пользователь после регистрации получает сообщение "Что-то пошло не так, попробуйте позже", а в логах админ панели ошибки 40x или сообщения о пустых JSON это значит соц сети отклоняют запросы с вашего сервера или специально возвращают неверные ответы. В этом случае создайте прокси сервер в России, который проксирует на эти адреса:
https://id.vk.ru/oauth2/auth | https://id.vk.ru/oauth2/user_info |
https://oauth.yandex.ru/token | https://login.yandex.ru/info?format=json |
В полях Точка получения токена и Точка получения информации о пользователе укажите адреса прокси.
🟡Возможно в будущем потребуется установить на основном и прокси серверах сертификаты Минцифры. Подготовьте их уже сейчас.
1. Что сделать на стороне VK
Откройте кабинет VK ID для бизнеса: https://id.vk.ru/about/business/go/ и создайте приложение (тип «Web»).
Пройдите процедуру активации через Госуслуги и подтвердите статус предпринимателя или самозанятого.
Укажите адрес сайта и доверенный Redirect URI. Он должен совпадать с адресом, который показывает форма настроек обработчика в админке:
https://ВАШ-САЙТ/applications/clogin/interface/callback/oauthvk/В настройках приложения включите доступы к данным, которые вам нужны:
адрес электронной почты (рекомендуется, иначе email придётся спрашивать у пользователя при регистрации);
аватар (по желанию);
дата рождения (нужна, если включено ограничение по возрасту);
номер телефона (нужен, если телефон запрашивается или обязателен).
Скопируйте ID приложения и ключ (client secret) для настройки в IPS.
Набор доступов нужно определить заранее. Он применяется только к тем, кто авторизуется впервые. Тем, кто уже входил, новые данные (например, телефон) передаваться не будут, даже если удалить их токены и записи в базе. Получить новые данные от таких пользователей можно только пересозданием приложения (новые ID и ключи): тогда все пройдут авторизацию заново. Перед этим проверьте на тестовом аккаунте, что идентификатор пользователя в новом приложении не изменился, иначе существующие участники не будут сопоставлены со своими аккаунтами.
Документация:
кабинет и документация VK ID: https://id.vk.ru/about/business/go/
про токены: https://id.vk.ru/about/business/go/docs/ru/vkid/latest/vk-id/connection/tokens/about
2. Что сделать на стороне Яндекса
Откройте https://oauth.yandex.ru/ .
Пройдите процедуры подтверждения личности через Госуслуги.
Создайте приложение для входа через Яндекс ID.
В поле Callback URI укажите адрес, который показывает форма настроек обработчика в админке:
https://ВАШ-САЙТ/oauth/callback/В разделе доступов включите нужные данные:
дата рождения (если включено ограничение по возрасту);
адрес электронной почты (рекомендуется);
портрет пользователя (по желанию, для аватара);
номер телефона (если телефон запрашивается или обязателен).
Скопируйте ID приложения и пароль (client secret).
Яндекс возвращает те данные, которые разрешены в настройках приложения. Поэтому для телефона достаточно включить доступ в кабинете. Те же оговорки про заранее определённый набор доступов и пересоздание приложения действуют и здесь.
Документация Яндекс ID: https://yandex.ru/dev/id/doc/ru/; регистрация приложения: https://yandex.ru/dev/id/doc/ru/register-api.
3. Что сделать на стороне IPS
Установите приложение Social Login и очистите кеш.
В админке откройте раздел входа и регистрации (Login & Registration) и добавьте обработчики VK ID OAuth 2.1 и Yandex ID.
Заполните форму каждого обработчика:
ID клиента и секрет клиента из кабинета сервиса;
Номер телефона: «Не запрашивать» (по умолчанию), «Запрашивать» (регистрация и вход разрешены и без телефона) или «Отклонять регистрацию и вход без телефона»;
Ограничение возраста: включить, минимальный возраст (по умолчанию 18) и «Пропустить, если возраст не указан». Включайте пропуск: сервисы могут не передавать возраст, даже если он указан;
Не устанавливать email из чёрных списков: для новых регистраций пользователю предложат ввести другой адрес;
внешний вид кнопки: цвет, текст, значок (по умолчанию значки VK и Яндекса), правила отображения в профиле.
Если сервер IPS не достучится до сервисов (запросы отклоняются), в полях адресов токена и данных пользователя можно указать адрес своего прокси. Стандартные адреса:
Сервис
Токен
Данные пользователя
VK ID
https://id.vk.ru/oauth2/auth
https://id.vk.ru/oauth2/user_info
Яндекс
https://oauth.yandex.ru/token
https://login.yandex.ru/info?format=json
Включите обработчик и проверьте вход на тестовом аккаунте.
Русский перевод: translations/ru.xml (импортируется в разделе языков админки).
4. Как хранятся телефоны
Сам Social Login телефоны никак не использует. Он только получает номер от VK или Яндекса и записывает его в базу. Номера не показываются в профилях, даже администраторам, не проверяются, никуда не отправляются и нигде не применяются. Таблицы с телефонами и методы IPS\clogin\Auth (раздел 5) предназначены для разработчиков других приложений, которым номер нужен для своих целей.
Телефоны лежат в двух таблицах базы (с префиксом таблиц IPS), по одной на сервис. Таблицы описаны в data/schema.json.
clogin_vkid_phones
Колонка | Тип | Значение |
|---|---|---|
id | BIGINT, auto_increment | первичный ключ |
member_id | BIGINT | ID участника |
phone | VARCHAR(20) | телефон |
last_update | BIGINT | время записи, Unix timestamp |
clogin_yandexid_phones содержит те же колонки и ещё phone_id (BIGINT): идентификатор номера в Яндексе.
Правила записи:
Формат. В номере остаются только цифры и знак +, например +79031234567.
История. Новая строка добавляется только когда номер изменился. У VK сравнивается телефон с последней строкой участника, у Яндекса телефон и phone_id. Старые номера не удаляются, актуальный — строка с наибольшим last_update (при равенстве с наибольшим id).
Когда пишется. При входе или регистрации, если сервис вернул телефон и политика телефона не равна «Не запрашивать».
Слияние участников. Телефоны объединяемого участника переходят к оставшемуся.
Удаление участника. Его телефоны удаляются из обеих таблиц.
Сбор телефонов и передача их другим лицам могут быть незаконными в вашем регионе. Не запрашивайте номера без необходимости.
5. Методы IPS\clogin\Auth
Методы предназначены для разработчиков других приложений. Все методы статические и принимают ID участника.
Метод | Результат |
|---|---|
Auth::isVKAuth(int $member_id) | bool: у участника есть завершённая привязка VK ID |
Auth::isYandexAuth(int $member_id) | bool: то же для Яндекс ID |
Auth::getVKPhones(int $member_id) | string[]: телефоны из таблицы VK, новые первыми |
Auth::getYandexPhones(int $member_id) | string[]: то же для Яндекса |
Auth::getPhones(int $member_id) | string[]: телефоны обоих сервисов, новые первыми, без повторов |
Пример:
use IPS\clogin\Auth;
if ( Auth::isVKAuth( $member->member_id ) )
{
$phones = Auth::getVKPhones( $member->member_id );
$current = $phones[0] ?? NULL; // актуальный номер, если есть
}
$all = Auth::getPhones( $member->member_id );Особенности:
Привязка проверяется по таблице core_login_links (token_linked = 1) и классу обработчика. Отключённый в настройках обработчик не мешает: привязка всё равно считается.
Если записей нет (участника нет, он входил иначе или не передал телефон), телефонные методы возвращают [], а isVKAuth и isYandexAuth возвращают false. Исключений нет.
Методы возвращают всю историю. Актуальный номер идёт первым.
getPhones убирает только точные повторы. Если сервисы вернут один номер в разном формате, он попадёт в список дважды.
Забрать телефон при регистрации
Разработчик своего приложения может создать листенер участников (MemberListener, событие onLogin) и забрать телефон в своё приложение сразу при регистрации через соцсети:
public function onLogin( Member $member ): void
{
$phone = Auth::getPhones( $member->member_id )[0] ?? NULL;
if ( $phone !== NULL )
{
// сохранить телефон в своём приложении
}
}Событие onLogin срабатывает при каждом входе, поэтому проверяйте, что телефон ещё не сохранён у вас.
Не используйте для этого onCreateAccount: он срабатывает в момент создания участника, раньше, чем Social Login записывает номер, и в этот момент методы вернут пустой список.
Я автор приложения. Пишите здесь про выявленные баги и предложения по новым функциям.
Edited by aplayer
What's New in Version 5.0.21
Released
Пересобрано на версии 5.0.21;
Если соцсеть блокирует ваш сервер, то при сохранении настроек метода входа, об этом будет понятное предупреждение и предложение использовать прокси. ВК и Яндекс блокируют иностранные серверы на момент публикации приложения;
Исправлена проблема с опцией clogin_age_restrictions_not_specified_skip для ВК;
You may only provide a review once you have downloaded the file.
There are no reviews to display.