ID Verification は、さまざまなソリューション向けに多様な統合モードを提供しています。このトピックでは、各統合モードのワークフローについて説明します。
統合モード
Alibaba Cloud は、以下の 4 つの統合モードを提供しています。ユースケースに最も適したモードを選択してください。
ネイティブ App SDK モード
クライアントサイド SDK と、それに付随するサーバーサイド API を提供します。このモードでは、SDK をネイティブアプリに統合し、エンドユーザーが Alibaba Cloud サービスを直接呼び出せるようになります。SDK のダウンロードリンクについては、「クライアントサイド SDK リリースノート」をご参照ください。
Web SDK モード
Web アプリケーション統合向けに、Web SDK とそれに付随するサーバーサイド API を提供します。エンドユーザーは、モバイルまたはデスクトップのブラウザを通じてサービスにアクセスできます。ブラウザ環境の違いにより、現在 PC からのアクセスは特定のソリューションでのみサポートされています。詳細については、各ソリューションの統合ガイドをご参照ください。
WebView 埋め込み App モード
ネイティブアプリに埋め込みブラウザ (WebView) 経由で統合するための Web SDK とそれに付随するサーバーサイド API を提供します。モバイル H5 SDK の互換性を確保するには、アプリ内の WebView に対して、カメラへのアクセスやビデオの自動再生などの必要な権限を設定する必要があります。
サーバーサイドのみ (API) モード
アプリケーションサーバーから関連サービスを直接呼び出すためのサーバーサイド API を提供します。このモードは、クライアントサイドのインタラクションを必要としないバックエンド統合シナリオに適しています。
SDK の統合手順
サービスの有効化：開始する前に、ID Verification サービスが有効化されていることを確認してください。詳細については、「ID Verification の有効化」をご参照ください。
開始：製品ソリューションを選択した後、対応する開発ガイドのドキュメントを参照して、サービス登録を完了してください。
サーバーサイド初期化：サーバーサイド初期化 API の
Initializeを呼び出して、TransactionId(ID Verification サービスの一意の ID であり、認証リクエスト内の API をリンクするために使用されます) を取得します。説明Web SDK の統合シナリオでは、このステップでクライアントサイドからアクセスするための認証 URL も返されます。
クライアントサイド統合：SDK をクライアントアプリケーションに統合します。
認証結果の取得：サーバーサイドクエリ API の
CheckResultを呼び出して、対応する認証ステータスと認証情報を取得します。
App 統合シーケンス図
App 統合のワークフローには、以下の 4 つのフェーズがあります。
MetaInfo の取得：クライアントサイド SDK がデバイスの環境情報を収集します。
サーバーサイド初期化：アプリケーションサーバーが API を呼び出して TransactionId を取得します。
クライアントサイド認証：SDK が TransactionId を使用してユーザー認証を実行します。
結果の検証：アプリケーションサーバーが最終的な認証結果を取得します。
MetaInfo は、ビジネス側で渡す固定値に対応しているため、フェーズ 1 はオプションのステップです。クライアント SDK を統合して MetaInfo を取得する必要がない場合は、フェーズ 1 をスキップして直接フェーズ 2 に進むことができます。
フェーズ 1 を統合することを推奨します。SDK を通じて動的に取得される MetaInfo には、より正確なデバイス環境情報が含まれています。これにより、サーバーは適合する認証 URL を提供し、トラブルシューティング中に完全なクライアントコンテキストを提供することで、問題解決の効率を向上させます。
ステップ | インタラクション | 説明 |
1 | エンドユーザー → マーチャントアプリ | エンドユーザーがマーチャントアプリからビジネスフローを開始します。 |
2 | マーチャントアプリ → 認証 SDK | マーチャントアプリが SDK API を呼び出して、デバイス環境情報 (MetaInfo) を取得します。 |
3 | 認証 SDK → マーチャントアプリ | SDK が MetaInfo 文字列を返します。 |
4 | マーチャントアプリ → アプリケーションサーバー | マーチャントアプリが MetaInfo を含む認証リクエストをアプリケーションサーバーに送信します。 |
5 | アプリケーションサーバー → Alibaba Cloud | アプリケーションサーバーが Initialize API を呼び出し、MetaInfo を渡します。 |
6 | Alibaba Cloud → アプリケーションサーバー | Alibaba Cloud は、この認証フローの一意の ID である TransactionId を返します。 |
7 | アプリケーションサーバー → マーチャントアプリ | アプリケーションサーバーが TransactionId をマーチャントアプリに送信します。 |
8 | マーチャントアプリ → 認証 SDK | マーチャントアプリが TransactionId を使用して SDK 認証フローを開始します。 |
9 | 認証 SDK → Alibaba Cloud | SDK がユーザーの認証資料 (顔画像や ID ドキュメントなど) を収集し、Alibaba Cloud サーバーにアップロードします。 |
10 | Alibaba Cloud → 認証 SDK | Alibaba Cloud サーバーが認証を完了し、結果を返します。 |
11 | 認証 SDK → マーチャントアプリ | SDK がコールバックを使用して、マーチャントアプリに認証ステータスを通知します。 |
12 | マーチャントアプリ → アプリケーションサーバー | マーチャントアプリが最終的な認証結果をアプリケーションサーバーに要求します。 |
13 | アプリケーションサーバー → Alibaba Cloud | アプリケーションサーバーが CheckResult API を呼び出して、Alibaba Cloud サーバーに結果をクエリします。 |
14 | Alibaba Cloud → アプリケーションサーバー | Alibaba Cloud が完全な認証結果と認証資料を返します。 |
15 | アプリケーションサーバー → マーチャントアプリ | アプリケーションサーバーが認証情報を処理し、非機密データをマーチャントアプリに返します。 |
16 | マーチャントアプリ → エンドユーザー | マーチャントアプリがエンドユーザーに認証フローの完了を通知します。 |
API の説明
API | 呼び出しタイミング | 説明 |
Initialize | サーバーサイド初期化フェーズ | 認証フローの一意の ID である TransactionId を返します。 |
CheckResult | 認証完了フェーズ | 最終的な認証ステータスと認証資料を返します。 |
Web/H5 統合シーケンス図
H5 統合は PC およびモバイルブラウザをサポートしています。主な違いは、初期化時に認証ページへのリンクである TransactionUrl が返される点です。これにより、ページリダイレクトまたは iframe 埋め込みの 2 つの統合方法がサポートされます。
Web/H5 統合フローには、主に 4 つの段階があります。
MetaInfo の取得：Web SDK がマーチャントの H5 ページからエンドユーザーのデバイス環境コンテキストを収集します。
サーバーサイド初期化：アプリケーションサーバーが Alibaba Cloud の初期化 API を呼び出し、この認証を識別する
TransactionIdと、フロントエンドのリダイレクトまたは埋め込み用の認証ページリンク (TransactionUrl) を取得します。クライアントサイド認証：マーチャントの H5 ページがページリダイレクトまたは iframe を使用して認証リンクを読み込み、ユーザーを認証フローに誘導します。
結果の検証：アプリケーションサーバーが結果クエリ API を呼び出して、最終的な認証ステータスと資料を取得します。
MetaInfo は、ビジネス側で渡す固定値に対応しているため、フェーズ 1 はオプションのステップです。クライアント SDK を統合して MetaInfo を取得する必要がない場合は、フェーズ 1 をスキップして直接フェーズ 2 に進むことができます。
フェーズ 1 を統合することを推奨します。SDK を通じて動的に取得される MetaInfo には、より正確なデバイス環境情報が含まれています。これにより、サーバーは適合する認証 URL を提供し、トラブルシューティング中に完全なクライアントコンテキストを提供することで、問題解決の効率を向上させます。
ステップ | インタラクション | 説明 |
1 | エンドユーザー → マーチャント H5 ページ | エンドユーザーが PC またはモバイルの H5 ページから認証フローを開始します。 |
2 | マーチャント H5 ページ → 認証 SDK | マーチャント H5 ページが Web SDK を呼び出して、デバイス環境情報 (MetaInfo) を取得します。 |
3 | 認証 SDK → マーチャント H5 ページ | SDK が MetaInfo 文字列を返します。 |
4 | マーチャント H5 ページ → アプリケーションサーバー | マーチャント H5 ページが MetaInfo をアプリケーションサーバーに送信します。 |
5 | アプリケーションサーバー → Alibaba Cloud | アプリケーションサーバーが Initialize API を呼び出し、MetaInfo を渡します。 |
6 | Alibaba Cloud → アプリケーションサーバー | Alibaba Cloud は、TransactionId (認証フローの一意の ID) と TransactionUrl を返します。iframe 埋め込みを使用する場合、Protocol も返されます。 |
7 | アプリケーションサーバー → マーチャント H5 ページ | アプリケーションサーバーが TransactionId と TransactionUrl をマーチャント H5 ページに送信します。 |
8 | マーチャント H5 ページ → 認証 SDK | マーチャント H5 ページが TransactionId を使用して SDK 認証フローを開始します (ページリダイレクトまたは iframe 埋め込みをサポート)。 |
9 | 認証 SDK → Alibaba Cloud | SDK がユーザーの認証資料を収集してアップロードします。 |
10 | Alibaba Cloud → 認証 SDK | Alibaba Cloud が認証を完了し、結果を返します。 |
11 | 認証 SDK → マーチャント H5 ページ | SDK がコールバックを使用して、マーチャント H5 ページに認証ステータスを通知します。 |
12 | マーチャント H5 ページ → アプリケーションサーバー | マーチャント H5 ページが最終的な認証結果をアプリケーションサーバーに要求します。 |
13 | アプリケーションサーバー → Alibaba Cloud | アプリケーションサーバーが CheckResult API を呼び出して認証結果をクエリします。 |
14 | Alibaba Cloud → アプリケーションサーバー | Alibaba Cloud が完全な認証結果と認証資料を返します。 |
15 | アプリケーションサーバー → マーチャント H5 ページ | アプリケーションサーバーが認証情報を処理し、非機密データをマーチャント H5 ページに返します。 |
API の説明
API | 呼び出しタイミング | 説明 |
Initialize | サーバーサイド初期化フェーズ |
|
CheckResult | 認証完了フェーズ | 最終的な認証ステータスと認証資料を返します。 |
App 統合と Web 統合の比較
項目 | App 統合 | Web 統合 |
初期化の戻り値 |
|
|
SDK 統合方法 | ネイティブ SDK (iOS/Android) | Web SDK (JS) |
認証ページのホスト | ネイティブアプリのページ | PC/モバイル H5 Web ページ |
ページ表示方法 | SDK 内でレンダリング | ページリダイレクトまたは iframe 埋め込み |
コアサーバーサイド API |
|
|
API のみの統合
ID Verification サービスを有効化してください。詳細については、「ID Verification の有効化」をご参照ください。
関連製品の API ドキュメントに従ってソリューションを統合してください。サーバーサイドのみのモードでは、以下のソリューションをサポートしています。
FACE_IDU_MIN：生体認証
FACE_COMPARE：顔照合
ID_OCR_MAX：ID ドキュメント OCR
API の基本
リクエストメソッド： HTTPS POST
QPS 制限：各 API には専用の QPS 制限があります。詳細は、「ID Verification サーバー側 API の QPS 制限」をご参照ください。
サービスエンドポイント：
説明内部ネットワークアクセスのメリット：内部ネットワークは、同一リージョン内の Alibaba Cloud 製品間のプライベートな通信ネットワークです。アプリケーションサーバーが同一リージョンにデプロイされている場合、内部ネットワークエンドポイントを使用して ID Verification サービスにアクセスしてください。これにより、より安全で安定した接続が実現します。
シンガポール
パブリックエンドポイント：
cloudauth-intl.ap-southeast-1.aliyuncs.com内部エンドポイント：
cloudauth-intl-vpc.ap-southeast-1.aliyuncs.com
インドネシア (ジャカルタ)
パブリックエンドポイント：
cloudauth-intl.ap-southeast-5.aliyuncs.com内部エンドポイント：
cloudauth-intl-vpc.ap-southeast-5.aliyuncs.com
中国 (香港)
パブリックエンドポイント：
cloudauth-intl.cn-hongkong.aliyuncs.com内部エンドポイント：
cloudauth-intl-vpc.cn-hongkong.aliyuncs.com
マレーシア (クアラルンプール)
パブリックエンドポイント：
cloudauth-intl.ap-southeast-3.aliyuncs.com内部エンドポイント：
cloudauth-intl-vpc.ap-southeast-3.aliyuncs.com
オンラインデバッグと統合
デバッグまたは統合を行う前に、「OpenAPI を使用したサーバー側 API のデバッグと統合」ガイドを読み、OpenAPI プラットフォームでの API の呼び出し方法と SDK の取得方法を理解してください。
OpenAPI Explorer で API を直接実行およびデバッグし、SDK サンプルコードを生成できます。