ID Verification は複数の統合モードを提供します。各モードは、ユースケースに応じて異なるワークフローをサポートします。
統合モード
Alibaba Cloud は次の 4 つの統合モードを提供します。ユースケースに最適なモードを選択してください：
ネイティブアプリ SDK モード
クライアントサイド SDK と、それに付随するサーバーサイド API を提供します。ネイティブアプリに SDK を統合することで、エンドユーザーは Alibaba Cloud のサービスに直接アクセスできます。SDK のダウンロードリンクについては、「Client-side SDK Release Notes」をご参照ください。
Web SDK モード
Web アプリケーション統合向けに、Web SDK とそれに付随するサーバーサイド API を提供します。エンドユーザーはモバイルまたはデスクトップのブラウザからサービスにアクセスします。ブラウザ環境の違いにより、現在 PC からのアクセスは特定のソリューションでのみサポートされています。詳細については、各ソリューションの統合ガイドをご参照ください。
WebView 埋め込みアプリモード
埋め込みブラウザ (WebView) を介してネイティブアプリに統合するために、Web SDK とそれに付随するサーバーサイド API を提供します。モバイル H5 SDK の互換性を確保するために、カメラアクセスや動画の自動再生など、アプリ内の WebView に必要な権限を設定してください。
サーバーサイドのみ (API) モード
アプリケーションサーバーからサービスを直接呼び出すためのサーバーサイド API を提供します。クライアントサイドの操作を必要としないバックエンド統合シナリオに適しています。
SDK 統合手順
サービスの有効化：開始する前に、ID Verification サービスが有効化されていることを確認してください。詳細については、「Activate ID Verification」をご参照ください。
はじめに：製品ソリューションを選択した後、対応する Development Guide のドキュメントを参照して、サービス登録を完了してください。
サーバーサイドの初期化：サーバーサイドの初期化 API
Initializeを呼び出して、TransactionId(ID Verification サービスの一意の ID であり、認証フローにおける API 呼び出しを関連付けるために使用されます) を取得します。説明Web SDK 統合では、このステップでクライアントサイドからアクセスするための認証 URL も返されます。
クライアントサイド統合：クライアントアプリケーションに SDK を統合します。
認証結果の取得：サーバーサイドのクエリ API
CheckResultを呼び出して、対応する認証ステータスと認証情報を取得します。
アプリ統合のシーケンス図
アプリ統合のワークフローは、次の 4 つのフェーズで構成されます：
MetaInfo の取得：クライアントサイド SDK がデバイス環境情報を収集します。
サーバーサイドの初期化：アプリケーションサーバーが API を呼び出して TransactionId を取得します。
クライアントサイド認証：SDK が TransactionId を使用してユーザー認証を実行します。
結果検証：アプリケーションサーバーが最終的な認証結果を取得します。
MetaInfo は、ビジネス側で渡す固定値をサポートするため、フェーズ 1 は任意です。MetaInfo を取得するためにクライアント SDK を統合する必要がない場合は、フェーズ 1 をスキップしてフェーズ 2 に進めます。
フェーズ 1 の統合を推奨します。SDK により動的に取得した MetaInfo には、より正確なデバイス環境情報が含まれます。これにより、サーバーは一致する認証 URL を返しやすくなり、トラブルシューティング時に完全なクライアントコンテキストを提供できるため、問題解決の効率が向上します。
手順 | やり取り | 説明 |
1 | エンドユーザー → マーチャントアプリ | エンドユーザーがマーチャントアプリから業務フローを開始します。 |
2 | マーチャントアプリ → Verification SDK | マーチャントアプリが SDK API を呼び出して、デバイス環境情報 (MetaInfo) を取得します。 |
3 | Verification SDK → マーチャントアプリ | SDK が MetaInfo 文字列を返します。 |
4 | マーチャントアプリ → アプリケーションサーバー | マーチャントアプリが MetaInfo を含めて認証リクエストをアプリケーションサーバーに送信します。 |
5 | アプリケーションサーバー → Alibaba Cloud | アプリケーションサーバーが Initialize API を呼び出し、MetaInfo を渡します。 |
6 | Alibaba Cloud → アプリケーションサーバー | Alibaba Cloud が TransactionId を返します。これは、この認証フローの一意の ID です。 |
7 | アプリケーションサーバー → マーチャントアプリ | アプリケーションサーバーが TransactionId をマーチャントアプリに送信します。 |
8 | マーチャントアプリ → Verification SDK | マーチャントアプリが TransactionId を使用して SDK の認証フローを開始します。 |
9 | Verification SDK → Alibaba Cloud | SDK がユーザーの認証資料 (顔画像や本人確認書類など) を収集し、Alibaba Cloud サーバーにアップロードします。 |
10 | Alibaba Cloud → Verification SDK | Alibaba Cloud サーバーが認証を完了し、結果を返します。 |
11 | Verification 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 は任意です。MetaInfo を取得するためにクライアント SDK を統合する必要がない場合は、フェーズ 1 をスキップしてフェーズ 2 に進めます。
フェーズ 1 の統合を推奨します。SDK により動的に取得した MetaInfo には、より正確なデバイス環境情報が含まれます。これにより、サーバーは一致する認証 URL を返しやすくなり、トラブルシューティング時に完全なクライアントコンテキストを提供できるため、問題解決の効率が向上します。
手順 | やり取り | 説明 |
1 | エンドユーザー → マーチャント H5 ページ | エンドユーザーが PC またはモバイルの H5 ページから認証フローを開始します。 |
2 | マーチャント H5 ページ → Verification SDK | マーチャント H5 ページが Web SDK を呼び出して、デバイス環境情報 (MetaInfo) を取得します。 |
3 | Verification 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 ページ → Verification SDK | マーチャント H5 ページが TransactionUrl を使用して認証フローを開始します (ページリダイレクトまたは iframe の埋め込みをサポート)。 |
9 | Verification SDK → Alibaba Cloud | SDK がユーザーの認証資料を収集し、アップロードします。 |
10 | Alibaba Cloud → Verification SDK | Alibaba Cloud が認証を完了し、結果を返します。 |
11 | Verification SDK → マーチャント H5 ページ | SDK がコールバックを使用して、認証ステータスをマーチャント H5 ページに通知します。 |
12 | マーチャント H5 ページ → アプリケーションサーバー | マーチャント H5 ページが最終的な認証結果をアプリケーションサーバーに要求します。 |
13 | アプリケーションサーバー → Alibaba Cloud | アプリケーションサーバーが CheckResult API を呼び出して、認証結果を照会します。 |
14 | Alibaba Cloud → アプリケーションサーバー | Alibaba Cloud が完全な認証結果と認証資料を返します。 |
15 | アプリケーションサーバー → マーチャント H5 ページ | アプリケーションサーバーが認証情報を処理し、非機密データをマーチャント H5 ページに返します。 |
API の説明
API | 呼び出しのタイミング | 説明 |
Initialize | サーバーサイドの初期化フェーズ |
|
CheckResult | 認証完了フェーズ | 最終的な認証ステータスと認証資料を返します。 |
アプリ統合と Web 統合の比較
項目 | アプリ統合 | Web 統合 |
初期化の戻り値 |
|
|
SDK の統合方法 | ネイティブ SDK (iOS/Android) | Web SDK (JS) |
認証ページのホスト | ネイティブアプリページ | PC/モバイルの H5 Web ページ |
ページの表示方法 | SDK 内でレンダリング | ページリダイレクトまたは iframe の埋め込み |
主要なサーバーサイド API |
|
|
API のみの統合
ID Verification サービスを有効化します。詳細については、「Activate 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 製品間で使用されるプライベート通信ネットワークです。アプリケーションサーバーが同一リージョンにデプロイされている場合は、より安全で安定した接続のために内部エンドポイントを使用してください。
シンガポール
パブリックエンドポイント：
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 サンプルコードを生成できます。