接入文档
人脸搜索(海外版)
API接入
向人脸库中添加人脸
向人脸库中添加人脸
# 描述
此接口提供向指定人脸库添加人脸的功能。
调用URL:
https://api-sgp.yljz.com/finauth/search/group/add
# 请求参数
| 是否必选 | 参数名 | 类型 | 参数说明 |
|---|---|---|---|
| 必选 | sign | String | 调用此API客户的签名,具体的签名产生方式请查阅”鉴权说明“文档。 |
| 必选 | sign_version | String | 签名算法版本,请传递:hmac_sha1 |
| 必填 | group_id | String | 用户提供的人脸库标识 |
| 必选二选一 | image |
String | 图片 base64 数据 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。 支持PNG、JPG、JPEG、BMP、jfif,不支持 GIF 图片 |
| file |
File | 图片的文件 支持PNG、JPG、JPEG、BMP、jfif,不支持 GIF 图片 |
|
| 必填 | user_id |
string | 用户 ID,支持英文、数字、-%@#&_,长度限制48B。(建议用手机号、身份证号) 示例值:user_01 |
| 可选 | user_data | string | 自定义用户信息,不超过128个字符 |
| 可选 | multi_oriented_detection |
String |
对image参数启用图片旋转检测功能。当image参数中传入的图片未检测到人脸时,是否对图片尝试旋转90度、180度、270度后再检测人脸。本参数取值只能是 "1"或 "0" (缺省值为"0"): "1":启用旋转检测(启用旋转检测后,会增加API的调用时间) "0":不启用旋转检测 其他值:返回错误码400(BAD_ARGUMENTS) 注意:设置此参数为1可能会轻微增加误检人脸的概率,如果您明确您的业务场景里不存在非正向的人脸图片、或概率极低,建议勿设置此参数 |
# 返回值说明
| 字段 | 类型 | 说明 |
|---|---|---|
| request_id |
String | 用于区分每一次请求的唯一的字符串。除非发生404(API_NOT_FOUND ) 或403 (AUTHORIZATION_ERROR)错误,此字段必定返回。 |
| group_id | String | 用户自定义的 人脸库 标识,如果未定义则返回值为空 |
| time_used |
Int | 整个请求所花费的时间,单位为毫秒。除非发生404(API_NOT_FOUND )或403 (AUTHORIZATION_ERROR)错误,此字段必定返回。 |
| error | String | 当请求失败时才会返回此字符串,具体返回内容见后续错误信息章节。否则此字段不存在。 |
| face_token | String | 加入成功的人脸token |
返回值示例
正确请求返回示例
{
"request_id": "1769739688,c3e156ca-789f-4568-a310-357dc9790d62",
"time_used": 1900,
"group_id": "YuanliStudent_01",
"face_token": "1691157fa602e57087489b0462029a9c"
}
错误返回示例
{
"request_id": "1769684828,e483ae63-913b-4e32-9068-3719cce59570",
"time_used": 15,
"error": "INVALID_GROUP_ID"
}
# error_message错误信息
当前API特有ERROR_MESSAGE
| HTTP状态码 | 错误信息 | 说明 |
|---|---|---|
| 400 | INVALID_OUTER_ID | 人脸库不存在 |
| 400 | NO_FACE_FOUND | 未找到人脸 |