Alipay (Web) サインインを Capacitor JS で構築する方法

新しい友達のために:

Logto は、モダンなアプリや SaaS 製品向けに設計された Auth0 の代替です。 Cloud とオープンソースの両方のサービスを提供し、アイデンティティと管理 (IAM) システムを迅速に立ち上げるのに役立ちます。認証 (Authentication)、認可 (Authorization)、マルチテナント管理をすべて一つにまとめて楽しんでください。

Logto Cloud で無料の開発テナントから始めることをお勧めします。これにより、すべての機能を簡単に探索できます。

この記事では、Capacitor JS と Logto を使用して、Alipay (Web) サインイン体験（ユーザー認証 (Authentication)）を迅速に構築する手順を説明します。

前提条件

稼働中の Logto インスタンス。紹介ページをチェックして始めてください。
Capacitor JS の基本的な知識。
使用可能な Alipay (Web) アカウント。

Logto でアプリケーションを作成する

Logto は OpenID Connect (OIDC) 認証 (Authentication) と OAuth 2.0 認可 (Authorization) に基づいています。これは、複数のアプリケーション間でのフェデレーテッドアイデンティティ管理をサポートし、一般的にシングルサインオン (SSO) と呼ばれます。

あなたのネイティブアプリアプリケーションを作成するには、次の手順に従ってください：

Logto コンソールを開きます。「Get started」セクションで、「View all」リンクをクリックしてアプリケーションフレームワークのリストを開きます。あるいは、Logto Console > Applications に移動し、「Create application」ボタンをクリックします。
開いたモーダルで、左側のクイックフィルターチェックボックスを使用して、利用可能なすべての "ネイティブアプリ" フレームワークをフィルタリングするか、"ネイティブアプリ" セクションをクリックします。"Capacitor JS" フレームワークカードをクリックして、アプリケーションの作成を開始します。
アプリケーション名を入力します。例：「Bookstore」と入力し、「Create application」をクリックします。

🎉 タダーン！Logto で最初のアプリケーションを作成しました。詳細な統合ガイドを含むお祝いページが表示されます。ガイドに従って、アプリケーションでの体験を確認してください。

Capacitor JS SDK を統合する

ヒント:

次のデモンストレーションは、Capacitor JS 5.0.6 に基づいています。

インストール

お気に入りのパッケージマネージャーを使用して Logto SDK とピア依存関係をインストールします：

npm
Yarn
pnpm

npm i @logto/capacitor
npm i @capacitor/browser @capacitor/app @capacitor/preferences

yarn add @logto/capacitor
yarn add @capacitor/browser @capacitor/app @capacitor/preferences

pnpm add @logto/capacitor
pnpm add @capacitor/browser @capacitor/app @capacitor/preferences

@logto/capacitor パッケージは Logto の SDK です。残りのパッケージはそのピア依存関係です。

Logto クライアントの初期化

次のコードを Capacitor プロジェクトに追加します：

import LogtoClient, { type LogtoConfig } from '@logto/capacitor';

const logtoConfig: LogtoConfig = {
  endpoint: '<your-logto-endpoint>',
  appId: '<your-application-id>',
};

const logtoClient = new LogtoClient(config);

詳細に入る前に、エンドユーザーの体験について簡単に説明します。サインインプロセスは次のように簡略化できます：

あなたのアプリがサインインメソッドを呼び出します。
ユーザーは Logto のサインインページにリダイレクトされます。ネイティブアプリの場合、システムブラウザが開かれます。
ユーザーがサインインし、あなたのアプリにリダイレクトされます（リダイレクト URI として設定されています）。

この認証 (Authentication) プロセスは OpenID Connect (OIDC) プロトコルに従い、Logto はユーザーのサインインを保護するために厳格なセキュリティ対策を講じています。
複数のアプリがある場合、同じアイデンティティプロバイダー (Logto) を使用できます。ユーザーがあるアプリにサインインすると、Logto は別のアプリにアクセスした際に自動的にサインインプロセスを完了します。

リダイレクトベースのサインインの理論と利点について詳しく知るには、Logto サインイン体験の説明を参照してください。

次に、リダイレクト URI を設定しましょう。リダイレクト URI は、認証 (Authentication) フローの後にユーザーをアプリケーションに戻すために使用されます。

URI が Capacitor アプリにリダイレクトすることを確認してください。例えば、com.example.app://callback のようにします。この値は、Capacitor アプリの設定によって異なる場合があります。詳細については、Capacitor Deep Links を参照してください。

次に、サインインボタンの onClick ハンドラーに次のコードを追加します：

const onClick = async () => {
  await logtoClient.signIn('com.example.app://callback');
  console.log(await logtoClient.isAuthenticated()); // true
  console.log(await logtoClient.getIdTokenClaims()); // { sub: '...', ... }
};

サインアウトの実装

Capacitor は iOS では Safari View Controller、Android では Chrome Custom Tabs を利用しているため、認証 (Authentication) 状態はしばらく保持されることがあります。しかし、ユーザーがすぐにアプリケーションからサインアウトしたい場合もあります。この場合、signOut メソッドを使用してユーザーをサインアウトできます：

const onClick = async () => {
  await logtoClient.signOut();
  console.log(await logtoClient.isAuthenticated()); // false
};

signOut メソッドには、サインアウト後のリダイレクト URI のオプションパラメータがあります。指定されていない場合、ユーザーは Logto のサインアウトページにリダイレクトされます。

ユーザーは「完了」をクリックしてウェブビューを閉じ、Capacitor アプリに戻る必要があります。ユーザーを自動的に Capacitor アプリに戻したい場合は、サインアウト後のリダイレクト URI を指定できます。例えば、com.example.app://callback/sign-out のようにします。

サインアウト後のリダイレクト URI が Capacitor アプリにリダイレクトできることを確認してください。次に、サインアウトボタンの onClick ハンドラーに次のコードを追加します：

const onClick = async () => {
  await logtoClient.signOut('com.example.app://callback/sign-out');
};

チェックポイント: 認証 (Authentication) フローをトリガーする

Capacitor アプリを実行し、サインインボタンをクリックします。ブラウザウィンドウが開き、Logto のサインインページにリダイレクトされます。

ユーザーが認証 (Authentication) フローを完了せずにブラウザウィンドウを閉じた場合、Capacitor アプリは LogtoClientError を受け取ります。

Alipay (Web) コネクターを追加する

迅速なサインインを有効にし、ユーザーコンバージョンを向上させるために、アイデンティティプロバイダー (IdP) として Capacitor JS を接続します。Logto ソーシャルコネクターは、いくつかのパラメーター入力を許可することで、この接続を数分で確立するのに役立ちます。

ソーシャルコネクターを追加するには、次の手順に従ってください：

Console > Connectors > Social Connectors に移動します。
「Add social connector」をクリックし、「Alipay (Web)」を選択します。
README ガイドに従い、必要なフィールドを完了し、設定をカスタマイズします。

注記:

インプレースコネクターガイドに従っている場合は、次のセクションをスキップできます。

Alipay web app を設定する

Alipay 開発者アカウントの登録

Alipay 開発者アカウントを登録してください（まだお持ちでない場合）。

Alipay アプリの作成と設定

Alipay コンソールに、先ほど登録したアカウントでサインインします。
「マイアプリケーション」(我的应用) パネルの「Web & Mobile Apps」(网页&移动应用) タブに移動します。
「アプリを作成」(立即创建) ボタンをクリックして、アプリケーションの設定を開始します。
「アプリケーション名」(应用名称) に命名規則に従って名前を入力し、「アプリケーションアイコン」(应用图标) をアップロードします。「アプリタイプ」(应用类型) には必ず「Web アプリケーション」(网页应用) を選択してください。
アプリケーションの作成が完了したら、概要ページに移動します。ここで「機能を追加」(添加能力) をクリックし、「サードパーティアプリ認可」(第三方应用授权)、「会員情報の取得」(获取会员信息)、「App Alipay ログイン」(App 支付宝登录) を追加してから、Alipay サインインを有効にします。
Alipay カスタマーセンターにアクセスし、Alipay 開発者アカウントでサインインします。トップバーの「アカウントセンター」(账号中心) をクリックし、サイドバー下部にある「APPID バインディング」(APPID 绑定) に進みます。手順 4 で作成した Web アプリケーションの APPID を入力して「バインディングを追加」(添加绑定) します。
「App Alipay ログイン」の「署名」ボタンをクリックし、ガイドに従って署名プロセスを完了します。この手順が完了すると、手順 5 で追加した機能が有効になります。
Alipay オープンプラットフォームのコンソールページに戻り、「開発情報」(开发信息) セクションの「インターフェース署名方式（キー/証明書）」(接口加签方式（密钥/证书）) を見つけます。「設定」(设置) ボタンをクリックすると、署名方式の設定ページに移動します。「公開鍵」(公钥) が推奨される署名モードであり、生成した公開鍵ファイルの内容をテキスト入力欄に入力します。
Alipay コンソールページ下部の「設定」(设置) ボタンをクリックして「認可リダイレクト URI」(授权回调地址) を設定します。${your_logto_origin}/callback/${connector_id} は Logto コアで使用されるデフォルトのリダイレクト URI です。connector_id は Logto 管理コンソールのコネクター詳細ページのトップバーで確認できます。
すべての手順が完了したら、Alipay コンソールページ右上の「審査を提出」(提交审核) をクリックします。審査が承認されると、スムーズな Alipay サインインフローが利用可能になります。

注記:

ローカルマシンで openssl を使ってキーペアを生成するには、以下のコードスニペットをターミナルで実行してください。

openssl genrsa -out private.pem 2048
openssl rsa -in private.pem -outform PEM -pubout -out public.pem

Alipay アプリの設定サイトで公開鍵を入力する際は、public.pem のヘッダーとフッターを削除し、改行をすべて削除して、残りの内容を「公開鍵」入力欄に貼り付けてください。

Logto Alipay Web コネクター設定のセットアップ

Alipay コンソールワークスペースの「マイアプリケーション」(我的应用) パネルで「Web & Mobile Apps」(网页&移动应用) タブをクリックすると、すべてのアプリケーションの APPID を確認できます。
前述の手順 7 で、秘密鍵と公開鍵を含むキーペアをすでに生成しています。
Logto コネクター設定を入力します：
- appId フィールドには、手順 1 で取得した APPID を入力します。
- privateKey フィールドには、手順 2 で生成した秘密鍵ファイルの内容を入力します。必ずすべての改行を '\n' に置き換え、秘密鍵ファイルのヘッダーとフッターは削除しないでください。
- signType フィールドには、手順 7 の「Create And Configure Alipay Apps」で選択した「公開鍵」署名モードにより 'RSA2' を入力します。
- charset フィールドには 'gbk' または 'utf8' を入力します。このフィールドは省略可能で、デフォルト値は 'utf8' です。
- scope フィールドには 'auth_base' または 'auth_user' を入力します。このフィールドも省略可能で、デフォルト値は 'auth_user' です。異なる値の違いを確認できます。

設定タイプ

Name	Type	Enum values
appId	string	N/A
privateKey	string	N/A
signType	enum string	'RSA' / 'RSA2'
charset	enum string (OPTIONAL)	'gbk' / 'utf8' / undefined
scope	enum string (OPTIONAL)	'auth_user' / 'auth_base'

設定を保存する

Logto コネクター設定エリアで必要な値をすべて記入したことを確認してください。「保存して完了」または「変更を保存」をクリックすると、Alipay (Web) コネクターが利用可能になります。

ソーシャルコネクターを正常に作成したら、サインイン体験で「Alipay (Web) で続行」ボタンとして有効にすることができます。

Console > サインイン体験 > サインアップとサインインに移動します。
（オプション）ソーシャルログインのみが必要な場合は、サインアップ識別子に「該当なし」を選択します。
設定済みの Alipay (Web) コネクターを「ソーシャルサインイン」セクションに追加します。

テストと検証

Capacitor JS アプリに戻ります。これで Alipay (Web) を使用してサインインできるはずです。お楽しみください！

さらなる読み物

エンドユーザーフロー：Logto は、MFA やエンタープライズシングルサインオン (SSO) を含む即時使用可能な認証 (Authentication) フローを提供し、アカウント設定、セキュリティ検証、マルチテナント体験の柔軟な実装のための強力な API を備えています。

認可 (Authorization)：認可 (Authorization) は、ユーザーが認証 (Authentication) された後に行えるアクションやアクセスできるリソースを定義します。ネイティブおよびシングルページアプリケーションの API を保護し、ロールベースのアクセス制御 (RBAC) を実装する方法を探ります。

組織 (Organizations)：特にマルチテナント SaaS や B2B アプリで効果的な組織機能は、テナントの作成、メンバー管理、組織レベルの RBAC、およびジャストインタイムプロビジョニングを可能にします。

顧客 IAM シリーズ：顧客（または消費者）アイデンティティとアクセス管理に関する連続ブログ投稿で、101 から高度なトピックまでを網羅しています。

Logto でアプリケーションを作成する​

Capacitor JS SDK を統合する​

インストール​

Logto クライアントの初期化​

サインインの実装​

リダイレクトベースのサインインについて​

サインアウトの実装​

チェックポイント: 認証 (Authentication) フローをトリガーする​

Alipay (Web) コネクターを追加する​

Alipay web app を設定する​

Alipay 開発者アカウントの登録​

Alipay アプリの作成と設定​

Logto Alipay Web コネクター設定のセットアップ​

設定タイプ​

設定を保存する​

サインイン体験で Alipay (Web) コネクターを有効にする​

テストと検証​

さらなる読み物​