Авторизация через соцсети (OT API) Модуль «Внешняя аутентификация»

Проверка наличия модуля «Внешняя аутентификация»

Получить список подключенных модулей можно одним из этих методов:

• GetEnabledFeatures

• GetCommonInstanceOptionsInfo

если в списке есть ExternalAuthentication, значит модуль «Внешняя аутентификация» включен и вам доступна авторизация через соцсети.

Получение данных по соцсетям

Используем метод GetExternalAuthenticationSystemInfoList для получения списка соцсетей, который передаст вам идентификаторы, названия и картинки соцсетей.

Авторизация

Метод GetExternalAuthenticationInfo используется для инициации авторизации. В него передаем тип приложения, идентификатор соцсети и адрес возврата (такой, какой вы сможете обработать на своем сайте или перехватить в браузере), и в итоге получите адрес, на который нужно отправить браузер пользователя.

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

• Если всё успешно, будет параметр sessionId, в котором готовая сессия пользователя. Запоминаем ее и используем далее.
• Если соцсеть не выдала email, то в параметрах будет error=email_required и contextId, тогда вам нужно:
  • Запросить у пользователя почту.
  • Передать (вместе с контекстом, полученным ранее) в метод ConfirmExternalAuthentication — а в ответ получите сессию.
  • Если в ответ получена ошибка с ErrorCode/SubErrorCode равными ValidationError/PasswordRequiredForFinishExternalAuthentication, запросить у пользователя дополнительно пароль к его аккаунту.
  • Повторить вызов метода ConfirmExternalAuthentication еще вместе с введенным паролем.
• Если же произошла какая-то иная ошибка, то в параметрах будет просто error, его содержимое можно показать пользователю, или просто показать «Ошибка при авторизации».

Авторизация через мобильное приложение

Как и везде, во все методы нужно передавать параметр applicationType=MobileApplication/Android или applicationType=MobileApplication/iOS в зависимости от системы.

Если для указанной соцсети метод GetExternalAuthenticationInfo вернул в ответе MobileApplicationId, и если ваше приложение хочет реализовать нативную авторизацию, то её можно провести через интеграцию входа в мобильное приложение, в ином случае, если в ответе нет MobileApplicationId или нет возможности реализовать нативную авторизацию, используется обычная схема авторизации через адрес возврата (redirect url), как в предыдущем разделе..

При нативной авторизации процесс входа в систему реализуется в мобильном приложении, после чего, при успешном входе пользователя приложение получает токен идентификатора (idToken) для пользователя. После чего данный токен идентификатора необходимо передать в OTAPI. Для отправки токена используется метод ConfirmExternalAuthenticationWithToken, в него передается тип приложения, contextId (полученный ранее) и токен идентификатора, так же опциональный параметр - xmlCustomData, в нем указываются дополнительные необходимые поля.

• Если всё успешно, будет возвращена готовая сессия пользователя. Запоминаем ее и используем далее.
• Если соцсеть не выдала email, то в ответе будет получена ошибка с ErrorCode/SubErrorCode равными NotAvailable/EmailNotProvidedByAuthenticationSystem, тогда необходимо:
  • Запросить у пользователя почту.
  • Передать (вместе с контекстом, полученным ранее) в метод ConfirmExternalAuthentication — а в ответ получите сессию.
  • Если в ответ получена ошибка с ErrorCode/SubErrorCode равными ValidationError/PasswordRequiredForFinishExternalAuthentication, запросить у пользователя дополнительно пароль к его аккаунту.
  • Повторить вызов метода ConfirmExternalAuthentication еще вместе с введенным паролем.
• Если же произошла какая-то иная ошибка, то в параметрах будет получена ошибка с другим кодом, то содержимое этой ошибки можно показать пользователю, или просто показать «Ошибка при авторизации».