このトピックでは、サーバー側 API のみを使用して FaceCompare を統合する方法について説明します。
API
API オペレーション： FaceCompare
リクエストメソッド： HTTPS POST
説明： サーバー側の API 呼び出しで送信されたイメージデータやその他の情報を使用して顔を照合します。
この API オペレーションには専用の QPS 制限があります。 詳細については、「ID Verification サーバー側 API オペレーションの QPS 制限」をご参照ください。
エンドポイント：
説明内部ネットワークアクセスのメリット： 内部ネットワークは、同一リージョン内の Alibaba Cloud プロダクト間のプライベートな通信ネットワークです。 ご利用のビジネスサーバーが対応する 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
オンラインでのデバッグと統合
API オペレーションをデバッグおよび統合する前に、「OpenAPI Explorer を使用したサーバー側 API オペレーションのデバッグと統合」をご参照ください。OpenAPI Explorer で API オペレーションを呼び出し、SDK とサンプルコードを取得する方法について説明しています。
OpenAPI Explorer を使用してこの API を直接実行およびデバッグし、この API の SDK コードサンプルを生成できます。
入力イメージのフォーマット要件
イメージフォーマット： JPG、JPEG、または PNG。
イメージサイズ： 50 KB～100 KB を推奨します。 最大サイズは 1 MB です。
イメージ解像度： 解像度は 640 × 480 ピクセル (高さ × 幅) から 1920 × 1080 ピクセルの間である必要があります。 短辺を 720 ピクセルにスケーリングし、圧縮率を 0.9 以上にすることを推奨します。 イメージの高さは幅よりも大きくする必要があります。 幅が高さより大きい場合、検出精度が低下する可能性があります。
説明イメージを Base64 フォーマットに変換すると、データサイズが増加します。 Base64 フォーマットでパラメーターを渡すには、1 MB のデータ転送制限を超えないように、元のイメージサイズが 0.6 MB を超えないようにしてください。
推奨されるイメージ品質：
イメージ内の顔は、完全で、鮮明で、遮られていない必要があります。 被写体はカメラにまっすぐ向いている必要があります。 前面カメラで撮影した顔イメージを使用することを推奨します。
顔はイメージ領域の 60% 以上を占めるようにしてください。 顔が小さいと、検出精度が低下する可能性があります。
イメージに複数の顔がある場合、アルゴリズムはデフォルトで最大の顔を切り取ります。 複数の顔があるイメージは避けることを推奨します。
リクエストパラメーター
パラメーター | タイプ | 必須 | 説明 | 例 |
MerchantBizId | String | はい | トラブルシューティング用の一意のビジネス ID。最大 32 文字の英数字を含みます。 この ID はリクエストごとに一意である必要があります。 | e0c34a77f5ac40a5aa5e6ed20c35**** |
SourceFacePicture | String | はい | ソース顔イメージの Base64 エンコードされた文字列。 説明 このパラメーターを使用する場合は、イメージサイズが指定された制限を超えないようにしてください。 | base64 string |
SourceFacePictureUrl | String | いいえ | ソース顔イメージの URL。 URL は、パブリックにアクセス可能な HTTP または HTTPS の URL である必要があります。 説明 SourceFacePicture または SourceFacePictureUrl のいずれかを指定する必要があります。 | https://*** |
TargetFacePicture | String | いいえ | ターゲット顔イメージの Base64 エンコードされた文字列。 説明 このパラメーターを使用する場合は、イメージサイズが指定された制限を超えないようにしてください。 | base64 string |
TargetFacePictureUrl | String | いいえ | ターゲット顔イメージの URL。 URL は、パブリックにアクセス可能な HTTP または HTTPS の URL である必要があります。 説明 TargetFacePicture または TargetFacePictureUrl のいずれかを指定する必要があります。 | https://*** |
レスポンスパラメーター
パラメーター | タイプ | 説明 | 例 | |
HTTP ステータスコード | Integer | HTTP ステータスコード。 | 200 | |
HTTP ボディ | RequestId | String | リクエスト ID。 | 130A2C10-B9EE-4D84-88E3-5384FF0**** |
Code | String | Success | ||
Message | String | レスポンスコードの詳細な説明。 | success | |
Result.TransactionId | String | 認証リクエストの一意の ID。 | 08573be80f944d95ac812e019e36**** | |
Result.Passed | String | 最終的な認証結果。 有効な値：
| Y | |
Result.FaceComparisonScore | String | 顔照合スコア。 値の範囲は 0～100 です。 | 52.57 | |
レスポンスコード
HTTP ステータスコード | コード | 説明 |
200 | Success | リクエストは成功しました。 |
400 | MissingParameter | 必須パラメーターがありません。 |
400 | InvalidParameter | 無効なパラメーターが指定されました。 |
401 | NoFaceDetected | ソースイメージから顔の特徴を抽出できませんでした。 別のイメージを使用してください。 |
401 | UnqualifiedPhoto | イメージが読み取り不可であるか、解像度の要件を満たしていません。 鮮明で、適切に露光され、完全で、遮られていない、頭の傾きが著しくないイメージを使用してください。 |
401 | ToolargeImage | イメージが大きすぎます。 イメージを圧縮するか、URL を使用して提供してください。 |
401 | DataDuplication | 同じイメージに対して Base64 文字列と URL の両方が提供されました。 イメージのコンテンツまたはその URL のいずれかを提供してください。両方を提供することはできません。 |
401 | DownloadTimeout | URL からのイメージのダウンロードがタイムアウトしました。 |
403 | Forbidden.RAMUserAccessDenied | RAM ユーザーにはこの操作を実行する権限がありません。 AliyunAntCloudAuthFullAccess 権限を RAM ユーザーに付与する必要があります。 詳細については、「RAM ユーザーへのサービスへのアクセス権限の付与」をご参照ください。 |
403 | Forbidden.AccountAccessDenied | ID Verification を有効にし、アカウントに支払い遅延がないことを確認してください。 |
403 | Throttling.Api | API 呼び出しはスロットリングにより拒否されました。 |
500 | InternalError | 内部エラーが発生しました。 テクニカルサポートに連絡して支援を求めてください。 |