dot net sdk
Released Version 11.6.0
Оболочка регистрации клиентов LoginRadius ASP.NET предоставляет доступ к API платформы управления идентификацией LoginRadius.
LoginRadius — это платформа управления идентификацией, которая упрощает регистрацию пользователей и одновременно защищает данные. Платформа LoginRadius упрощает и защищает процесс регистрации пользователей, увеличивает конверсию с помощью социального входа, который объединяет 30 основных социальных платформ, и предлагает комплексное решение с традиционной регистрацией пользователей. Вы можете собрать множество данных профиля пользователя с помощью входа в социальную сеть или традиционной регистрации пользователя.
LoginRadius централизует все это в одном месте, что упрощает управление и доступ. Легко интегрируйте LoginRadius со всеми вашими сторонними приложениями, такими как MailChimp, Google Analytics, Livefyre и многими другими, что упрощает использование собираемых вами данных.
LoginRadius помогает компаниям повысить вовлеченность пользователей на своей веб-/мобильной платформе, управлять онлайн-личностями, использовать социальные сети для маркетинга, собирать точные данные о потребителях и получать уникальную социальную информацию о своей клиентской базе.
Пожалуйста, посетите здесь для получения дополнительной информации.
В этой документации предполагается, что вы проработали реализацию на стороне клиента для настройки интерфейсов регистрации пользователей LoginRadius, которые будут обслуживать процесс первоначальной регистрации и входа в систему. Подробности об этом можно найти в руководстве по началу работы.
**Примечание. **LoginRadius использует стандартный протокол TLS 1.2, разработанный для защиты конфиденциальности информации, передаваемой через Интернет. Чтобы использовать LoginRadius .Net SDK, добавьте следующий код перед созданием экземпляра веб-службы в файле Global.asax вашего проекта.
ServicePointManager . SecurityProtocol = SecurityProtocolType . Tls | SecurityProtocolType . Tls11 | SecurityProtocolType . Tls12 ; Загрузите SDK для регистрации пользователей .Net с Github.
Скопируйте файлы LoginRadiusSDK.V2.dll и LoginRadiusSDK.V2.pdb в каталог References вашего проекта ASP.NET.
ИЛИ
PM> Install-Package LoginRadiusSDK.NET
ИЛИ
Откройте решение с помощью Visual Studio 2019.
Создайте проект и запишите, где находится файл .nupkg.
Откройте настройки диспетчера пакетов NuGet и импортируйте каталог, в котором находится файл .nupkg.
Откройте инструмент «Управление пакетами NuGet для решений...», измените источник на вновь созданный, выберите и установите LoginRadius SDK.
Затем включите в свой проект следующие пространства имен:
using LoginRadiusSDK . V2 . Api ;
using LoginRadiusSDK . V2 . Models ; Перед использованием SDK вы должны инициализировать SDK с помощью следующего кода: Ключ API и секрет вашего сайта LoginRadius. Эту информацию можно найти в вашей учетной записи LoginRadius, как описано здесь.
LoginRadiusSdkGlobalConfig . ApiKey = "__API_KEY__" ;
LoginRadiusSdkGlobalConfig . ApiSecret = "__API_SECRET__" ;
LoginRadiusSdkGlobalConfig . AppName = "__LoginRadius_APP_NAME__" ;
LoginRadiusSdkGlobalConfig . ApiRequestSigning = "false" ;
LoginRadiusSdkGlobalConfig . ConnectionTimeout = 30000 ; // Connection Timeout (milliseconds)
LoginRadiusSdkGlobalConfig . ProxyAddress = "__HTTP_PROXY_ADDRESS__" ; // Absolute Proxy URI
LoginRadiusSdkGlobalConfig . ProxyCredentials = "__HTTP_PROXY_CREDENTIALS__" ; // Proxy Credentials in the format 'USERNAME:PASSWORD'
LoginRadiusSdkGlobalConfig . RequestRetries = 3 ;
LoginRadiusSdkGlobalConfig . ApiRegion = "_region_" ;
LoginRadiusSdkGlobalConfig . DomainName = "https://api.loginradius.com/" ;ИЛИ
Для АСП.НЕТ. в web.config :
< configSections >
< section name = " loginradius " type = " LoginRadiusSDK.V2.SDKConfigHandler, LoginRadiusSDK.V2 " />
</ configSections >
<!-- LoginRadius SDK settings -->
< loginradius >
< settings >
< add name = " apiKey " value = " __API_KEY__ " />
< add name = " apiSecret " value = " __API_SECRET__ " />
< add name = " appName " value = " __LoginRadius_APP_NAME__ " />
< add name = " ApiRequestSigning " value = " false " />
< add name = " proxyAddress " value = " __HTTP_PROXY_ADDRESS__ " /> <!-- Absolute Proxy URI -->
< add name = " proxyCredentials " value = " __HTTP_PROXY_CREDENTIALS__ " /> <!-- Proxy Credentials in the format 'USERNAME:PASSWORD' -->
< add name = " connectionTimeout " value = " __HTTP_CONNECTION_TIMEOUT__ " /> <!-- Connection Timeout (milliseconds) -->
< add name = " requestRetries " value = " __HTTP_CONNECTION_RETRY__ " />
< add name = " apiRegion " value = " _region_ " />
< add name = " domainName " value = " https://api.loginradius.com/ " />
</ settings >
</ loginradius >ИЛИ
Для .NET Core в appsettings.json :
JSON
"loginradius" : {
"apiKey" : " __API_KEY__ " ,
"apiSecret" : " __API_SECRET__ " ,
"appName" : " __LoginRadius_APP_NAME__ " ,
"ApiRequestSigning" : " false " ,
"proxyAddress" : " __HTTP_PROXY_ADDRESS__ " ,
"proxyCredentials" : " __HTTP_PROXY_CREDENTIAL__ " ,
"connectionTimeout" : " __HTTP_CONNECTION_TIMEOUT__ " ,
"requestRetries" : " __HTTP_CONNECTION_RETRY__ " ,
"apiRegion" : " _region_ " ,
"domainName" : " https://api.loginradius.com/ "
}
При инициализации SDK при необходимости укажите личный домен. Пример. В appsettings.json добавьте следующий оператор:
"domainName" : " https://api.loginradius.com/ "При инициализации SDK вы можете дополнительно указать включение этой функции. Включение этой функции означает, что клиенту не нужно передавать секрет API в запросе API. Вместо этого они могут передавать динамически генерируемое хэш-значение. Эта функция также гарантирует, что сообщение не будет подделано во время передачи, когда кто-то вызывает наши API. Пример. В appsettings.json добавьте следующий оператор:
"ApiRequestSigning" : " false "X-Origin-IP LoginRadius позволяет добавлять X-Origin-IP в заголовки и определяет IP-адрес запроса клиента. Это также может быть полезно для устранения неточностей в аналитике, когда аналитика зависит от данных заголовка.
"originIp" : " <Client-Ip-Address> " Список API в этом разделе:
PUT: обновление профиля аутентификации по токену
PUT: авторизация, разблокировка учетной записи по токену доступа
PUT: проверка подлинности электронной почты по OTP
PUT: аутентификация, сброс пароля с помощью ответа безопасности и электронной почты.
PUT: аутентификация, сброс пароля с помощью ответа безопасности и телефона.
PUT: аутентификация, сброс пароля по ответу безопасности и имени пользователя.
PUT: Сброс пароля аутентификации с помощью токена сброса.
PUT: аутентификация, сброс пароля по OTP.
PUT: аутентификация, сброс пароля по OTP и имени пользователя.
PUT: аутентификация, изменение пароля.
POST: Идентификация социальных сетей по ссылке для аутентификации
POST: Аутентификация социальных сетей с помощью Ping
PUT: установка аутентификации или изменение имени пользователя.
PUT: аутентификация, повторная отправка подтверждения по электронной почте.
POST: авторизация, добавление электронной почты
POST: авторизация по электронной почте
POST: авторизация по имени пользователя
POST: Авторизация забыла пароль
POST: аутентификация пользователя по электронной почте
POST: Аутентификация пользователя с помощью Captcha
GET: получайте контрольные вопросы по электронной почте
GET: Получить контрольные вопросы по имени пользователя
GET: Получите контрольные вопросы по телефону
GET: получение контрольных вопросов по токену доступа
GET: токен доступа для проверки подлинности
GET: токен доступа недействителен
GET: информация о токене доступа
GET: Auth Прочтите все профили по токену
GET: Auth Отправить приветственное письмо
GET: аутентификация, удаление учетной записи
GET: Получить профиль по пингу
GET: проверка подлинности, проверка доступности электронной почты
GET: проверка подлинности электронной почты
GET: Авторизация социальной идентичности
GET: проверка подлинности имени пользователя
GET: Политика конфиденциальности аутентификации Принять
GET: История политики конфиденциальности аутентификации по токену доступа
GET: Auth отправить подтверждение по электронной почте для привязки социальных профилей
УДАЛЕНИЕ: удаление учетной записи с подтверждением по электронной почте.
УДАЛИТЬ: Аутентификация Удаление электронной почты
УДАЛИТЬ: Отключить авторизацию от социальных сетей
Этот API используется для обновления профиля пользователя путем передачи access_token. Дополнительная информация
var accessToken = "accessToken" ; //Required
UserProfileUpdateModel userProfileUpdateModel = new UserProfileUpdateModel {
FirstName = "<FirstName>" ,
LastName = "<LastName>"
} ; //Required
var emailTemplate = "emailTemplate" ; //Optional
string fields = null ; //Optional
; //Optional
var smsTemplate = "smsTemplate" ; //Optional
var verificationUrl = "verificationUrl" ; //Optional
var isVoiceOtp = false ; //Optional
var options = "options" ; //Optional
var apiResponse = new AuthenticationApi ( ) . UpdateProfileByAccessToken ( accessToken , userProfileUpdateModel , emailTemplate , fields , smsTemplate , verificationUrl , isVoiceOtp , options ) . Result ; Этот API используется, чтобы позволить клиенту с действительным токеном доступа разблокировать свою учетную запись при условии, что он успешно пройдет предложенные задачи защиты от ботов. Типы блокировки Block или Suspend неприменимы для этого API. Дополнительные сведения см. в нашей документации по настройке безопасности аутентификации. Вам необходимо передать только те параметры публикации, которые соответствуют запрашиваемым запросам. Дополнительная информация
var accessToken = "accessToken" ; //Required
UnlockProfileModel unlockProfileModel = new UnlockProfileModel {
G_recaptcha_response = "<G-recaptcha-response>"
} ; //Required
var apiResponse = new AuthenticationApi ( ) . UnlockAccountByToken ( accessToken , unlockProfileModel ) . Result ; Этот API используется для проверки электронной почты пользователя, когда включен поток проверки электронной почты OTP. Обратите внимание, что вам необходимо связаться с LoginRadius, чтобы включить эту функцию. Дополнительная информация
EmailVerificationByOtpModel emailVerificationByOtpModel = new EmailVerificationByOtpModel {
Email = "<Email>" ,
Otp = "<Otp>"
} ; //Required
string fields = null ; //Optional
var url = "url" ; //Optional
var welcomeEmailTemplate = "welcomeEmailTemplate" ; //Optional
var apiResponse = new AuthenticationApi ( ) . VerifyEmailByOTP ( emailVerificationByOtpModel , fields , url , welcomeEmailTemplate ) . Result ; Этот API используется для сброса пароля для указанной учетной записи с помощью секретного вопроса. Подробнее
ResetPasswordBySecurityAnswerAndEmailModel resetPasswordBySecurityAnswerAndEmailModel = new ResetPasswordBySecurityAnswerAndEmailModel {
Email = "<Email>" ,
Password = "<Password>" ,
SecurityAnswer = new Dictionary < String , String > {
[ "QuestionID" ] = "Answer"
}
} ; //Required
var apiResponse = new AuthenticationApi ( ) . ResetPasswordBySecurityAnswerAndEmail ( resetPasswordBySecurityAnswerAndEmailModel ) . Result ; Этот API используется для сброса пароля для указанной учетной записи с помощью секретного вопроса. Подробнее
ResetPasswordBySecurityAnswerAndPhoneModel resetPasswordBySecurityAnswerAndPhoneModel = new ResetPasswordBySecurityAnswerAndPhoneModel {
Password = "<Password>" ,
Phone = "<Phone>" ,
SecurityAnswer = new Dictionary < String , String > {
[ "QuestionID" ] = "Answer"
}
} ; //Required
var apiResponse = new AuthenticationApi ( ) . ResetPasswordBySecurityAnswerAndPhone ( resetPasswordBySecurityAnswerAndPhoneModel ) . Result ; Этот API используется для сброса пароля для указанной учетной записи с помощью секретного вопроса. Подробнее
ResetPasswordBySecurityAnswerAndUserNameModel resetPasswordBySecurityAnswerAndUserNameModel = new ResetPasswordBySecurityAnswerAndUserNameModel {
Password = "<Password>" ,
SecurityAnswer = new Dictionary < String , String > {
[ "QuestionID" ] = "Answer"
} ,
UserName = "<UserName>"
} ; //Required
var apiResponse = new AuthenticationApi ( ) . ResetPasswordBySecurityAnswerAndUserName ( resetPasswordBySecurityAnswerAndUserNameModel ) . Result ; Этот API используется для установки нового пароля для указанной учетной записи. Дополнительная информация
ResetPasswordByResetTokenModel resetPasswordByResetTokenModel = new ResetPasswordByResetTokenModel {
Password = "<Password>" ,
ResetToken = "<ResetToken>"
} ; //Required
var apiResponse = new AuthenticationApi ( ) . ResetPasswordByResetToken ( resetPasswordByResetTokenModel ) . Result ; Этот API используется для установки нового пароля для указанной учетной записи. Дополнительная информация
ResetPasswordByEmailAndOtpModel resetPasswordByEmailAndOtpModel = new ResetPasswordByEmailAndOtpModel {
Email = "<Email>" ,
Otp = "<Otp>" ,
Password = "<Password>"
} ; //Required
var apiResponse = new AuthenticationApi ( ) . ResetPasswordByEmailOTP ( resetPasswordByEmailAndOtpModel ) . Result ; Этот API используется для установки нового пароля для указанной учетной записи, если вы используете имя пользователя в качестве уникального идентификатора в своем рабочем процессе. Подробнее
ResetPasswordByUserNameModel resetPasswordByUserNameModel = new ResetPasswordByUserNameModel {
Otp = "<Otp>" ,
Password = "<Password>" ,
UserName = "<UserName>"
} ; //Required
var apiResponse = new AuthenticationApi ( ) . ResetPasswordByOTPAndUserName ( resetPasswordByUserNameModel ) . Result ; Этот API используется для изменения пароля учетной записи на основе предыдущего пароля. Подробнее
var accessToken = "accessToken" ; //Required
var newPassword = "newPassword" ; //Required
var oldPassword = "oldPassword" ; //Required
var apiResponse = new AuthenticationApi ( ) . ChangePassword ( accessToken , newPassword , oldPassword ) . Result ; Этот API используется для связи учетной записи социального провайдера с указанной учетной записью на основе токена доступа и токена доступа пользователя социального провайдера. Дополнительная информация
var accessToken = "accessToken" ; //Required
var candidateToken = "candidateToken" ; //Required
var apiResponse = new AuthenticationApi ( ) . LinkSocialIdentities ( accessToken , candidateToken ) . Result ; Этот API используется для связи учетной записи социального провайдера с существующей учетной записью LoginRadius на основе ping и токена доступа пользователя социального провайдера. Дополнительная информация
var accessToken = "accessToken" ; //Required
var clientGuid = "clientGuid" ; //Required
var apiResponse = new AuthenticationApi ( ) . LinkSocialIdentitiesByPing ( accessToken , clientGuid ) . Result ; Этот API используется для установки или изменения имени пользователя с помощью токена доступа. Дополнительная информация
var accessToken = "accessToken" ; //Required
var username = "username" ; //Required
var apiResponse = new AuthenticationApi ( ) . SetOrChangeUserName ( accessToken , username ) . Result ; Этот API повторно отправляет пользователю электронное письмо с подтверждением. Дополнительная информация
var email = "email" ; //Required
var emailTemplate = "emailTemplate" ; //Optional
var verificationUrl = "verificationUrl" ; //Optional
var apiResponse = new AuthenticationApi ( ) . AuthResendEmailVerification ( email , emailTemplate , verificationUrl ) . Result ; Этот API используется для добавления дополнительных адресов электронной почты в учетную запись пользователя. Дополнительная информация
var accessToken = "accessToken" ; //Required
var email = "email" ; //Required
var type = "type" ; //Required
var emailTemplate = "emailTemplate" ; //Optional
var verificationUrl = "verificationUrl" ; //Optional
var apiResponse = new AuthenticationApi ( ) . AddEmail ( accessToken , email , type , emailTemplate , verificationUrl ) . Result ; Этот API получает копию пользовательских данных на основе электронного письма. Дополнительная информация
EmailAuthenticationModel emailAuthenticationModel = new EmailAuthenticationModel {
Email = "<Email>" ,
Password = "<Password>"
} ; //Required
var emailTemplate = "emailTemplate" ; //Optional
string fields = null ; //Optional
var loginUrl = "loginUrl" ; //Optional
var verificationUrl = "verificationUrl" ; //Optional
var apiResponse = new AuthenticationApi ( ) . LoginByEmail ( emailAuthenticationModel , emailTemplate , fields , loginUrl , verificationUrl ) . Result ; Этот API получает копию пользовательских данных на основе имени пользователя. Подробнее
UserNameAuthenticationModel userNameAuthenticationModel = new UserNameAuthenticationModel {
Password = "<Password>" ,
Username = "<Username>"
} ; //Required
var emailTemplate = "emailTemplate" ; //Optional
string fields = null ; //Optional
var loginUrl = "loginUrl" ; //Optional
var verificationUrl = "verificationUrl" ; //Optional
var apiResponse = new AuthenticationApi ( ) . LoginByUserName ( userNameAuthenticationModel , emailTemplate , fields , loginUrl , verificationUrl ) . Result ; Этот API используется для отправки URL-адреса сброса пароля в указанную учетную запись. Примечание. Если у вас включен рабочий процесс «Имя пользователя», вы можете заменить параметр «электронная почта» на «имя пользователя».
var email = "email" ; //Required
var resetPasswordUrl = "resetPasswordUrl" ; //Required
var emailTemplate = "emailTemplate" ; //Optional
var apiResponse = new AuthenticationApi ( ) . ForgotPassword ( email , resetPasswordUrl , emailTemplate ) . Result ; Этот API создает пользователя в базе данных, а также отправляет ему электронное письмо с подтверждением. Дополнительная информация
