この Topic では、サーバーサイド API のみを使用して FaceCompare 機能を統合する方法について説明します。
API の説明
API 操作: FaceCompare
リクエストメソッド: HTTPS POST
説明: この API 操作は、サーバーサイド API 呼び出しで渡されるイメージデータやその他の情報を使用して顔照合を実行します。
QPS 制限: この API は、排他的なクエリ/秒 (QPS) 制限の対象となります。詳細については、「ID Verification サーバーサイド API の QPS 制限」をご参照ください。
エンドポイント:
説明内部ネットワークは、同じリージョン内の Alibaba Cloud プロダクト間のプライベート通信ネットワークです。アプリケーションサーバーが Alibaba Cloud リージョンにデプロイされている場合、内部エンドポイントを使用して ID Verification サービスにアクセスできます。これにより、より安全で安定したネットワーク接続が提供されます。
中国 (香港)
パブリックエンドポイント:
cloudauth-intl.cn-hongkong.aliyuncs.com同一リージョン内の内部エンドポイント:
cloudauth-intl-vpc.cn-hongkong.aliyuncs.com
インドネシア
パブリックエンドポイント:
cloudauth-intl.ap-southeast-5.aliyuncs.com同一リージョン内の内部エンドポイント:
cloudauth-intl-vpc.ap-southeast-5.aliyuncs.com
オンラインでのデバッグと統合
デバッグと統合を行う前に、「OpenAPI Explorer を使用してサーバーサイド API 操作をデバッグおよび統合する」ドキュメントをお読みください。このドキュメントでは、OpenAPI プラットフォームで API 操作を呼び出す方法と、SDK およびそのサンプルコードを取得する方法について説明します。
OpenAPI Explorer を使用してこの API 操作をデバッグし、SDK コード例を生成できます。
イメージフォーマットの要件
イメージフォーマット: JPG、JPEG、または PNG。
イメージサイズ: 推奨 50 KB～100 KB、最大 1 MB。
イメージの解像度: 解像度は 640 × 480 ピクセル (高さ × 幅) から 1920 × 1080 ピクセルの間である必要があります。短辺を 720 ピクセルにスケーリングし、圧縮率を 0.9 より大きくすることをお勧めします。写真の高さは幅よりも大きい必要があります。幅が高さより大きいイメージは、検出結果に影響を与える可能性があります。
説明パラメーターを base64 フォーマットで渡す場合、1 MB のデータ転送制限内に収まるように、元のイメージサイズが 0.6 MB を超えないようにしてください。
イメージ品質の推奨事項:
顔は完全で、鮮明で、遮られていない必要があります。被写体はカメラにまっすぐ向いている必要があります。前面カメラで撮影したイメージを使用することをお勧めします。
顔がイメージ領域の 60% 以上を占めるようにしてください。顔が小さいと検出精度が低下します。
イメージに複数の顔が含まれている場合、アルゴリズムはデフォルトで最大の顔をトリミングします。複数の顔があるイメージの使用は避けることをお勧めします。
リクエストパラメーター
名前 | タイプ | 必須 | 説明 | 例 |
MerchantBizId | String | はい | トラブルシューティングに使用されるカスタムの一意のビジネス ID。最大 32 文字の英数字の組み合わせにすることができます。ID が一意であることを確認してください。 | e0c34a77f5ac40a5aa5e6ed20c35**** |
SourceFacePicture | String | はい | ポートレート写真の Base64 エンコーディング。 説明 このメソッドを使用してイメージを渡す場合は、イメージサイズを確認してください。大きすぎるイメージは渡さないでください。 | Base64 エンコーディング |
SourceFacePictureUrl | String | いいえ | ポートレート写真の URL。URL は、インターネット経由でアクセス可能な HTTP または HTTPS リンクである必要があります。 説明 SourceFacePicture または SourceFacePictureUrl のいずれかを指定する必要があります。 | https://*** |
TargetFacePicture | String | いいえ | ベース写真の Base64 エンコーディング。 説明 このメソッドを使用してイメージを渡す場合は、イメージサイズを確認してください。大きすぎるイメージは渡さないでください。 | Base64 エンコーディング |
TargetFacePictureUrl | String | いいえ | ベースのポートレート写真の URL。URL は、インターネット経由でアクセス可能な HTTP または HTTPS リンクである必要があります。 説明 TargetFacePicture または TargetFacePictureUrl のいずれかを指定する必要があります。 | https://*** |
応答パラメーター
名前 | タイプ | 説明 | 例 | |
HTTP ステータスコード | Integer | HTTP ステータスコード。 | 200 | |
HTTP Body | 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 | イメージが大きすぎます。イメージを圧縮するか、別のアップロードメソッドを使用してください。 |
401 | DataDuplication | SourceFacePicture と SourceFacePictureUrl の両方、または TargetFacePicture と TargetFacePictureUrl の両方を渡しました。 |
401 | DownloadTimeout | URL からのイメージのダウンロードがタイムアウトしました。 |
403 | Forbidden.RAMUserAccessDenied | Resource Access Management (RAM) ユーザーに AliyunAntCloudAuthFullAccess 権限を付与します。詳細については、「RAM ユーザーにサービスへのアクセス権限を付与する」をご参照ください。 |
403 | Forbidden.AccountAccessDenied | ID Verification を有効にし、アカウントに支払い遅延がないことを確認してください。 |
403 | Throttling.Api | API 呼び出しがスロットリングによってブロックされています。 |
500 | InternalError | 内部システムエラーが発生しました。テクニカルサポートにお問い合わせください。 |