Alibaba Cloud OpenAPI ポータルで ID Verification サーバー側 API をデバッグし、統合用の SDK サンプルコードを取得します。
前提条件
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
マレーシア (クアラルンプール)
パブリックエンドポイント：
cloudauth-intl.ap-southeast-3.aliyuncs.com内部エンドポイント：
cloudauth-intl-vpc.ap-southeast-3.aliyuncs.com
統合方法
Alibaba Cloud は、ID Verification API をカプセル化した、主要なプログラミング言語向けの SDK を提供しています。SDK を使用すると、低レベルの詳細を処理することなく API を呼び出すことができます。
SDK が要件を満たさない場合は、署名付き HTTPS リクエストを手動で構築することができます。署名プロセスは複雑であるため、このアプローチが妥当であるか評価してください。
|
統合方法 |
説明 |
|
Alibaba Cloud SDK |
サポートされているプログラミング言語、SDK バージョン、インストール手順については、ID Verification SDK センターをご参照ください。 |
オンラインデバッグとサンプルコード
API ドキュメントの [Debugging] セクションから [Response] または [SDK Sample Code] ページにアクセスします。
|
手順 |
説明 |
|
1 |
ID Verification OpenAPI ポータルにアクセスし、Alibaba Cloud アカウントにサインインします。 |
|
2 |
対象の API を選択または検索します。API ドキュメントから移動した場合は、対応する API ページが自動的に開きます。 |
|
3 |
エンドポイントを選択します。右側のコードサンプルが連動して更新されます。 説明
エンドポイントは API サービスによって異なります。正しいエンドポイントについては、API ドキュメントをご確認ください。 |
|
4 |
デバッグパラメータを入力します。入力したパラメータは右側のコードサンプルに反映されます。API をオンラインで呼び出すには、右下の [Initiate Call] をクリックします。結果は [Call Result] ページに表示されます。 説明
有料 API の呼び出しには料金がかかる場合があります。 |
|
5 |
右側パネルの上部で、[SDK Sample Code] をクリックします。 |
|
6 |
SDK バージョンとプログラミング言語を選択します。 説明
セキュリティと効率性の向上のため、SDK V2.0 の使用を推奨します。 |
|
7 |
設定を変更すると、コードサンプルがリアルタイムで更新されます。コードエリアの左上で次の操作が可能です。
コードエリアの右上で次の操作が可能です。
|
Alibaba Cloud SDK が提供するクライアントインスタンスを複数のリクエストで再利用してください。リクエストごとに新しいクライアントインスタンスを作成すると、パフォーマンスが低下する可能性があります。
アクセス認証情報
ID Verification API の呼び出しには、認証用の有効なアクセス認証情報が必要です。一般的な認証情報の種類には次のものがあります。
-
AccessKey： AccessKey (AK) は、Alibaba Cloud アカウントおよび RAM ユーザーに発行される、AccessKey ID と AccessKey シークレットで構成される永続的な認証情報です。詳細については、「AccessKey の作成」をご参照ください。
-
Security Token Service (STS) トークン： Security Token Service (STS) トークンは、有効期限と権限を設定可能な、RAM ロールに発行される一時的な認証情報です。詳細については、「Security Token Service (STS) とは」をご参照ください。
RAM ユーザーまたは RAM ロールを使用して ID Verification API を呼び出す場合は、RAM ユーザーまたは RAM ロールの作成後、システム管理者に連絡してポリシー AliyunAntCloudAuthFullAccess を付与してください。
認証情報の漏洩はセキュリティリスクにつながります。アクセス認証情報を保護するには、次のソリューションを使用してください。
|
認証情報のタイプ |
ソリューション |
適用シナリオ |
|
AccessKey |
認証情報をシステム環境変数に保存して、Alibaba Cloud OpenAPI 呼び出し用の認証情報を設定します。 |
|
|
STS トークン |
Alibaba Cloud Container Service for Kubernetes (ACK) クラスター上のアプリケーションの場合、サービスアカウント用の RAM ロール (RRSA) を使用して、アプリケーションごとに独立した RAM ロールを割り当てます。 |
「アクセス認証情報を使用して Alibaba Cloud OpenAPI にアクセスするためのベストプラクティス」に従ってください。
エラーと解決策
一般的な統合の問題をトラブルシューティングします。
|
SDK 言語 |
例外のキャッチ方法 |
一般的な問題と解決策 |
|
Java |
||
|
Python |
||
|
PHP |
||
|
TypeScript |
||
|
.NET |
||
|
Go |
SDK 統合 FAQ
サンプルコードのリファレンス
「オンラインデバッグとサンプルコード」セクションの手順に従って、OpenAPI ポータルからサンプルコードを取得してください。さらに、ご参考までに、すぐに実行できるサンプルコードの例を限定的に提供しています。「IDV サーバー側サンプルコード」をご参照ください。
API 呼び出しの高レイテンシーへの対処
サーバー側 API の呼び出し時に高レイテンシーが発生する場合は、「サーバー側ネットワークレイテンシーの分析と最適化」を参照して、トラブルシューティングと最適化のガイダンスをご確認ください。
HTTPS リクエストの手動構築
HTTPS リクエストを手動で構築するには、「リクエスト構造と署名メカニズム」をご参照ください。