dot net sdk
Released Version 11.6.0
O wrapper LoginRadius ASP.NET Customer Registration fornece acesso à API LoginRadius Identity Management Platform.
LoginRadius é uma plataforma de gerenciamento de identidade que simplifica o registro do usuário enquanto protege os dados. A plataforma LoginRadius simplifica e protege o processo de registro de usuário, aumenta a conversão com Login Social que combina 30 principais plataformas sociais e oferece uma solução completa com Registro de Usuário Tradicional. Você pode coletar diversos dados de perfil de usuário por meio do Login Social ou do Registro de Usuário Tradicional.
LoginRadius centraliza tudo em um só lugar, facilitando o gerenciamento e o acesso. Integre facilmente o LoginRadius com todos os seus aplicativos de terceiros, como MailChimp, Google Analytics, Livefyre e muitos mais, facilitando a utilização dos dados que você está capturando.
LoginRadius ajuda as empresas a aumentar o envolvimento do usuário em sua plataforma web/móvel, gerenciar identidades online, utilizar mídias sociais para marketing, capturar dados precisos do consumidor e obter informações sociais exclusivas sobre sua base de clientes.
Por favor visite aqui para mais informações.
Esta documentação pressupõe que você tenha trabalhado na implementação do lado do cliente para configurar suas interfaces de registro de usuário LoginRadius que servirão o registro inicial e o processo de login. Detalhes sobre isso podem ser encontrados no guia de primeiros passos.
**Observação: **LoginRadius usa o protocolo TLS 1.2 padrão da indústria, projetado para ajudar a proteger a privacidade das informações comunicadas pela Internet. Para usar o LoginRadius .Net SDK, adicione o código a seguir antes de instanciar seu serviço web no arquivo Global.asax do seu projeto.
ServicePointManager . SecurityProtocol = SecurityProtocolType . Tls | SecurityProtocolType . Tls11 | SecurityProtocolType . Tls12 ; Baixe o SDK .Net de registro de usuário do Github
Copie os arquivos LoginRadiusSDK.V2.dll e LoginRadiusSDK.V2.pdb para o diretório References do seu projeto ASP.NET.
OU
PM> Install-Package LoginRadiusSDK.NET
OU
Abra a solução usando o Visual Studio 2019.
Crie o projeto e anote onde o arquivo .nupkg está localizado.
Acesse as configurações do Gerenciador de pacotes NuGet e importe o diretório onde o arquivo .nupkg está localizado.
Acesse a ferramenta "Gerenciar pacotes NuGet para soluções...", altere a fonte para a fonte recém-criada e selecione e instale o LoginRadius SDK
A seguir, inclua os seguintes namespaces em seu projeto:
using LoginRadiusSDK . V2 . Api ;
using LoginRadiusSDK . V2 . Models ; Antes de usar o SDK, você deve inicializá-lo com a ajuda do seguinte código: Chave API e segredo do seu site LoginRadius. Essas informações podem ser encontradas em sua conta LoginRadius conforme descrito aqui
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/" ;OU
Para ASP.NET. em 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 >OU
Para .NET Core, em 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/ "
}
Ao inicializar o SDK, especifique opcionalmente um domínio personalizado. Exemplo: em appsettings.json, adicione a seguinte instrução -
"domainName" : " https://api.loginradius.com/ "Ao inicializar o SDK, você pode especificar opcionalmente a ativação desse recurso. Ativar esse recurso significa que o cliente não precisa passar um segredo de API em uma solicitação de API. Em vez disso, eles podem passar um valor hash gerado dinamicamente. Esse recurso também garantirá que a mensagem não seja adulterada durante o trânsito quando alguém ligar para nossas APIs. Exemplo: em appsettings.json, adicione a seguinte instrução -
"ApiRequestSigning" : " false "X-Origin-IP LoginRadius permite adicionar X-Origin-IP em seus cabeçalhos e determina o endereço IP da solicitação do cliente, isso também pode ser útil para superar discrepâncias analíticas onde as análises dependem dos dados do cabeçalho.
"originIp" : " <Client-Ip-Address> " Lista de APIs nesta seção:
PUT: perfil de atualização de autenticação por token
PUT: conta de desbloqueio de autenticação por token de acesso
PUT: Email de verificação de autenticação por OTP
PUT: Autenticação de senha de redefinição por resposta de segurança e e-mail
PUT: Autenticação de senha de redefinição por resposta de segurança e telefone
PUT: Senha de redefinição de autenticação por resposta de segurança e nome de usuário
PUT: Senha de redefinição de autenticação por token de redefinição
PUT: Senha de redefinição de autenticação por OTP
PUT: senha de redefinição de autenticação por OTP e nome de usuário
PUT: Autenticação de alteração de senha
POST: Identidades sociais do link de autenticação
POST: Autenticação de identidades sociais por link por Ping
PUT: definir autenticação ou alterar nome de usuário
PUT: Verificação de e-mail de reenvio de autenticação
POST: Autenticação Adicionar e-mail
POST: Login de autenticação por e-mail
POST: Login de autenticação por nome de usuário
POST: Autenticação Esqueci a Senha
POST: Registro de usuário de autenticação por e-mail
POST: Registro de usuário de autenticação por Captcha
GET: Receba perguntas de segurança por e-mail
GET: Obtenha perguntas de segurança por nome de usuário
GET: Obtenha perguntas de segurança por telefone
GET: Obtenha perguntas de segurança por token de acesso
GET: token de acesso de validação de autenticação
GET: token de acesso invalidado
OBTER: informações do token de acesso
GET: Auth Leia todos os perfis por token
GET: Autenticação Enviar e-mail de boas-vindas
GET: Autenticação de exclusão de conta
GET: Obter perfil por Ping
GET: Autenticação, verificação de disponibilidade de e-mail
OBTER: E-mail de verificação de autenticação
OBTER: identidade social de autenticação
GET: Autenticação, verificação da disponibilidade do nome de usuário
GET: Política de privacidade de autenticação aceita
GET: Histórico da política de privacidade de autenticação por token de acesso
GET: Auth envia e-mail de verificação para vincular perfis sociais
DELETE: Autenticação de exclusão de conta com confirmação por e-mail
EXCLUIR: Autenticação de e-mail de remoção
DELETE: Autenticação desvincula identidades sociais
Esta API é usada para atualizar o perfil do usuário passando o access_token. Mais informações
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 ; Esta API é usada para permitir que um cliente com um access_token válido desbloqueie sua conta, desde que seja aprovado nos desafios solicitados do Bot Protection. Os tipos de bloco Block ou Suspend não são aplicáveis a esta API. Para obter detalhes adicionais, consulte nossa documentação de configuração de segurança de autenticação. Você só precisa passar os parâmetros de postagem que correspondem aos desafios solicitados. Mais informações
var accessToken = "accessToken" ; //Required
UnlockProfileModel unlockProfileModel = new UnlockProfileModel {
G_recaptcha_response = "<G-recaptcha-response>"
} ; //Required
var apiResponse = new AuthenticationApi ( ) . UnlockAccountByToken ( accessToken , unlockProfileModel ) . Result ; Esta API é usada para verificar o e-mail do usuário quando o fluxo de verificação de e-mail OTP está habilitado. Observe que você deve entrar em contato com LoginRadius para ativar esse recurso. Mais informações
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 ; Esta API é usada para redefinir a senha da conta especificada por pergunta de segurança Mais informações
ResetPasswordBySecurityAnswerAndEmailModel resetPasswordBySecurityAnswerAndEmailModel = new ResetPasswordBySecurityAnswerAndEmailModel {
Email = "<Email>" ,
Password = "<Password>" ,
SecurityAnswer = new Dictionary < String , String > {
[ "QuestionID" ] = "Answer"
}
} ; //Required
var apiResponse = new AuthenticationApi ( ) . ResetPasswordBySecurityAnswerAndEmail ( resetPasswordBySecurityAnswerAndEmailModel ) . Result ; Esta API é usada para redefinir a senha da conta especificada por pergunta de segurança Mais informações
ResetPasswordBySecurityAnswerAndPhoneModel resetPasswordBySecurityAnswerAndPhoneModel = new ResetPasswordBySecurityAnswerAndPhoneModel {
Password = "<Password>" ,
Phone = "<Phone>" ,
SecurityAnswer = new Dictionary < String , String > {
[ "QuestionID" ] = "Answer"
}
} ; //Required
var apiResponse = new AuthenticationApi ( ) . ResetPasswordBySecurityAnswerAndPhone ( resetPasswordBySecurityAnswerAndPhoneModel ) . Result ; Esta API é usada para redefinir a senha da conta especificada por pergunta de segurança Mais informações
ResetPasswordBySecurityAnswerAndUserNameModel resetPasswordBySecurityAnswerAndUserNameModel = new ResetPasswordBySecurityAnswerAndUserNameModel {
Password = "<Password>" ,
SecurityAnswer = new Dictionary < String , String > {
[ "QuestionID" ] = "Answer"
} ,
UserName = "<UserName>"
} ; //Required
var apiResponse = new AuthenticationApi ( ) . ResetPasswordBySecurityAnswerAndUserName ( resetPasswordBySecurityAnswerAndUserNameModel ) . Result ; Esta API é usada para definir uma nova senha para a conta especificada. Mais informações
ResetPasswordByResetTokenModel resetPasswordByResetTokenModel = new ResetPasswordByResetTokenModel {
Password = "<Password>" ,
ResetToken = "<ResetToken>"
} ; //Required
var apiResponse = new AuthenticationApi ( ) . ResetPasswordByResetToken ( resetPasswordByResetTokenModel ) . Result ; Esta API é usada para definir uma nova senha para a conta especificada. Mais informações
ResetPasswordByEmailAndOtpModel resetPasswordByEmailAndOtpModel = new ResetPasswordByEmailAndOtpModel {
Email = "<Email>" ,
Otp = "<Otp>" ,
Password = "<Password>"
} ; //Required
var apiResponse = new AuthenticationApi ( ) . ResetPasswordByEmailOTP ( resetPasswordByEmailAndOtpModel ) . Result ; Esta API é usada para definir uma nova senha para a conta especificada se você estiver usando o nome de usuário como identificador exclusivo em seu fluxo de trabalho. Mais informações
ResetPasswordByUserNameModel resetPasswordByUserNameModel = new ResetPasswordByUserNameModel {
Otp = "<Otp>" ,
Password = "<Password>" ,
UserName = "<UserName>"
} ; //Required
var apiResponse = new AuthenticationApi ( ) . ResetPasswordByOTPAndUserName ( resetPasswordByUserNameModel ) . Result ; Esta API é usada para alterar a senha da conta com base na senha anterior. Mais informações
var accessToken = "accessToken" ; //Required
var newPassword = "newPassword" ; //Required
var oldPassword = "oldPassword" ; //Required
var apiResponse = new AuthenticationApi ( ) . ChangePassword ( accessToken , newPassword , oldPassword ) . Result ; Esta API é usada para vincular uma conta de provedor social à conta especificada com base no token de acesso e no token de acesso do usuário do provedor social. Mais informações
var accessToken = "accessToken" ; //Required
var candidateToken = "candidateToken" ; //Required
var apiResponse = new AuthenticationApi ( ) . LinkSocialIdentities ( accessToken , candidateToken ) . Result ; Esta API é usada para vincular uma conta de provedor social a uma conta LoginRadius existente com base no ping e no token de acesso do usuário do provedor social. Mais informações
var accessToken = "accessToken" ; //Required
var clientGuid = "clientGuid" ; //Required
var apiResponse = new AuthenticationApi ( ) . LinkSocialIdentitiesByPing ( accessToken , clientGuid ) . Result ; Esta API é usada para definir ou alterar UserName por token de acesso. Mais informações
var accessToken = "accessToken" ; //Required
var username = "username" ; //Required
var apiResponse = new AuthenticationApi ( ) . SetOrChangeUserName ( accessToken , username ) . Result ; Esta API reenvia o e-mail de verificação ao usuário. Mais informações
var email = "email" ; //Required
var emailTemplate = "emailTemplate" ; //Optional
var verificationUrl = "verificationUrl" ; //Optional
var apiResponse = new AuthenticationApi ( ) . AuthResendEmailVerification ( email , emailTemplate , verificationUrl ) . Result ; Esta API é usada para adicionar e-mails adicionais à conta de um usuário. Mais informações
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 ; Esta API recupera uma cópia dos dados do usuário com base no Email More Info
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 ; Esta API recupera uma cópia dos dados do usuário com base no nome de usuário Mais informações
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 ; Esta API é usada para enviar o URL de redefinição de senha para uma conta especificada. Nota: Se você tiver o fluxo de trabalho UserName habilitado, poderá substituir o parâmetro 'email' por 'username' Mais informações
var email = "email" ; //Required
var resetPasswordUrl = "resetPasswordUrl" ; //Required
var emailTemplate = "emailTemplate" ; //Optional
var apiResponse = new AuthenticationApi ( ) . ForgotPassword ( email , resetPasswordUrl , emailTemplate ) . Result ; Esta API cria um usuário no banco de dados e também envia um email de verificação ao usuário. Mais informações
