Aliyun Short Message Service を使用して SMS 認証を設定する

Aliyun ショートメッセージサービスの公式 Logto コネクターです。

ヒント:

このガイドは、Logto コネクターについての基本的な理解があることを前提としています。未経験の方は、コネクター ガイドを参照して始めてください。

はじめに

Aliyun はアジアの主要なクラウドサービスプロバイダーであり、SMS（ショートメッセージサービス）を含む多くのクラウドサービスを提供しています。Aliyun SMS コネクターは、Logto チームが提供するプラグインで、Aliyun SMS サービスを呼び出すために使用されます。これにより、Logto のエンドユーザーは SMS 認証コードを使用して Logto アカウントに登録およびサインインできます。

Aliyun SMS コンソールでショートメッセージサービスを設定する

Aliyun アカウントを作成する

Aliyun のウェブサイトにアクセスし、まだアカウントを持っていない場合は Aliyun アカウントを登録してください。

Aliyun ショートメッセージサービスを有効化および設定する

1. Aliyun のウェブサイトで Aliyun アカウントにサインインし、SMS サービスコンソールページに移動します。
2. SMS サービスページの左上にある「無料開通」(Open for free) ボタンをクリックして、設定プロセスを開始します。
3. 「SMS サービス開通条款」(SMS service activation Agreement) を読み、同意して「开通服务」(Subscribe to a service) をクリックして次に進みます。
4. 現在 SMS サービスコンソールページ にいます。使用ケースに応じて、サイドバーの「国内消息」(Mainland China) または「国际/港澳台消息」(Outside Mainland China) ボタンに移動します。
5. ガイドラインに従って署名とテンプレートを追加し、レビューに必要な資料または情報を提供します。
   • 署名申請を記入する際には「验证码」(Verification Code Message) を「适用场景」(Scenario) として選択し、テンプレートレビューを申請する際には「模板类型」(Type) として「验证码」(Verification Code Message) を選択してください。これらの署名とテンプレートを使用して認証コードを送信します。現在、認証コード関連のテキストメッセージ以外の SMS メッセージの送信はサポートしていません。
   • テンプレート内容にデジタル認証コードを配置したい場所には {{code}} をプレースホルダーとして使用してください。
6. SMS 署名とテンプレートの申請を提出した後、それが有効になるのを待つ必要があります。この時点で、SMS サービスコンソールページ に戻り、テスト SMS を送信できます。署名とテンプレートが使用可能であれば、直接試すことができます。まだ有効でない場合、Aliyun はテストテンプレートも提供しています。
   • テストメッセージを送信する前に少額のチャージが必要な場合があります。
   • テストメッセージを送信する前にテスト用の電話番号を登録するよう求められる場合もあります。詳細については、SMS サービスコンソールページ のサイドバーから「快速学习」(Quick Start) タブに移動してください。

コネクター JSON を作成する

1. SMS サービスコンソールページ から、右上のアバターにカーソルを合わせて「AccessKey 管理」(AccessKey Management) に移動し、「创建 AccessKey」(Create AccessKey) をクリックします。セキュリティ検証を完了すると、「AccessKey ID」と「AccessKey Secret」のペアが取得できます。これらを適切に保管してください。
2. 先ほど訪れた「国内消息」(Mainland China) または「国际/港澳台消息」(Outside Mainland China) タブに移動し、「签名名称」(Signature) と「模板 CODE」(Template Code) を簡単に見つけることができます。
   • テスト専用の署名とテンプレートを使用したい場合は、「快速学习」(Quick Start) タブに移動し、「Signature & Templates (For Test Only)」の下にそれらを見つけることができます。
3. Aliyun SMS コネクターの設定を入力します：
   • ステップ 1 で取得したアクセスキーのペアを accessKeyId と accessKeySecret フィールドに入力します。
   • ステップ 2 で言及された「签名名称」(Signature) を signName フィールドに入力します。すべてのテンプレートはこの署名名を共有します。
   • 異なるケースに対して複数の SMS コネクターテンプレートを追加できます。単一のテンプレートを追加する例を以下に示します：
     • ステップ 2 からの「模板 CODE」(Template Code) を使用して、SMS コンテキストを制御する templateCode フィールドを入力します。
     • usageType フィールドには、Register、SignIn、ForgotPassword、または Generic のいずれかを異なる使用ケースに応じて入力します。(usageType は適切な使用ケースを識別するための Logto プロパティです。) 完全なユーザーフローを有効にするためには、Register、SignIn、ForgotPassword、および Generic の usageType を持つテンプレートが必要です。

Aliyun SMS コネクターをテストする

電話番号を入力し、「送信」をクリックして設定が機能するかどうかを「保存して完了」する前に確認できます。

以上です。サインイン体験で コネクターを有効にする のを忘れないでください。

設定タイプ

名前	タイプ
accessKeyId	string
accessKeySecret	string
signName	string
templates	Template[]

テンプレートプロパティ	タイプ	列挙値
templateCode	string	N/A
usageType	enum string	'Register' | 'SignIn' | 'ForgotPassword' | 'Generic'

参考文献

Aliyun SMS - Quick Start