dot net sdk
Released Version 11.6.0
Le wrapper d’enregistrement client LoginRadius ASP.NET donne accès à l’API de la plateforme de gestion des identités LoginRadius.
LoginRadius est une plateforme de gestion des identités qui simplifie l'enregistrement des utilisateurs tout en sécurisant les données. La plateforme LoginRadius simplifie et sécurise votre processus d'enregistrement d'utilisateur, augmente la conversion avec la connexion sociale qui combine 30 principales plateformes sociales et offre une solution complète avec l'enregistrement d'utilisateur traditionnel. Vous pouvez rassembler une multitude de données de profil utilisateur à partir de la connexion sociale ou de l'enregistrement d'utilisateur traditionnel.
LoginRadius centralise tout en un seul endroit, ce qui facilite la gestion et l'accès. Intégrez facilement LoginRadius à toutes vos applications tierces, comme MailChimp, Google Analytics, Livefyre et bien d'autres, facilitant ainsi l'utilisation des données que vous capturez.
LoginRadius aide les entreprises à renforcer l'engagement des utilisateurs sur leur plate-forme Web/mobile, à gérer les identités en ligne, à utiliser les médias sociaux à des fins de marketing, à capturer des données précises sur les consommateurs et à obtenir un aperçu social unique de leur clientèle.
Veuillez visiter ici pour plus d'informations.
Cette documentation suppose que vous avez travaillé sur l'implémentation côté client pour configurer vos interfaces d'enregistrement d'utilisateur LoginRadius qui serviront au processus d'enregistrement et de connexion initial. Des détails à ce sujet peuvent être trouvés dans le guide de démarrage.
**Remarque : **LoginRadius utilise le protocole standard TLS 1.2, conçu pour aider à protéger la confidentialité des informations communiquées sur Internet. Afin d'utiliser le SDK LoginRadius .Net, ajoutez le code suivant avant d'instancier votre service Web dans le fichier Global.asax de votre projet.
ServicePointManager . SecurityProtocol = SecurityProtocolType . Tls | SecurityProtocolType . Tls11 | SecurityProtocolType . Tls12 ; Téléchargez le SDK .Net d'enregistrement des utilisateurs depuis Github
Copiez les fichiers LoginRadiusSDK.V2.dll et LoginRadiusSDK.V2.pdb dans le répertoire Références de votre projet ASP.NET.
OU
PM> Install-Package LoginRadiusSDK.NET
OU
Ouvrez la solution à l'aide de Visual Studio 2019.
Construisez le projet et notez où se trouve le fichier .nupkg.
Accédez aux paramètres du gestionnaire de packages NuGet et importez le répertoire où se trouve le fichier .nupkg.
Accédez à l'outil "Gérer les packages NuGet pour les solutions...", remplacez la source par la source nouvellement créée, puis sélectionnez et installez le SDK LoginRadius.
Ensuite, incluez les espaces de noms suivants dans votre projet :
using LoginRadiusSDK . V2 . Api ;
using LoginRadiusSDK . V2 . Models ; Avant d'utiliser le SDK, vous devez initialiser le SDK à l'aide du code suivant : Clé API et secret de votre site LoginRadius. Ces informations peuvent être trouvées dans votre compte LoginRadius comme décrit ici
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
Pour ASP.NET. dans 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
Pour .NET Core, dans 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/ "
}
Lors de l'initialisation du SDK, spécifiez éventuellement un domaine personnalisé. Exemple : Dans appsettings.json, ajoutez l'instruction suivante :
"domainName" : " https://api.loginradius.com/ "Lors de l'initialisation du SDK, vous pouvez éventuellement spécifier l'activation de cette fonctionnalité. L'activation de cette fonctionnalité signifie que le client n'a pas besoin de transmettre un secret API dans une requête API. Au lieu de cela, ils peuvent transmettre une valeur de hachage générée dynamiquement. Cette fonctionnalité garantira également que le message n'est pas falsifié pendant le transit lorsque quelqu'un appelle nos API. Exemple : Dans appsettings.json, ajoutez l'instruction suivante :
"ApiRequestSigning" : " false "X-Origin-IP LoginRadius vous permet d'ajouter X-Origin-IP dans vos en-têtes et détermine l'adresse IP de la demande du client, cela peut également être utile pour surmonter les écarts d'analyse lorsque les analyses dépendent des données d'en-tête.
"originIp" : " <Client-Ip-Address> " Liste des API dans cette section :
PUT : Profil de mise à jour d'authentification par jeton
PUT : compte de déverrouillage d'authentification par jeton d'accès
PUT : Auth Vérifier l'e-mail par OTP
PUT : Mot de passe de réinitialisation d'authentification par réponse de sécurité et e-mail
PUT : Mot de passe de réinitialisation d'authentification par réponse de sécurité et téléphone
PUT : Mot de passe de réinitialisation d'authentification par réponse de sécurité et nom d'utilisateur
PUT : Mot de passe de réinitialisation d'authentification par jeton de réinitialisation
PUT : Mot de passe de réinitialisation d'authentification par OTP
PUT : Mot de passe de réinitialisation d'authentification par OTP et nom d'utilisateur
PUT : Mot de passe de changement d'authentification
POST : Identités sociales de lien d'authentification
POST : Auth Link Social Identities By Ping
PUT : définir l'authentification ou modifier le nom d'utilisateur
PUT : vérification de l'e-mail de renvoi d'authentification
POST : Authentifier Ajouter un e-mail
POST : Connexion d'authentification par e-mail
POST : Connexion d'authentification par nom d'utilisateur
POST : Auth. Mot de passe oublié
POST : Inscription de l'utilisateur authentifié par e-mail
POST : Inscription de l'utilisateur authentifié par Captcha
OBTENIR : Recevoir des questions de sécurité par e-mail
GET : obtenir des questions de sécurité par nom d'utilisateur
GET : Obtenez des questions de sécurité par téléphone
GET : obtenez des questions de sécurité par jeton d'accès
GET : Jeton d'accès de validation d'authentification
GET : jeton d'accès invalidé
GET : informations sur le jeton d'accès
GET : Auth Lire tous les profils par jeton
GET : Auth Envoyer un e-mail de bienvenue
GET : Auth Supprimer le compte
GET : Obtenir un profil par Ping
GET : vérification d'authentification de la disponibilité des e-mails
OBTENIR : E-mail de vérification d'authentification
GET : Authentification de l'identité sociale
GET : vérification d'authentification de la disponibilité du nom d'utilisateur
GET : Politique de confidentialité d'authentification Accepter
GET : Authentifier l'historique de la politique de confidentialité par jeton d'accès
GET : E-mail de vérification d'envoi d'authentification pour lier les profils sociaux
SUPPRIMER : Authentifier le compte de suppression avec confirmation par e-mail
SUPPRIMER : Auth Supprimer l'e-mail
SUPPRIMER : Auth dissocier les identités sociales
Cette API est utilisée pour mettre à jour le profil de l'utilisateur en passant le access_token. Plus d'informations
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 ; Cette API est utilisée pour permettre à un client disposant d'un access_token valide de déverrouiller son compte à condition qu'il réussisse les défis de protection contre les robots demandés. Les types de bloc Bloquer ou Suspendre ne sont pas applicables pour cette API. Pour plus de détails, consultez notre documentation sur la configuration de la sécurité d'authentification. Vous devez uniquement transmettre les paramètres de publication qui correspondent aux défis demandés. Plus d'informations
var accessToken = "accessToken" ; //Required
UnlockProfileModel unlockProfileModel = new UnlockProfileModel {
G_recaptcha_response = "<G-recaptcha-response>"
} ; //Required
var apiResponse = new AuthenticationApi ( ) . UnlockAccountByToken ( accessToken , unlockProfileModel ) . Result ; Cette API est utilisée pour vérifier l'e-mail de l'utilisateur lorsque le flux de vérification des e-mails OTP est activé. Veuillez noter que vous devez contacter LoginRadius pour activer cette fonctionnalité. Plus d'informations
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 ; Cette API est utilisée pour réinitialiser le mot de passe du compte spécifié par question de sécurité. Plus d'informations
ResetPasswordBySecurityAnswerAndEmailModel resetPasswordBySecurityAnswerAndEmailModel = new ResetPasswordBySecurityAnswerAndEmailModel {
Email = "<Email>" ,
Password = "<Password>" ,
SecurityAnswer = new Dictionary < String , String > {
[ "QuestionID" ] = "Answer"
}
} ; //Required
var apiResponse = new AuthenticationApi ( ) . ResetPasswordBySecurityAnswerAndEmail ( resetPasswordBySecurityAnswerAndEmailModel ) . Result ; Cette API est utilisée pour réinitialiser le mot de passe du compte spécifié par question de sécurité. Plus d'informations
ResetPasswordBySecurityAnswerAndPhoneModel resetPasswordBySecurityAnswerAndPhoneModel = new ResetPasswordBySecurityAnswerAndPhoneModel {
Password = "<Password>" ,
Phone = "<Phone>" ,
SecurityAnswer = new Dictionary < String , String > {
[ "QuestionID" ] = "Answer"
}
} ; //Required
var apiResponse = new AuthenticationApi ( ) . ResetPasswordBySecurityAnswerAndPhone ( resetPasswordBySecurityAnswerAndPhoneModel ) . Result ; Cette API est utilisée pour réinitialiser le mot de passe du compte spécifié par question de sécurité. Plus d'informations
ResetPasswordBySecurityAnswerAndUserNameModel resetPasswordBySecurityAnswerAndUserNameModel = new ResetPasswordBySecurityAnswerAndUserNameModel {
Password = "<Password>" ,
SecurityAnswer = new Dictionary < String , String > {
[ "QuestionID" ] = "Answer"
} ,
UserName = "<UserName>"
} ; //Required
var apiResponse = new AuthenticationApi ( ) . ResetPasswordBySecurityAnswerAndUserName ( resetPasswordBySecurityAnswerAndUserNameModel ) . Result ; Cette API est utilisée pour définir un nouveau mot de passe pour le compte spécifié. Plus d'informations
ResetPasswordByResetTokenModel resetPasswordByResetTokenModel = new ResetPasswordByResetTokenModel {
Password = "<Password>" ,
ResetToken = "<ResetToken>"
} ; //Required
var apiResponse = new AuthenticationApi ( ) . ResetPasswordByResetToken ( resetPasswordByResetTokenModel ) . Result ; Cette API est utilisée pour définir un nouveau mot de passe pour le compte spécifié. Plus d'informations
ResetPasswordByEmailAndOtpModel resetPasswordByEmailAndOtpModel = new ResetPasswordByEmailAndOtpModel {
Email = "<Email>" ,
Otp = "<Otp>" ,
Password = "<Password>"
} ; //Required
var apiResponse = new AuthenticationApi ( ) . ResetPasswordByEmailOTP ( resetPasswordByEmailAndOtpModel ) . Result ; Cette API est utilisée pour définir un nouveau mot de passe pour le compte spécifié si vous utilisez le nom d'utilisateur comme identifiant unique dans votre flux de travail. Plus d'informations
ResetPasswordByUserNameModel resetPasswordByUserNameModel = new ResetPasswordByUserNameModel {
Otp = "<Otp>" ,
Password = "<Password>" ,
UserName = "<UserName>"
} ; //Required
var apiResponse = new AuthenticationApi ( ) . ResetPasswordByOTPAndUserName ( resetPasswordByUserNameModel ) . Result ; Cette API est utilisée pour modifier le mot de passe du compte en fonction du mot de passe précédent. Plus d'informations
var accessToken = "accessToken" ; //Required
var newPassword = "newPassword" ; //Required
var oldPassword = "oldPassword" ; //Required
var apiResponse = new AuthenticationApi ( ) . ChangePassword ( accessToken , newPassword , oldPassword ) . Result ; Cette API est utilisée pour lier un compte de fournisseur social au compte spécifié en fonction du jeton d'accès et du jeton d'accès utilisateur du fournisseur social. Plus d'informations
var accessToken = "accessToken" ; //Required
var candidateToken = "candidateToken" ; //Required
var apiResponse = new AuthenticationApi ( ) . LinkSocialIdentities ( accessToken , candidateToken ) . Result ; Cette API est utilisée pour lier un compte de fournisseur social à un compte LoginRadius existant sur la base du ping et du jeton d'accès utilisateur du fournisseur social. Plus d'informations
var accessToken = "accessToken" ; //Required
var clientGuid = "clientGuid" ; //Required
var apiResponse = new AuthenticationApi ( ) . LinkSocialIdentitiesByPing ( accessToken , clientGuid ) . Result ; Cette API est utilisée pour définir ou modifier UserName par jeton d'accès. Plus d'informations
var accessToken = "accessToken" ; //Required
var username = "username" ; //Required
var apiResponse = new AuthenticationApi ( ) . SetOrChangeUserName ( accessToken , username ) . Result ; Cette API renvoie l'e-mail de vérification à l'utilisateur. Plus d'informations
var email = "email" ; //Required
var emailTemplate = "emailTemplate" ; //Optional
var verificationUrl = "verificationUrl" ; //Optional
var apiResponse = new AuthenticationApi ( ) . AuthResendEmailVerification ( email , emailTemplate , verificationUrl ) . Result ; Cette API est utilisée pour ajouter des e-mails supplémentaires au compte d'un utilisateur. Plus d'informations
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 ; Cette API récupère une copie des données utilisateur en fonction de l'e-mail Plus d'informations
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 ; Cette API récupère une copie des données utilisateur en fonction du nom d'utilisateur Plus d'informations
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 ; Cette API est utilisée pour envoyer l'URL de réinitialisation du mot de passe à un compte spécifié. Remarque : Si le workflow UserName est activé, vous pouvez remplacer le paramètre "email" par "username". Plus d'informations
var email = "email" ; //Required
var resetPasswordUrl = "resetPasswordUrl" ; //Required
var emailTemplate = "emailTemplate" ; //Optional
var apiResponse = new AuthenticationApi ( ) . ForgotPassword ( email , resetPasswordUrl , emailTemplate ) . Result ; Cette API crée un utilisateur dans la base de données et envoie un e-mail de vérification à l'utilisateur. Plus d'informations
