dot net sdk

LoginRadius .NET SDK

導入

LoginRadius ASP.NET Customer Registration ラッパーは、LoginRadius ID 管理プラットフォーム API へのアクセスを提供します。

LoginRadius は、データを保護しながらユーザー登録を簡素化する ID 管理プラットフォームです。 LoginRadius プラットフォームは、ユーザー登録プロセスを簡素化して安全にし、30 の主要なソーシャル プラットフォームを組み合わせたソーシャル ログインでコンバージョンを増加させ、従来のユーザー登録による完全なソリューションを提供します。ソーシャル ログインまたは従来のユーザー登録から豊富なユーザー プロファイル データを収集できます。

LoginRadius はすべてを 1 か所に集中させ、管理とアクセスを簡単にします。 LoginRadius を MailChimp、Google Analytics、Livefyre などのすべてのサードパーティ アプリケーションと簡単に統合できるため、キャプチャしているデータを簡単に利用できるようになります。

LoginRadius は、企業が Web/モバイル プラットフォームでのユーザー エンゲージメントを高め、オンライン ID を管理し、ソーシャル メディアをマーケティングに活用し、正確な消費者データを取得し、顧客ベースに関する独自の社会的洞察を得るのに役立ちます。

詳細については、こちらをご覧ください。

前提条件

• .NET 4.0以降 / .NetStandard 1.3以降

インストール

このドキュメントでは、クライアント側の実装を行って、初期登録およびログイン プロセスを実行する LoginRadius ユーザー登録インターフェイスをセットアップしていることを前提としています。詳細については、スタート ガイドを参照してください。

**注意: **LoginRadius は、インターネット上で通信される情報のプライバシーを保護するために設計された業界標準の TLS 1.2 プロトコルを使用します。 LoginRadius .Net SDK を使用するには、プロジェクトのGlobal.asaxファイルで Web サービスをインスタンス化する前に、次のコードを追加します。

 ServicePointManager . SecurityProtocol = SecurityProtocolType . Tls | SecurityProtocolType . Tls11 | SecurityProtocolType . Tls12 ; 

必要なライブラリのインポート

• Github からユーザー登録 .Net SDK をダウンロードします。

• LoginRadiusSDK.V2.dll ファイルと LoginRadiusSDK.V2.pdb ファイルを ASP.NET プロジェクトの References ディレクトリにコピーします。

または

• NuGet パッケージ マネージャー コンソールで次のコマンドを実行します。

 PM> Install-Package LoginRadiusSDK.NET

または

• Visual Studio 2019 を使用してソリューションを開きます。

• プロジェクトをビルドし、.nupkg ファイルの場所をメモします。

• NuGet パッケージ マネージャーの設定にアクセスし、.nupkg ファイルが配置されているディレクトリをインポートします。

• 「ソリューションの NuGet パッケージの管理...」ツールにアクセスし、ソースを新しく作成したソースに変更し、LoginRadius SDK を選択してインストールします。

次に、プロジェクトに次の名前空間を含めます。

 using LoginRadiusSDK . V2 . Api ;
using LoginRadiusSDK . V2 . Models ; 

クイックスタートガイド

SDK を使用する前に、次のコードを使用して SDK を初期化する必要があります: LoginRadius サイトの API キーとシークレット。この情報は、ここで説明されているように、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/" ;

または

ASP.NETの場合。 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/ "

API リクエストの署名

SDK を初期化するときに、オプションでこの機能の有効化を指定できます。この機能を有効にすると、顧客は API リクエストで API シークレットを渡す必要がなくなります。代わりに、動的に生成されたハッシュ値を渡すことができます。この機能により、誰かが API を呼び出したときに、転送中にメッセージが改ざんされないようにできます。例: appsettings.json に次のステートメントを追加します。

 "ApiRequestSigning" : " false "

X-Origin-IP LoginRadius を使用すると、ヘッダーに X-Origin-IP を追加でき、クライアントのリクエストの IP アドレスが決定されます。これは、分析がヘッダー データに依存する場合の分析の不一致を克服するのにも役立ちます。

 "originIp" : " <Client-Ip-Address> " 

API

認証API

このセクションの API のリスト:
PUT : トークンによる認証更新プロファイル
PUT : アクセストークンによるアカウントの認証ロック解除
PUT : OTP による認証メールの検証
PUT : セキュリティアンサーと電子メールによる認証パスワードのリセット
PUT : セキュリティアンサーと電話による認証パスワードのリセット
PUT : セキュリティの回答とユーザー名による認証パスワードのリセット
PUT : リセットトークンによる認証パスワードのリセット
PUT : OTP による認証パスワードのリセット
PUT : OTP とユーザー名による認証パスワードのリセット
PUT : 認証パスワード変更
POST : 認証リンクのソーシャル アイデンティティ
POST : Ping によるソーシャル ID の認証リンク
PUT : 認証 ユーザー名の設定または変更
PUT : 認証再送信メール検証
POST : 認証メールの追加
POST : メールによる認証ログイン
POST : ユーザー名による認証ログイン
POST : 認証パスワードを忘れた場合
POST : メールによる認証ユーザー登録
POST : キャプチャによる認証ユーザー登録
GET : セキュリティの質問をメールで取得する
GET : ユーザー名でセキュリティの質問を取得
GET : 電話で秘密の質問を取得する
GET : アクセストークンによる秘密の質問の取得
GET : 認証検証アクセストークン
GET : アクセストークンの無効化
GET : アクセストークン情報
GET : 認証 トークンによるすべてのプロファイルの読み取り
GET : 認証 ようこそメールを送信
GET : アカウントの認証削除
GET : Pingによるプロフィールの取得
GET : 認証メールの可用性を確認する
GET : 認証確認メール
GET : 認証ソーシャルアイデンティティ
GET : 認証 ユーザー名が利用可能かどうかを確認する
GET : 認証 プライバシー ポリシー 同意する
GET : アクセストークンによる認証プライバシーポリシー履歴
GET : 認証送信検証 ソーシャルプロファイルをリンクするための電子メール
DELETE : メール確認によるアカウント削除の認証
DELETE : 認証メール削除
DELETE : 認証、ソーシャル アイデンティティのリンク解除

トークンによる認証更新プロファイル (PUT)

この 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 ; 

アクセストークン(PUT)によるアカウントの認証ロック解除

この API は、有効な access_token を持つ顧客が、要求されたボット保護チャレンジに合格した場合に、アカウントのロックを解除できるようにするために使用されます。 Block または Suspend ブロック タイプは、この API には適用されません。詳細については、認証セキュリティ構成ドキュメントを参照してください。要求されるのは、要求されたチャレンジに対応する Post パラメータを渡すことだけです。詳細情報

 var accessToken = "accessToken" ; //Required
UnlockProfileModel unlockProfileModel = new UnlockProfileModel {
G_recaptcha_response = "<G-recaptcha-response>"
} ; //Required
var apiResponse = new AuthenticationApi ( ) . UnlockAccountByToken ( accessToken , unlockProfileModel ) . Result ; 

OTP (PUT) による電子メールの認証検証

この 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 ; 

セキュリティアンサーと電子メールによる認証パスワードのリセット (PUT)

この API は、セキュリティの質問によって指定されたアカウントのパスワードをリセットするために使用されます。

 ResetPasswordBySecurityAnswerAndEmailModel resetPasswordBySecurityAnswerAndEmailModel = new ResetPasswordBySecurityAnswerAndEmailModel {
Email = "<Email>" ,
Password = "<Password>" ,
SecurityAnswer = new Dictionary < String , String > {
[ "QuestionID" ] = "Answer"
}
} ; //Required
var apiResponse = new AuthenticationApi ( ) . ResetPasswordBySecurityAnswerAndEmail ( resetPasswordBySecurityAnswerAndEmailModel ) . Result ; 

セキュリティ応答と電話による認証パスワードのリセット (PUT)

この API は、セキュリティの質問によって指定されたアカウントのパスワードをリセットするために使用されます。

 ResetPasswordBySecurityAnswerAndPhoneModel resetPasswordBySecurityAnswerAndPhoneModel = new ResetPasswordBySecurityAnswerAndPhoneModel {
Password = "<Password>" ,
Phone = "<Phone>" ,
SecurityAnswer = new Dictionary < String , String > {
[ "QuestionID" ] = "Answer"
}
} ; //Required
var apiResponse = new AuthenticationApi ( ) . ResetPasswordBySecurityAnswerAndPhone ( resetPasswordBySecurityAnswerAndPhoneModel ) . Result ; 

セキュリティ回答とユーザー名による認証パスワードのリセット (PUT)

この API は、セキュリティの質問によって指定されたアカウントのパスワードをリセットするために使用されます。

 ResetPasswordBySecurityAnswerAndUserNameModel resetPasswordBySecurityAnswerAndUserNameModel = new ResetPasswordBySecurityAnswerAndUserNameModel {
Password = "<Password>" ,
SecurityAnswer = new Dictionary < String , String > {
[ "QuestionID" ] = "Answer"
} ,
UserName = "<UserName>"
} ; //Required
var apiResponse = new AuthenticationApi ( ) . ResetPasswordBySecurityAnswerAndUserName ( resetPasswordBySecurityAnswerAndUserNameModel ) . Result ; 

リセットトークンによる認証パスワードリセット(PUT)

この API は、指定されたアカウントの新しいパスワードを設定するために使用されます。詳細情報

 ResetPasswordByResetTokenModel resetPasswordByResetTokenModel = new ResetPasswordByResetTokenModel {
Password = "<Password>" ,
ResetToken = "<ResetToken>"
} ; //Required
var apiResponse = new AuthenticationApi ( ) . ResetPasswordByResetToken ( resetPasswordByResetTokenModel ) . Result ; 

OTP (PUT) による認証パスワードのリセット

この API は、指定されたアカウントの新しいパスワードを設定するために使用されます。詳細情報

 ResetPasswordByEmailAndOtpModel resetPasswordByEmailAndOtpModel = new ResetPasswordByEmailAndOtpModel {
Email = "<Email>" ,
Otp = "<Otp>" ,
Password = "<Password>"
} ; //Required
var apiResponse = new AuthenticationApi ( ) . ResetPasswordByEmailOTP ( resetPasswordByEmailAndOtpModel ) . Result ; 

OTP およびユーザー名による認証パスワードのリセット (PUT)

この API は、ワークフロー内でユーザー名を一意の識別子として使用している場合に、指定されたアカウントの新しいパスワードを設定するために使用されます。

 ResetPasswordByUserNameModel resetPasswordByUserNameModel = new ResetPasswordByUserNameModel {
Otp = "<Otp>" ,
Password = "<Password>" ,
UserName = "<UserName>"
} ; //Required
var apiResponse = new AuthenticationApi ( ) . ResetPasswordByOTPAndUserName ( resetPasswordByUserNameModel ) . Result ; 

認証パスワード変更(PUT)

この API は、以前のパスワードに基づいてアカウントのパスワードを変更するために使用されます。

 var accessToken = "accessToken" ; //Required
var newPassword = "newPassword" ; //Required
var oldPassword = "oldPassword" ; //Required
var apiResponse = new AuthenticationApi ( ) . ChangePassword ( accessToken , newPassword , oldPassword ) . Result ; 

認証リンク ソーシャル アイデンティティ (POST)

この API は、アクセス トークンとソーシャル プロバイダーのユーザー アクセス トークンに基づいて、ソーシャル プロバイダー アカウントを指定されたアカウントにリンクするために使用されます。詳細情報

 var accessToken = "accessToken" ; //Required
var candidateToken = "candidateToken" ; //Required
var apiResponse = new AuthenticationApi ( ) . LinkSocialIdentities ( accessToken , candidateToken ) . Result ; 

Ping によるソーシャル ID の認証リンク (POST)

この API は、ping およびソーシャル プロバイダーのユーザー アクセス トークンに基づいて、ソーシャル プロバイダー アカウントを既存の LoginRadius アカウントにリンクするために使用されます。詳細情報

 var accessToken = "accessToken" ; //Required
var clientGuid = "clientGuid" ; //Required
var apiResponse = new AuthenticationApi ( ) . LinkSocialIdentitiesByPing ( accessToken , clientGuid ) . Result ; 

認証 ユーザー名の設定または変更 (PUT)

この API は、アクセス トークンによって UserName を設定または変更するために使用されます。詳細情報

 var accessToken = "accessToken" ; //Required
var username = "username" ; //Required
var apiResponse = new AuthenticationApi ( ) . SetOrChangeUserName ( accessToken , username ) . Result ; 

認証再送信メール検証 (PUT)

この API は、確認メールをユーザーに再送信します。詳細情報

 var email = "email" ; //Required
var emailTemplate = "emailTemplate" ; //Optional
var verificationUrl = "verificationUrl" ; //Optional
var apiResponse = new AuthenticationApi ( ) . AuthResendEmailVerification ( email , emailTemplate , verificationUrl ) . Result ; 

認証メール追加 (POST)

この 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 ; 

電子メールによる認証ログイン (POST)

この 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 ; 

ユーザー名による認証ログイン (POST)

この 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 ; 

認証パスワードを忘れた場合 (POST)

この API は、指定されたアカウントにパスワードのリセット URL を送信するために使用されます。注: UserName ワークフローを有効にしている場合は、「email」パラメータを「username」に置き換えることができます。

 var email = "email" ; //Required
var resetPasswordUrl = "resetPasswordUrl" ; //Required
var emailTemplate = "emailTemplate" ; //Optional
var apiResponse = new AuthenticationApi ( ) . ForgotPassword ( email , resetPasswordUrl , emailTemplate ) . Result ; 

メールによる認証ユーザー登録（POST）

この API は、データベース内にユーザーを作成し、ユーザーに確認メールを送信します。詳細情報