ID Verification プロダクトの統合には、クライアント側とサーバー側のコンポーネントが含まれます。Alibaba Cloud OpenAPI プラットフォームを通じて、サーバー側 API をオンラインでデバッグし、統合サンプルコードを取得できます。この Topic では、[Alibaba Cloud OpenAPI プラットフォーム] を使用してサーバー側 API をオンラインでデバッグし、その統合用サンプルコードを取得するための詳細なステップを説明します。
前提条件
ID Verification の有効化 ドキュメントを読み、ID Verification サービスを有効化していること。
サーバーサイド API エンドポイント
API サービスによって、提供されるエンドポイントが異なる場合があります。正確な情報については、対応する API ドキュメントをご参照ください。
中国 (香港)
パブリックエンドポイント:
cloudauth-intl.cn-hongkong.aliyuncs.com同一リージョン内の内部エンドポイント:
cloudauth-intl-vpc.cn-hongkong.aliyuncs.com
シンガポール
パブリックエンドポイント:
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.eu-central-1.aliyuncs.com同一リージョン内の内部エンドポイント:
cloudauth-intl-vpc.eu-central-1.aliyuncs.com
米国西部 (シリコンバレー)
パブリックエンドポイント:
cloudauth-intl.us-west-1.aliyuncs.com同一リージョン内の内部エンドポイント:
cloudauth-intl-vpc.us-west-1.aliyuncs.com
統合メソッド
Alibaba Cloud は、一般的なプログラミング言語用の SDK を提供しています。これらの SDK を使用して API を直接呼び出すことをお勧めします。これにより、基盤となる技術的な詳細を管理する必要がなくなります。
既存の SDK が要件を満たせない場合は、自分で署名を構築し、ネイティブの HTTPS 呼び出しを使用できます。ただし、自己署名プロセスは非常に複雑であるため、かなりの追加作業が必要になります。ビジネスニーズに基づいてこのオプションを評価してください。
呼び出し方法 | 注意事項 |
Alibaba Cloud SDK | ID Verification SDK でサポートされている特定のプログラミング言語、SDK バージョン、およびインストール方法については、ID Verification SDK センター を参照してください。 |
オンラインデバッグとサンプルコード
API ドキュメントの [オンラインデバッグと統合] セクションから、対応する API の [呼び出し結果] ページまたは [SDK の例] ページに直接アクセスできます。
番号 | 手順の説明 |
1 | ID Verification OpenAPI ポータル にアクセスし、Alibaba Cloud アカウントにログインします。 |
2 | デバッグする API を選択または検索します。 API ドキュメントのエントリから入力すると、対応する API ページに移動します。 |
3 | 使用可能なエンドポイントを選択します。選択したエンドポイントは、右側のコードに表示されます。 説明 API サービスによって、提供されるエンドポイントが異なる場合があります。正確な情報については、対応する API ドキュメントをご参照ください。 |
4 | デバッグパラメータを入力します。 値を持つパラメータフィールドは、右側のコードに表示されます。 API をオンラインで呼び出して返されたデータを表示するには、パラメータ領域の右下隅にある [呼び出し開始] をクリックして、API をリアルタイムで呼び出します。右側のタブは自動的に [呼び出し結果] ページに切り替わります。 説明 有料 API の場合は料金が発生する場合があります。 |
5 | ページの右側の領域の上部にある [SDK の例] をクリックします。 |
6 | 必要に応じて、SDK バージョンとプログラミング言語を選択します。 説明 より安全で効率的な統合方法を提供する SDK バージョン |
7 | エンドポイント、API パラメータ、SDK バージョン、またはプログラミング言語を変更すると、コードはリアルタイムで変更されます。 コード領域の左上隅：
コード領域の右上隅：
|
コードでは、Alibaba Cloud SDK が提供する Client クラスを再利用してください。リクエストごとに新しいインスタンスを作成すると、パフォーマンスの問題が発生する可能性があるためです。
アクセス資格情報の取得
アクセス資格情報は、ID を検証するために使用されます。ローカルコードから ID Verification API を呼び出す場合、ID を認証するために正しいアクセス資格情報を提供する必要があります。以下は、一般的なアクセス資格情報の種類です:
AccessKey：AccessKey は、Alibaba Cloud が Alibaba Cloud アカウントと RAM ユーザーに提供する永続的なアクセス認証情報です。AccessKey ID と AccessKey シークレットで構成されます。詳細については、AccessKey の作成 をご参照ください。
STS トークン：セキュリティトークンサービス（STS）トークンは、Alibaba Cloud が RAM ロールに提供する一時的なアクセス認証情報です。有効期間とアクセス許可をカスタマイズできます。詳細については、STS とは をご参照ください。
RAM ユーザーまたは RAM ロールを使用して ID Verification API を呼び出す場合は、ユーザーまたはロールを作成した後、システム管理者に連絡して必要な権限を付与してください:
アクセス ポリシー名 | 注意事項 |
AliyunAntCloudAuthFullAccess | ID Verification-KYC サービスを呼び出す権限。 |
アクセス認証情報が漏洩した場合、ビジネスに重大なセキュリティリスクをもたらす可能性があります。アクセス認証情報を安全に構成および使用する方法については、次のソリューションをご参照ください。
認証情報タイプ | ソリューション名 | シナリオ |
AccessKey | システム環境変数を構成することにより、Alibaba Cloud OpenAPI にアクセスします。 | |
STS トークン | アプリケーションが Container Service for Kubernetes（ACK）クラスタにデプロイされている場合は、ACK クラスタの RAM Roles for Service Accounts（RRSA）機能を有効にできます。これにより、ACK クラスタにデプロイされている各アプリケーションは、異なる RAM ロールを偽装して Alibaba Cloud の API 操作を呼び出すことができます。 |
詳細については、アクセス認証情報を使用して Alibaba Cloud OpenAPI にアクセスするためのベストプラクティス をご参照ください。
例外とよくある質問
統合とデバッグ中に問題が発生した場合は、次の表をトラブルシューティングの参考にしてください。
SDK 言語 | 例外をキャッチする方法 | 一般的な問題と解決策 |
Java | ||
Python | ||
PHP | ||
TypeScript | ||
.NET | ||
Go |
SDK 統合: よくある質問とベストプラクティス
サンプルコードのリファレンス
オンラインデバッグとサンプルコード セクションを参照して、Alibaba Cloud OpenAPI ポータル からサンプル統合コードを取得してください。追加の実行可能なサンプルについては、「IDV サーバーサイドサンプルコード」をご参照ください。
サーバーサイド API の呼び出し時に高いレイテンシーが発生した場合の対処方法
ID Verification サーバーサイド API の呼び出し時に高いレイテンシが発生する場合は、次の方法をトラブルシューティングと最適化の参考にしてください：サーバーサイドのネットワークレイテンシの分析と最適化。
SDK がニーズを満たさない場合にカスタム HTTPS リクエストを作成する方法
既存の SDK がビジネスニーズを満たさず、カスタム HTTPS リクエストを作成したい場合は、「リクエストの構造と署名メカニズム」をご参照ください。