この API は、顔検索のために、指定された顔グループに顔画像を追加します。ID Verification コンソールで顔グループを作成し、顔画像を追加することもできます。
API 情報
API 名:AddFaceRecord
リクエストメソッド:POST
トランスポートプロトコル:HTTPS
この API の QPS 制限は、テナントあたり 50 です。
エンドポイント:
説明ID Verification のソリューションごとにサポートされるリージョンは異なり、データはリージョン間で分離されています。データにアクセスするには、データが保存されているリージョンの API ドメイン名を使用する必要があります。
シンガポール
パブリックエンドポイント:
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 コードの例を生成できます。
画像要件
画像形式:JPG または JPEG。
画像サイズ:50 KB~100 KB を推奨します。最大サイズは 10 MB です。1 MB を超える画像は、URL またはファイルストリームを使用してアップロードすることを推奨します。
画像解像度:解像度は 640x480 ピクセル (高さ x 幅) 以上、1920x1080 ピクセル (高さ x 幅) 以下を推奨します。画像の高さは幅より大きい必要があります。最適な結果を得るには、短い辺が 720 ピクセルになるように画像を調整し、圧縮率を 0.8 に設定することを推奨します。
画質:画像は鮮明で、適切な露出である必要があります。顔が暗すぎたり、明るすぎたり、ハレーションが発生したりしないようにしてください。
複数の顔:画像に複数の顔が含まれている場合、システムはデフォルトで最大の顔を検出して処理します。
リクエストパラメーター
顔画像をアップロードする際は、次のパラメーターのいずれか 1 つのみを使用して指定してください:FacePicture、FacePictureUrl、または FacePictureFileObject。
パラメーター | タイプ | 説明 | 必須 | 例 |
ProductCode | string | プロダクトコード。値を FACE_ENROLL に設定します。 | はい | FACE_ENROLL |
FaceGroupCode | string | 顔グループのコード。 | はい | sgl****7uc |
MerchantUserId | string | ユーザーのカスタム一意 ID。最大長は 32 文字です。
| いいえ | 130A2C10B9EE4D8488E35384FF03hst |
FacePicture | string | 顔画像の Base64 エンコード文字列。 | いいえ | base64 |
FacePictureUrl | string | 顔画像の URL。 | いいえ | https://example.com/test.jpg |
FacePictureFileObject | InputStream | 顔画像のローカルファイルストリーム。 このパラメーターを使用してファイルをアップロードするには、Advance API を呼び出し、有効な InputStream オブジェクトを渡す必要があります。詳細については、「特殊なシナリオ:ファイルアップロードのための Advance API の設定」をご参照ください。 | いいえ | 画像の InputStream オブジェクト |
FaceQualityCheck | string | 顔画像の画質をチェックするかどうかを指定します。
有効にすると、ぼやけている、またはオクルージョンがあるなどの低画質の画像をシステムが自動的に拒否し、顔グループに追加しません。拒否された画像に対しては、システムは 400 (UnqualifiedPhoto) エラーを返します。 | いいえ | Y |
レスポンスパラメーター
パラメーター | タイプ | 説明 | 例 | |
HTTP ステータスコード | integer | HTTP ステータスコード。 | 200 | |
HTTP ボディ | RequestId | string | リクエスト ID。 | 130A2C10-B9EE-4D84-88E3-5384FF03**** |
Code | string | リターンコード。詳細については、「サーバーサイド HTTP ステータスコード」をご参照ください。 | Success | |
Message | string | リターンコードの説明。 | The request was successful. | |
Result.Passed | string | 登録結果。
| Y | |
Result.ExtFaceInfo | Object | 顔画像分析結果が含まれます。JSON 形式については、例をご参照ください。 詳細については、「ExtFaceInfo」をご参照ください。 | | |
ExtFaceInfo
パラメーター | タイプ | 説明 | 例 |
FaceQualityScore | Double | 全体的な顔の画質スコア。値の範囲は 0~100 です。スコアが高いほど、画質が良いことを示します。 | 88.62 |
OcclusionScore | Double | オクルージョンの画質サブスコア。値の範囲は 0~100 です。スコアが高いほど、画質が良い (オクルージョンが少ない) ことを示します。 | 99.99 |
KaOcclusionScore | Double | 主要な顔領域のオクルージョンの画質サブスコア。値の範囲は 0~100 です。スコアが高いほど、画質が良いことを示します。 | 100 |
IlluminationScore | Double | 照明の画質サブスコア。値の範囲は 0~100 です。スコアが高いほど、画質が良いことを示します。 | 97.43 |
SharpnessScore | Double | 画像のシャープネスの画質サブスコア。値の範囲は 0~100 です。スコアが高いほど、画質が良いことを示します。 | 60.78 |
課金
この API は課金対象です。詳細については、「課金の概要」をご参照ください。
次の操作は課金されません:
コンソールでの顔画像の手動追加。
活性チェックフロー中の自動登録。