腾讯云-人脸识别

第三方服务商
价格:免费使用  
服务商: 万维易源
  • 产品介绍
  • 接口文档
  • 服务商
  • 官方客服

腾讯云人脸识别提供包括人脸检测与分析、五官定位、人脸搜索、人脸比对、人脸验证、活体检测等多种功能,为您提供高性能高可用的人脸识别服务。可应用于智慧零售、智慧社区、智慧楼宇、在线身份认证等多种应用场景,充分满足各行业客户的人脸属性识别及用户身份确认等需求。

人员库-创建人员库


接口地址:http://route.showapi.com/1948-7 (注意:接口支持https,更安全,但稍慢一些,你懂的。请根据自己的情况进行选择。)
支持格式:json
请求方法:HTTP协议,支持GET/POST方法。

二、请求参数/ Request parameter

非文件上传的POST时,enctype=application/x-www-form-urlencoded。 
文件上传的POST时,enctype=multipart/form-data。 

1、系统级参数(所有接入点都需要的参数): 

参数名称类型示例值必须描述
showapi_appidString100易源应用id
showapi_signString698d51a19d8a121ce581499d7b701668为了验证用户身份,以及确保参数不被中间人篡改,需要传递调用者的数字签名。 可选,在url后带上appid和secret即可 
showapi_timestampString20141114142239客户端时间。 
格式yyyyMMddHHmmss,如20141114142239 
为了在一定程度上防止“重放攻击”,平台只接受在10分钟之内的请求。如果不传或传空串,则系统不再做此字段的检测。 
showapi_res_gzipString1或0返回值是否用gzip方式压缩。此值为1时将压缩,其他值不压缩。
...

2、应用级参数(每个接入点有自己的参数,当前接入点的参数见下表): 展开收起 

参数名称类型默认值示例值必须描述
GroupNameString 测试1号人员库名称,[1,60]个字符,可修改,不可重复。
GroupIdString 1人员库 ID,不可修改,不可重复。支持英文、数字、-%@#&_,长度限制64B。
TagString 测试tag人员库信息备注,[0,40]个字符。
GroupExDescriptionsList ["测试x","测试xx","测试xxx"]人员库自定义描述字段,用于描述人员库中人员属性,该人员库下所有人员将拥有此描述字段。 最多可以创建5个。 每个自定义描述字段支持[1,30]个字符。 在同一人员库中自定义描述字段不可重复。 例: 设置某人员库“自定义描述字段”为["学号","工号","手机号"], 则该人员库下所有人员将拥有名为“学号”、“工号”、“手机号”的描述字段, 可在对应人员描述字段中填写内容,登记该人员的学号、工号、手机号等信息。
...
请求示例:String res=new ShowApiRequest("http://route.showapi.com/1948-7","my_appId","my_appSecret") .addTextPara("GroupName","测试1号") .addTextPara("GroupId","1") .addTextPara("Tag","测试tag") .addTextPara("GroupExDescriptions","[\"测试x\",\"测试xx\",\"测试xxx\"]") .post(); System.out.println(res);

三、返回参数/ Return parameter

以JSON格式返回结果。

1、系统级参数(所有接入点都会返回的参数): 展开收起 

名称类型示例值描述
showapi_res_bodyString{"city":"昆明","prov":"云南"}消息体的JSON封装,所有应用级的返回参数将嵌入此对象 。
showapi_res_codeint0易源返回标志,0为成功,其他为失败。
0成功
-1,系统调用错误
-2,可调用次数或金额为0
-3,读取超时
-4,服务端返回数据解析错误
-5,后端服务器DNS解析错误
-6,服务不存在或未上线
-7, API创建者的网关资源不足
-1000,系统维护
-1002,showapi_appid字段必传
-1003,showapi_sign字段必传
-1004,签名sign验证有误
-1005,showapi_timestamp无效
-1006,app无权限调用接口 
-1007,没有订购套餐
-1008,服务商关闭对您的调用权限
-1009,调用频率受限
-1010,找不到您的应用
-1011,子授权app_child_id无效
-1012,子授权已过期或失效
-1013,子授权ip受限
-1014,token权限无效
 
showapi_res_errorString用户输入有误!错误信息的展示
showapi_res_idStringce135f6739294c63be0c021b76b6fbff本次请求id
...

2、应用级参数(系统级输出参数showapi_res_body字段中的json数据结构): 展开收起 

名称类型示例值描述
Response Object  
-  RequestId Stringcec49d95-83b3-424e-903e-ed251aa45f0b唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
remark String调用成功!返回说明!
ret_code Number00为成功,其余为失败
...
返回示例:{ "showapi_res_error": "", "showapi_res_id": "02b523f73b8447bf91c52007a6d4d51c", "showapi_res_code": 0, "showapi_res_body": { "Response": { "RequestId": "cec49d95-83b3-424e-903e-ed251aa45f0b" }, "remark": "调用成功!", "ret_code": 0 } }

人员库-删除人员库


接口地址:http://route.showapi.com/1948-8 (注意:接口支持https,更安全,但稍慢一些,你懂的。请根据自己的情况进行选择。)
支持格式:json
请求方法:HTTP协议,支持GET/POST方法。

二、请求参数/ Request parameter

非文件上传的POST时,enctype=application/x-www-form-urlencoded。
文件上传的POST时,enctype=multipart/form-data。

1、系统级参数(所有接入点都需要的参数):
参数名称 类型 示例值 必须 描述
showapi_appid String 100 易源应用id
showapi_sign String 698d51a19d8a121ce581499d7b701668 为了验证用户身份,以及确保参数不被中间人篡改,需要传递调用者的数字签名。 可选,在url后带上appid和secret即可
showapi_timestamp String 20141114142239 客户端时间。
格式yyyyMMddHHmmss,如20141114142239
为了在一定程度上防止“重放攻击”,平台只接受在10分钟之内的请求。如果不传或传空串,则系统不再做此字段的检测。
showapi_res_gzip String 1或0 返回值是否用gzip方式压缩。此值为1时将压缩,其他值不压缩。
...
2、应用级参数(每个接入点有自己的参数,当前接入点的参数见下表):
参数名称 类型 默认值 示例值 必须 描述
GroupId String
1
人员库ID。
请求示例:String res=new ShowApiRequest("http://route.showapi.com/1948-8","my_appId","my_appSecret") .addTextPara("GroupId","1") .post(); System.out.println(res);

三、返回参数/ Return parameter

以JSON格式返回结果。

1、系统级参数(所有接入点都会返回的参数): 展开收起
名称 类型 示例值 描述
showapi_res_body String {"city":"昆明","prov":"云南"} 消息体的JSON封装,所有应用级的返回参数将嵌入此对象 。
showapi_res_code int 0
易源返回标志,0为成功,其他为失败。
0成功
-1,系统调用错误
-2,可调用次数或金额为0
-3,读取超时
-4,服务端返回数据解析错误
-5,后端服务器DNS解析错误
-6,服务不存在或未上线
-7, API创建者的网关资源不足
-1000,系统维护
-1002,showapi_appid字段必传
-1003,showapi_sign字段必传
-1004,签名sign验证有误
-1005,showapi_timestamp无效
-1006,app无权限调用接口
-1007,没有订购套餐
-1008,服务商关闭对您的调用权限
-1009,调用频率受限
-1010,找不到您的应用
-1011,子授权app_child_id无效
-1012,子授权已过期或失效
-1013,子授权ip受限
-1014,token权限无效
showapi_res_error String 用户输入有误! 错误信息的展示
showapi_res_id String ce135f6739294c63be0c021b76b6fbff 本次请求id
...
2、应用级参数(系统级输出参数showapi_res_body字段中的json数据结构): 展开收起
名称 类型 示例值 描述
Response Object
RequestId String
b4ccf737-6c7f-44bd-aa9d-b82bf02a76bb
唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId
remark String
调用成功!
ret_code Number
0
...
返回示例:{ "showapi_res_error": "", "showapi_res_id": "0a0de59b74eb4875ba2a056af73ae43a", "showapi_res_code": 0, "showapi_res_body": { "Response": { "RequestId": "b4ccf737-6c7f-44bd-aa9d-b82bf02a76bb" }, "remark": "调用成功!", "ret_code": 0 } }

人员库-获取人员库列表


接口地址:http://route.showapi.com/1948-9 (注意:接口支持https,更安全,但稍慢一些,你懂的。请根据自己的情况进行选择。)
支持格式:json
请求方法:HTTP协议,支持GET/POST方法。

二、请求参数/ Request parameter

非文件上传的POST时,enctype=application/x-www-form-urlencoded。
文件上传的POST时,enctype=multipart/form-data。

1、系统级参数(所有接入点都需要的参数):
参数名称 类型 示例值 必须 描述
showapi_appid String 100 易源应用id
showapi_sign String 698d51a19d8a121ce581499d7b701668 为了验证用户身份,以及确保参数不被中间人篡改,需要传递调用者的数字签名。 可选,在url后带上appid和secret即可
showapi_timestamp String 20141114142239 客户端时间。
格式yyyyMMddHHmmss,如20141114142239
为了在一定程度上防止“重放攻击”,平台只接受在10分钟之内的请求。如果不传或传空串,则系统不再做此字段的检测。
showapi_res_gzip String 1或0 返回值是否用gzip方式压缩。此值为1时将压缩,其他值不压缩。
...
2、应用级参数(每个接入点有自己的参数,当前接入点的参数见下表):
参数名称 类型 默认值 示例值 必须 描述
Offset Number 0
0
起始序号,默认值为0
Limit Number 10
10
返回数量,默认值为10,最大值为1000
请求示例:String res=new ShowApiRequest("http://route.showapi.com/1948-9","my_appId","my_appSecret") .addTextPara("Offset","0") .addTextPara("Limit","10") .post(); System.out.println(res);

三、返回参数/ Return parameter

以JSON格式返回结果。

1、系统级参数(所有接入点都会返回的参数): 展开收起
名称 类型 示例值 描述
showapi_res_body String {"city":"昆明","prov":"云南"} 消息体的JSON封装,所有应用级的返回参数将嵌入此对象 。
showapi_res_code int 0
易源返回标志,0为成功,其他为失败。
0成功
-1,系统调用错误
-2,可调用次数或金额为0
-3,读取超时
-4,服务端返回数据解析错误
-5,后端服务器DNS解析错误
-6,服务不存在或未上线
-7, API创建者的网关资源不足
-1000,系统维护
-1002,showapi_appid字段必传
-1003,showapi_sign字段必传
-1004,签名sign验证有误
-1005,showapi_timestamp无效
-1006,app无权限调用接口
-1007,没有订购套餐
-1008,服务商关闭对您的调用权限
-1009,调用频率受限
-1010,找不到您的应用
-1011,子授权app_child_id无效
-1012,子授权已过期或失效
-1013,子授权ip受限
-1014,token权限无效
showapi_res_error String 用户输入有误! 错误信息的展示
showapi_res_id String ce135f6739294c63be0c021b76b6fbff 本次请求id
...
2、应用级参数(系统级输出参数showapi_res_body字段中的json数据结构): 展开收起
名称 类型 示例值 描述
Response Object
GroupInfos Object[]
返回的人员库信息
0 Object
GroupExDescriptions String[]
[]
Group的创建时间和日期 CreationTimestamp。CreationTimestamp 的值是自 Unix 纪元时间到Group创建时间的毫秒数。 Unix 纪元时间是 1970 年 1 月 1 日星期四,协调世界时 (UTC) 00:00:00。有关更多信息,请参阅 Unix 时间。 注意:此字段可能返回 null,表示取不到有效值。
GroupId String
showpai001
人员库ID
GroupName String
showapi
人员库名称
Tag Object
人员库信息备注 注意:此字段可能返回 null,表示取不到有效值。
GroupNum Number
1
人员库总数量 注意:此字段可能返回 null,表示取不到有效值。
RequestId String
a91253e5-96ba-43be-906a-d83cd6c9419b
唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
remark String
调用成功!
ret_code Number
0
...
返回示例:{ "showapi_res_error": "", "showapi_res_id": "5eeb56f35d944848936fedbafa69c933", "showapi_res_code": 0, "showapi_res_body": { "Response": { "GroupInfos": [ { "GroupExDescriptions": [], "GroupId": "showpai001", "GroupName": "showapi", "Tag": null } ], "GroupNum": 1, "RequestId": "a91253e5-96ba-43be-906a-d83cd6c9419b" }, "remark": "调用成功!", "ret_code": 0 } }

人员库-修改人员库


接口地址:http://route.showapi.com/1948-10 (注意:接口支持https,更安全,但稍慢一些,你懂的。请根据自己的情况进行选择。)
支持格式:json
请求方法:HTTP协议,支持GET/POST方法。

二、请求参数/ Request parameter

非文件上传的POST时,enctype=application/x-www-form-urlencoded。
文件上传的POST时,enctype=multipart/form-data。

1、系统级参数(所有接入点都需要的参数):
参数名称 类型 示例值 必须 描述
showapi_appid String 100 易源应用id
showapi_sign String 698d51a19d8a121ce581499d7b701668 为了验证用户身份,以及确保参数不被中间人篡改,需要传递调用者的数字签名。 可选,在url后带上appid和secret即可
showapi_timestamp String 20141114142239 客户端时间。
格式yyyyMMddHHmmss,如20141114142239
为了在一定程度上防止“重放攻击”,平台只接受在10分钟之内的请求。如果不传或传空串,则系统不再做此字段的检测。
showapi_res_gzip String 1或0 返回值是否用gzip方式压缩。此值为1时将压缩,其他值不压缩。
...
2、应用级参数(每个接入点有自己的参数,当前接入点的参数见下表): 展开收起
参数名称 类型 默认值 示例值 必须 描述
GroupId String
1
人员库ID、唯一的。
GroupName String
修改后测试
人员库名称,唯一的。
Tag String
修改后测试tag
人员库信息备注
GroupExDescriptionInfos List
[{"GroupExDescriptionIndex":1,"GroupExDescription":"修改后测试描述"}]
需要修改的人员库自定义描述字段 GroupExDescriptionIndex(参数类型为Integer):人员库自定义描述字段Index,从0开始 GroupExDescription(参数类型为String):需要更新的人员库自定义描述字段内容 例子 [{ GroupExDescriptionIndex:1, GroupExDescription:"修改后测试描述" }]
...
请求示例:String res=new ShowApiRequest("http://route.showapi.com/1948-10","my_appId","my_appSecret") .addTextPara("GroupId","1") .addTextPara("GroupName","修改后测试") .addTextPara("Tag","修改后测试tag") .addTextPara("GroupExDescriptionInfos","[{\"GroupExDescriptionIndex\":1,\"GroupExDescription\":\"修改后测试描述\"}]") .post(); System.out.println(res);

三、返回参数/ Return parameter

以JSON格式返回结果。

1、系统级参数(所有接入点都会返回的参数): 展开收起
名称 类型 示例值 描述
showapi_res_body String {"city":"昆明","prov":"云南"} 消息体的JSON封装,所有应用级的返回参数将嵌入此对象 。
showapi_res_code int 0
易源返回标志,0为成功,其他为失败。
0成功
-1,系统调用错误
-2,可调用次数或金额为0
-3,读取超时
-4,服务端返回数据解析错误
-5,后端服务器DNS解析错误
-6,服务不存在或未上线
-7, API创建者的网关资源不足
-1000,系统维护
-1002,showapi_appid字段必传
-1003,showapi_sign字段必传
-1004,签名sign验证有误
-1005,showapi_timestamp无效
-1006,app无权限调用接口
-1007,没有订购套餐
-1008,服务商关闭对您的调用权限
-1009,调用频率受限
-1010,找不到您的应用
-1011,子授权app_child_id无效
-1012,子授权已过期或失效
-1013,子授权ip受限
-1014,token权限无效
showapi_res_error String 用户输入有误! 错误信息的展示
showapi_res_id String ce135f6739294c63be0c021b76b6fbff 本次请求id
...
2、应用级参数(系统级输出参数showapi_res_body字段中的json数据结构): 展开收起
名称 类型 示例值 描述
Response Object
RequestId String
d8020d97-54a5-47e9-95b9-f24b07984634
唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
remark String
调用成功!
ret_code Number
0
...
返回示例:{ "showapi_res_error": "", "showapi_res_id": "d472907fc1be4f01bf2abf479476ba77", "showapi_res_code": 0, "showapi_res_body": { "Response": { "RequestId": "d8020d97-54a5-47e9-95b9-f24b07984634" }, "remark": "调用成功!", "ret_code": 0 } }

人员库-创建人员


接口地址:http://route.showapi.com/1948-11 (注意:接口支持https,更安全,但稍慢一些,你懂的。请根据自己的情况进行选择。)
支持格式:json
请求方法:HTTP协议,支持GET/POST方法。

二、请求参数/ Request parameter

非文件上传的POST时,enctype=application/x-www-form-urlencoded。
文件上传的POST时,enctype=multipart/form-data。

1、系统级参数(所有接入点都需要的参数):
参数名称 类型 示例值 必须 描述
showapi_appid String 100 易源应用id
showapi_sign String 698d51a19d8a121ce581499d7b701668 为了验证用户身份,以及确保参数不被中间人篡改,需要传递调用者的数字签名。 可选,在url后带上appid和secret即可
showapi_timestamp String 20141114142239 客户端时间。
格式yyyyMMddHHmmss,如20141114142239
为了在一定程度上防止“重放攻击”,平台只接受在10分钟之内的请求。如果不传或传空串,则系统不再做此字段的检测。
showapi_res_gzip String 1或0 返回值是否用gzip方式压缩。此值为1时将压缩,其他值不压缩。
...
2、应用级参数(每个接入点有自己的参数,当前接入点的参数见下表): 展开收起
参数名称 类型 默认值 示例值 必须 描述
GroupId String
TencentShenZhenEmployee
待加入的人员库ID。
PersonName String
evanliao
人员名称。[1,60]个字符,可修改,可重复。
PersonId String
1003
人员ID,单个腾讯云账号下不可修改,不可重复。支持英文、数字、-%@#&_,长度限制64B。
Image String
/9j/4AAQSkZJRgABAQEAAQABAAD/2wBDAAEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQH/2wBDAQEBAQEB………………………………s8On6VYtLavb2MXh/wzptpNpTsi2Ut8ZPNcq0U/xuFlLFZhjsRytVqFWlCjW3UIThDmiov3Jb2vKLem9z2sbVpYbC4TBPSnWpVJ14czvOanJxfNfmjZW0i0vI//2Q==
图片 base64 数据。 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
Url String
https://showapi.oss-cn-hangzhou.aliyuncs.com/modleapi/lzh/2.jpg
图片的 Url、Image必须提供一个,如果都提供,只使用 Url。 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。 非腾讯云存储的Url速度和稳定性可能受一定影响。 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
Gender Number
1
0代表未填写,1代表男性,2代表女性。
PersonExDescriptionInfos List
[{"PersonExDescriptionIndex":1,"PersonExDescription":"修改后测试描述"}]
人员描述字段内容,key-value。[0,60]个字符,可修改,可重复。 PersonExDescriptionIndex(参数类型为Integer):人员库自定义描述字段Index,从0开始 PersonExDescription(参数类型为String):需要更新的人员库自定义描述字段内容 例子 [{ PersonExDescriptionIndex:1, PersonExDescription:"修改后测试描述" }]
...
请求示例:String res=new ShowApiRequest("http://route.showapi.com/1948-11","my_appId","my_appSecret") .addTextPara("GroupId","TencentShenZhenEmployee") .addTextPara("PersonName","evanliao") .addTextPara("PersonId","1003") .addTextPara("Image","/9j/4AAQSkZJRgABAQEAAQABAAD/2wBDAAEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQH/2wBDAQEBAQEB………………………………s8On6VYtLavb2MXh/wzptpNpTsi2Ut8ZPNcq0U/xuFlLFZhjsRytVqFWlCjW3UIThDmiov3Jb2vKLem9z2sbVpYbC4TBPSnWpVJ14czvOanJxfNfmjZW0i0vI//2Q==") .addTextPara("Url","https://showapi.oss-cn-hangzhou.aliyuncs.com/modleapi/lzh/2.jpg") .addTextPara("Gender","1") .addTextPara("PersonExDescriptionInfos","[{\"PersonExDescriptionIndex\":1,\"PersonExDescription\":\"修改后测试描述\"}]") .post(); System.out.println(res);

三、返回参数/ Return parameter

以JSON格式返回结果。

1、系统级参数(所有接入点都会返回的参数): 展开收起
名称 类型 示例值 描述
showapi_res_body String {"city":"昆明","prov":"云南"} 消息体的JSON封装,所有应用级的返回参数将嵌入此对象 。
showapi_res_code int 0
易源返回标志,0为成功,其他为失败。
0成功
-1,系统调用错误
-2,可调用次数或金额为0
-3,读取超时
-4,服务端返回数据解析错误
-5,后端服务器DNS解析错误
-6,服务不存在或未上线
-7, API创建者的网关资源不足
-1000,系统维护
-1002,showapi_appid字段必传
-1003,showapi_sign字段必传
-1004,签名sign验证有误
-1005,showapi_timestamp无效
-1006,app无权限调用接口
-1007,没有订购套餐
-1008,服务商关闭对您的调用权限
-1009,调用频率受限
-1010,找不到您的应用
-1011,子授权app_child_id无效
-1012,子授权已过期或失效
-1013,子授权ip受限
-1014,token权限无效
showapi_res_error String 用户输入有误! 错误信息的展示
showapi_res_id String ce135f6739294c63be0c021b76b6fbff 本次请求id
...
2、应用级参数(系统级输出参数showapi_res_body字段中的json数据结构): 展开收起
名称 类型 示例值 描述
Response Object
FaceId String
3188575594736580813
人脸图片唯一标识。
RequestId String
a58a94a8-1ed7-4949-84e9-a107856a2763
唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
remark String
ret_code Number
0
...
返回示例:{ "showapi_res_error": "", "showapi_res_id": "f328cc5c1c2f4277b7b1dbd9bc2f14d7", "showapi_res_code": 0, "showapi_res_body": { "Response": { "FaceId": "3188575594736580813", "RequestId": "a58a94a8-1ed7-4949-84e9-a107856a2763" }, "remark": "", "ret_code": 0 } }

人员库-复制人员


接口地址:http://route.showapi.com/1948-22 (注意:接口支持https,更安全,但稍慢一些,你懂的。请根据自己的情况进行选择。)
支持格式:json
请求方法:HTTP协议,支持GET/POST方法。

二、请求参数/ Request parameter

非文件上传的POST时,enctype=application/x-www-form-urlencoded。
文件上传的POST时,enctype=multipart/form-data。

1、系统级参数(所有接入点都需要的参数):
参数名称 类型 示例值 必须 描述
showapi_appid String 100 易源应用id
showapi_sign String 698d51a19d8a121ce581499d7b701668 为了验证用户身份,以及确保参数不被中间人篡改,需要传递调用者的数字签名。 可选,在url后带上appid和secret即可
showapi_timestamp String 20141114142239 客户端时间。
格式yyyyMMddHHmmss,如20141114142239
为了在一定程度上防止“重放攻击”,平台只接受在10分钟之内的请求。如果不传或传空串,则系统不再做此字段的检测。
showapi_res_gzip String 1或0 返回值是否用gzip方式压缩。此值为1时将压缩,其他值不压缩。
...
2、应用级参数(每个接入点有自己的参数,当前接入点的参数见下表):
参数名称 类型 默认值 示例值 必须 描述
PersonId String
1003
人员ID
GroupId String
1
待加入的人员库列表
请求示例:String res=new ShowApiRequest("http://route.showapi.com/1948-22","my_appId","my_appSecret") .addTextPara("PersonId","1003") .addTextPara("GroupId","1") .post(); System.out.println(res);

三、返回参数/ Return parameter

以JSON格式返回结果。

1、系统级参数(所有接入点都会返回的参数): 展开收起
名称 类型 示例值 描述
showapi_res_body String {"city":"昆明","prov":"云南"} 消息体的JSON封装,所有应用级的返回参数将嵌入此对象 。
showapi_res_code int 0
易源返回标志,0为成功,其他为失败。
0成功
-1,系统调用错误
-2,可调用次数或金额为0
-3,读取超时
-4,服务端返回数据解析错误
-5,后端服务器DNS解析错误
-6,服务不存在或未上线
-7, API创建者的网关资源不足
-1000,系统维护
-1002,showapi_appid字段必传
-1003,showapi_sign字段必传
-1004,签名sign验证有误
-1005,showapi_timestamp无效
-1006,app无权限调用接口
-1007,没有订购套餐
-1008,服务商关闭对您的调用权限
-1009,调用频率受限
-1010,找不到您的应用
-1011,子授权app_child_id无效
-1012,子授权已过期或失效
-1013,子授权ip受限
-1014,token权限无效
showapi_res_error String 用户输入有误! 错误信息的展示
showapi_res_id String ce135f6739294c63be0c021b76b6fbff 本次请求id
...
2、应用级参数(系统级输出参数showapi_res_body字段中的json数据结构): 展开收起
名称 类型 示例值 描述
Response Object
SucGroupNum Number
2
成功加入的人员库数量
SucGroupIds String[]
["ShenZhenCitizen","TencentShenZhenEmployee"]
成功加入的人员库列表
RequestId String
9841c008-e597-4356-a8d5-c47a246abd8d
唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
remark String
查询成功!
ret_code Number
0
...
返回示例:{ "showapi_res_error":"", "showapi_res_id":"ecdb2d30d1b043a5aa566654addc7e15", "showapi_res_code":0, "showapi_res_body":{ "Response":{ "SucGroupNum":2, "SucGroupIds":[ "ShenZhenCitizen", "TencentShenZhenEmployee" ], "RequestId":"9841c008-e597-4356-a8d5-c47a246abd8d" }, "remark":"查询成功!", "ret_code":0 } }

人员库-删除人员


接口地址:http://route.showapi.com/1948-12 (注意:接口支持https,更安全,但稍慢一些,你懂的。请根据自己的情况进行选择。)
支持格式:json
请求方法:HTTP协议,支持GET/POST方法。

二、请求参数/ Request parameter

非文件上传的POST时,enctype=application/x-www-form-urlencoded。
文件上传的POST时,enctype=multipart/form-data。

1、系统级参数(所有接入点都需要的参数):
参数名称 类型 示例值 必须 描述
showapi_appid String 100 易源应用id
showapi_sign String 698d51a19d8a121ce581499d7b701668 为了验证用户身份,以及确保参数不被中间人篡改,需要传递调用者的数字签名。 可选,在url后带上appid和secret即可
showapi_timestamp String 20141114142239 客户端时间。
格式yyyyMMddHHmmss,如20141114142239
为了在一定程度上防止“重放攻击”,平台只接受在10分钟之内的请求。如果不传或传空串,则系统不再做此字段的检测。
showapi_res_gzip String 1或0 返回值是否用gzip方式压缩。此值为1时将压缩,其他值不压缩。
...
2、应用级参数(每个接入点有自己的参数,当前接入点的参数见下表):
参数名称 类型 默认值 示例值 必须 描述
PersonId String
1003
人员ID
请求示例:String res=new ShowApiRequest("http://route.showapi.com/1948-12","my_appId","my_appSecret") .addTextPara("PersonId","1003") .post(); System.out.println(res);

三、返回参数/ Return parameter

以JSON格式返回结果。

1、系统级参数(所有接入点都会返回的参数): 展开收起
名称 类型 示例值 描述
showapi_res_body String {"city":"昆明","prov":"云南"} 消息体的JSON封装,所有应用级的返回参数将嵌入此对象 。
showapi_res_code int 0
易源返回标志,0为成功,其他为失败。
0成功
-1,系统调用错误
-2,可调用次数或金额为0
-3,读取超时
-4,服务端返回数据解析错误
-5,后端服务器DNS解析错误
-6,服务不存在或未上线
-7, API创建者的网关资源不足
-1000,系统维护
-1002,showapi_appid字段必传
-1003,showapi_sign字段必传
-1004,签名sign验证有误
-1005,showapi_timestamp无效
-1006,app无权限调用接口
-1007,没有订购套餐
-1008,服务商关闭对您的调用权限
-1009,调用频率受限
-1010,找不到您的应用
-1011,子授权app_child_id无效
-1012,子授权已过期或失效
-1013,子授权ip受限
-1014,token权限无效
showapi_res_error String 用户输入有误! 错误信息的展示
showapi_res_id String ce135f6739294c63be0c021b76b6fbff 本次请求id
...
2、应用级参数(系统级输出参数showapi_res_body字段中的json数据结构): 展开收起
名称 类型 示例值 描述
Response Object
RequestId String
c8037565-479a-4db6-b919-8516d9683544
唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
remark String
ret_code Number
0
...
返回示例:{ "showapi_res_error": "", "showapi_res_id": "edda98fb1185498db3cbde85384fc200", "showapi_res_code": 0, "showapi_res_body": { "Response": { "RequestId": "c8037565-479a-4db6-b919-8516d9683544" }, "remark": "", "ret_code": 0 } }

人员库-人员库删除人员


接口地址:http://route.showapi.com/1948-13 (注意:接口支持https,更安全,但稍慢一些,你懂的。请根据自己的情况进行选择。)
支持格式:json
请求方法:HTTP协议,支持GET/POST方法。

二、请求参数/ Request parameter

非文件上传的POST时,enctype=application/x-www-form-urlencoded。
文件上传的POST时,enctype=multipart/form-data。

1、系统级参数(所有接入点都需要的参数):
参数名称 类型 示例值 必须 描述
showapi_appid String 100 易源应用id
showapi_sign String 698d51a19d8a121ce581499d7b701668 为了验证用户身份,以及确保参数不被中间人篡改,需要传递调用者的数字签名。 可选,在url后带上appid和secret即可
showapi_timestamp String 20141114142239 客户端时间。
格式yyyyMMddHHmmss,如20141114142239
为了在一定程度上防止“重放攻击”,平台只接受在10分钟之内的请求。如果不传或传空串,则系统不再做此字段的检测。
showapi_res_gzip String 1或0 返回值是否用gzip方式压缩。此值为1时将压缩,其他值不压缩。
...
2、应用级参数(每个接入点有自己的参数,当前接入点的参数见下表):
参数名称 类型 默认值 示例值 必须 描述
PersonId String
1001
人员ID
GroupId String
2
人员库ID
请求示例:String res=new ShowApiRequest("http://route.showapi.com/1948-13","my_appId","my_appSecret") .addTextPara("PersonId","1001") .addTextPara("GroupId","2") .post(); System.out.println(res);

三、返回参数/ Return parameter

以JSON格式返回结果。

1、系统级参数(所有接入点都会返回的参数): 展开收起
名称 类型 示例值 描述
showapi_res_body String {"city":"昆明","prov":"云南"} 消息体的JSON封装,所有应用级的返回参数将嵌入此对象 。
showapi_res_code int 0
易源返回标志,0为成功,其他为失败。
0成功
-1,系统调用错误
-2,可调用次数或金额为0
-3,读取超时
-4,服务端返回数据解析错误
-5,后端服务器DNS解析错误
-6,服务不存在或未上线
-7, API创建者的网关资源不足
-1000,系统维护
-1002,showapi_appid字段必传
-1003,showapi_sign字段必传
-1004,签名sign验证有误
-1005,showapi_timestamp无效
-1006,app无权限调用接口
-1007,没有订购套餐
-1008,服务商关闭对您的调用权限
-1009,调用频率受限
-1010,找不到您的应用
-1011,子授权app_child_id无效
-1012,子授权已过期或失效
-1013,子授权ip受限
-1014,token权限无效
showapi_res_error String 用户输入有误! 错误信息的展示
showapi_res_id String ce135f6739294c63be0c021b76b6fbff 本次请求id
...
2、应用级参数(系统级输出参数showapi_res_body字段中的json数据结构): 展开收起
名称 类型 示例值 描述
Response Object
RequestId String
276dd457-df60-402e-aea2-bf984076a3d8
唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
remark String
查询成功!
ret_code Number
0
...
返回示例:{ "showapi_res_error": "", "showapi_res_id": "a87262ca301f44cb9f22d973a7ec9ce6", "showapi_res_code": 0, "showapi_res_body": { "Response": { "RequestId": "276dd457-df60-402e-aea2-bf984076a3d8" }, "remark": "查询成功!", "ret_code": 0 } }

人员库-获取人员列表


接口地址:http://route.showapi.com/1948-14 (注意:接口支持https,更安全,但稍慢一些,你懂的。请根据自己的情况进行选择。)
支持格式:json
请求方法:HTTP协议,支持GET/POST方法。

二、请求参数/ Request parameter

非文件上传的POST时,enctype=application/x-www-form-urlencoded。
文件上传的POST时,enctype=multipart/form-data。

1、系统级参数(所有接入点都需要的参数):
参数名称 类型 示例值 必须 描述
showapi_appid String 100 易源应用id
showapi_sign String 698d51a19d8a121ce581499d7b701668 为了验证用户身份,以及确保参数不被中间人篡改,需要传递调用者的数字签名。 可选,在url后带上appid和secret即可
showapi_timestamp String 20141114142239 客户端时间。
格式yyyyMMddHHmmss,如20141114142239
为了在一定程度上防止“重放攻击”,平台只接受在10分钟之内的请求。如果不传或传空串,则系统不再做此字段的检测。
showapi_res_gzip String 1或0 返回值是否用gzip方式压缩。此值为1时将压缩,其他值不压缩。
...
2、应用级参数(每个接入点有自己的参数,当前接入点的参数见下表): 展开收起
参数名称 类型 默认值 示例值 必须 描述
GroupId String
TencentShenZhenEmployee
人员库ID
Offset Number 0
0
起始序号,默认值为0
Limit Number 10
10
返回数量,默认值为10,最大值为1000
...
请求示例:String res=new ShowApiRequest("http://route.showapi.com/1948-14","my_appId","my_appSecret") .addTextPara("GroupId","TencentShenZhenEmployee") .addTextPara("Offset","0") .addTextPara("Limit","10") .post(); System.out.println(res);

三、返回参数/ Return parameter

以JSON格式返回结果。

1、系统级参数(所有接入点都会返回的参数): 展开收起
名称 类型 示例值 描述
showapi_res_body String {"city":"昆明","prov":"云南"} 消息体的JSON封装,所有应用级的返回参数将嵌入此对象 。
showapi_res_code int 0
易源返回标志,0为成功,其他为失败。
0成功
-1,系统调用错误
-2,可调用次数或金额为0
-3,读取超时
-4,服务端返回数据解析错误
-5,后端服务器DNS解析错误
-6,服务不存在或未上线
-7, API创建者的网关资源不足
-1000,系统维护
-1002,showapi_appid字段必传
-1003,showapi_sign字段必传
-1004,签名sign验证有误
-1005,showapi_timestamp无效
-1006,app无权限调用接口
-1007,没有订购套餐
-1008,服务商关闭对您的调用权限
-1009,调用频率受限
-1010,找不到您的应用
-1011,子授权app_child_id无效
-1012,子授权已过期或失效
-1013,子授权ip受限
-1014,token权限无效
showapi_res_error String 用户输入有误! 错误信息的展示
showapi_res_id String ce135f6739294c63be0c021b76b6fbff 本次请求id
...
2、应用级参数(系统级输出参数showapi_res_body字段中的json数据结构): 展开收起
名称 类型 示例值 描述
Response Object
FaceNum Number
1
该人员库的人脸数量 注意:此字段可能返回 null,表示取不到有效值。
PersonInfos Object[]
返回的人员信息
0 Object
FaceIds String[]
["3188584979915358032"]
包含的人脸照片列表
Gender Number
2
人员性别
PersonExDescriptions String[]
[]
人员描述字段内容
PersonId String
0002
人员Id
PersonName String
2号
人员名称
PersonNum Number
1
该人员库的人员数量 注意:此字段可能返回 null,表示取不到有效值。
RequestId String
537b435e-ea94-435e-b490-2ffd85b1f196
唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
remark String
查询成功!
ret_code Number
0
...
返回示例:{ "showapi_res_error": "", "showapi_res_id": "5eac61c1a2ec4a1c81c2ccd309c063f2", "showapi_res_code": 0, "showapi_res_body": { "Response": { "FaceNum": 1, "PersonInfos": [ { "FaceIds": [ "3188584979915358032" ], "Gender": 2, "PersonExDescriptions": [], "PersonId": "0002", "PersonName": "2号" } ], "PersonNum": 1, "RequestId": "537b435e-ea94-435e-b490-2ffd85b1f196" }, "remark": "查询成功!", "ret_code": 0 } }

人员库-获取人员基础信息


接口地址:http://route.showapi.com/1948-16 (注意:接口支持https,更安全,但稍慢一些,你懂的。请根据自己的情况进行选择。)
支持格式:json
请求方法:HTTP协议,支持GET/POST方法。

二、请求参数/ Request parameter

非文件上传的POST时,enctype=application/x-www-form-urlencoded。
文件上传的POST时,enctype=multipart/form-data。

1、系统级参数(所有接入点都需要的参数):
参数名称 类型 示例值 必须 描述
showapi_appid String 100 易源应用id
showapi_sign String 698d51a19d8a121ce581499d7b701668 为了验证用户身份,以及确保参数不被中间人篡改,需要传递调用者的数字签名。 可选,在url后带上appid和secret即可
showapi_timestamp String 20141114142239 客户端时间。
格式yyyyMMddHHmmss,如20141114142239
为了在一定程度上防止“重放攻击”,平台只接受在10分钟之内的请求。如果不传或传空串,则系统不再做此字段的检测。
showapi_res_gzip String 1或0 返回值是否用gzip方式压缩。此值为1时将压缩,其他值不压缩。
...
2、应用级参数(每个接入点有自己的参数,当前接入点的参数见下表):
参数名称 类型 默认值 示例值 必须 描述
PersonId String
1002
人员ID
请求示例:String res=new ShowApiRequest("http://route.showapi.com/1948-16","my_appId","my_appSecret") .addTextPara("PersonId","1002") .post(); System.out.println(res);

三、返回参数/ Return parameter

以JSON格式返回结果。

1、系统级参数(所有接入点都会返回的参数): 展开收起
名称 类型 示例值 描述
showapi_res_body String {"city":"昆明","prov":"云南"} 消息体的JSON封装,所有应用级的返回参数将嵌入此对象 。
showapi_res_code int 0
易源返回标志,0为成功,其他为失败。
0成功
-1,系统调用错误
-2,可调用次数或金额为0
-3,读取超时
-4,服务端返回数据解析错误
-5,后端服务器DNS解析错误
-6,服务不存在或未上线
-7, API创建者的网关资源不足
-1000,系统维护
-1002,showapi_appid字段必传
-1003,showapi_sign字段必传
-1004,签名sign验证有误
-1005,showapi_timestamp无效
-1006,app无权限调用接口
-1007,没有订购套餐
-1008,服务商关闭对您的调用权限
-1009,调用频率受限
-1010,找不到您的应用
-1011,子授权app_child_id无效
-1012,子授权已过期或失效
-1013,子授权ip受限
-1014,token权限无效
showapi_res_error String 用户输入有误! 错误信息的展示
showapi_res_id String ce135f6739294c63be0c021b76b6fbff 本次请求id
...
2、应用级参数(系统级输出参数showapi_res_body字段中的json数据结构): 展开收起
名称 类型 示例值 描述
Response Object
FaceIds String[]
["3188584979915358032"]
包含的人脸图片列表
Gender Number
2
人员性别
PersonName String
2号
人员名称
RequestId String
1ebcd57b-87c1-4377-bc39-b4ee70287381
唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
remark String
查询成功!
ret_code Number
0
...
返回示例:{ "showapi_res_error": "", "showapi_res_id": "1afe8ce5a2774187bd5eb3fcaca88da5", "showapi_res_code": 0, "showapi_res_body": { "Response": { "FaceIds": [ "3188584979915358032" ], "Gender": 2, "PersonName": "2号", "RequestId": "1ebcd57b-87c1-4377-bc39-b4ee70287381" }, "remark": "查询成功!", "ret_code": 0 } }

人员库-获取人员归属信息


接口地址:http://route.showapi.com/1948-17 (注意:接口支持https,更安全,但稍慢一些,你懂的。请根据自己的情况进行选择。)
支持格式:json
请求方法:HTTP协议,支持GET/POST方法。

二、请求参数/ Request parameter

非文件上传的POST时,enctype=application/x-www-form-urlencoded。
文件上传的POST时,enctype=multipart/form-data。

1、系统级参数(所有接入点都需要的参数):
参数名称 类型 示例值 必须 描述
showapi_appid String 100 易源应用id
showapi_sign String 698d51a19d8a121ce581499d7b701668 为了验证用户身份,以及确保参数不被中间人篡改,需要传递调用者的数字签名。 可选,在url后带上appid和secret即可
showapi_timestamp String 20141114142239 客户端时间。
格式yyyyMMddHHmmss,如20141114142239
为了在一定程度上防止“重放攻击”,平台只接受在10分钟之内的请求。如果不传或传空串,则系统不再做此字段的检测。
showapi_res_gzip String 1或0 返回值是否用gzip方式压缩。此值为1时将压缩,其他值不压缩。
...
2、应用级参数(每个接入点有自己的参数,当前接入点的参数见下表): 展开收起
参数名称 类型 默认值 示例值 必须 描述
PersonId String
1002
人员ID
Offset Number
0
起始序号,默认值为0
Limit Number
10
返回数量,默认值为10,最大值为100
...
请求示例:String res=new ShowApiRequest("http://route.showapi.com/1948-17","my_appId","my_appSecret") .addTextPara("PersonId","1002") .addTextPara("Offset","0") .addTextPara("Limit","10") .post(); System.out.println(res);

三、返回参数/ Return parameter

以JSON格式返回结果。

1、系统级参数(所有接入点都会返回的参数): 展开收起
名称 类型 示例值 描述
showapi_res_body String {"city":"昆明","prov":"云南"} 消息体的JSON封装,所有应用级的返回参数将嵌入此对象 。
showapi_res_code int 0
易源返回标志,0为成功,其他为失败。
0成功
-1,系统调用错误
-2,可调用次数或金额为0
-3,读取超时
-4,服务端返回数据解析错误
-5,后端服务器DNS解析错误
-6,服务不存在或未上线
-7, API创建者的网关资源不足
-1000,系统维护
-1002,showapi_appid字段必传
-1003,showapi_sign字段必传
-1004,签名sign验证有误
-1005,showapi_timestamp无效
-1006,app无权限调用接口
-1007,没有订购套餐
-1008,服务商关闭对您的调用权限
-1009,调用频率受限
-1010,找不到您的应用
-1011,子授权app_child_id无效
-1012,子授权已过期或失效
-1013,子授权ip受限
-1014,token权限无效
showapi_res_error String 用户输入有误! 错误信息的展示
showapi_res_id String ce135f6739294c63be0c021b76b6fbff 本次请求id
...
2、应用级参数(系统级输出参数showapi_res_body字段中的json数据结构): 展开收起
名称 类型 示例值 描述
Response Object
GroupNum Number
1
人员库总数量 注意:此字段可能返回 null,表示取不到有效值。
PersonGroupInfos Object[]
包含此人员的人员库及描述字段内容列表
0 Object
GroupId String
showpai001
包含此人员的人员库ID
PersonExDescriptions String[]
[]
人员描述字段内容
RequestId String
ba41f6d0-2998-4aeb-8b98-065796587a2a
唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
remark String
查询成功!
ret_code Number
0
...
返回示例:{ "showapi_res_error": "", "showapi_res_id": "9a0d168095ee49ae83ce71dc865bcdc0", "showapi_res_code": 0, "showapi_res_body": { "Response": { "GroupNum": 1, "PersonGroupInfos": [ { "GroupId": "showpai001", "PersonExDescriptions": [] } ], "RequestId": "ba41f6d0-2998-4aeb-8b98-065796587a2a" }, "remark": "查询成功!", "ret_code": 0 } }

人员库-获取人员列表长度


接口地址:http://route.showapi.com/1948-15 (注意:接口支持https,更安全,但稍慢一些,你懂的。请根据自己的情况进行选择。)
支持格式:json
请求方法:HTTP协议,支持GET/POST方法。

二、请求参数/ Request parameter

非文件上传的POST时,enctype=application/x-www-form-urlencoded。
文件上传的POST时,enctype=multipart/form-data。

1、系统级参数(所有接入点都需要的参数):
参数名称 类型 示例值 必须 描述
showapi_appid String 100 易源应用id
showapi_sign String 698d51a19d8a121ce581499d7b701668 为了验证用户身份,以及确保参数不被中间人篡改,需要传递调用者的数字签名。 可选,在url后带上appid和secret即可
showapi_timestamp String 20141114142239 客户端时间。
格式yyyyMMddHHmmss,如20141114142239
为了在一定程度上防止“重放攻击”,平台只接受在10分钟之内的请求。如果不传或传空串,则系统不再做此字段的检测。
showapi_res_gzip String 1或0 返回值是否用gzip方式压缩。此值为1时将压缩,其他值不压缩。
...
2、应用级参数(每个接入点有自己的参数,当前接入点的参数见下表):
参数名称 类型 默认值 示例值 必须 描述
GroupId String
2
人员库ID
请求示例:String res=new ShowApiRequest("http://route.showapi.com/1948-15","my_appId","my_appSecret") .addTextPara("GroupId","2") .post(); System.out.println(res);

三、返回参数/ Return parameter

以JSON格式返回结果。

1、系统级参数(所有接入点都会返回的参数): 展开收起
名称 类型 示例值 描述
showapi_res_body String {"city":"昆明","prov":"云南"} 消息体的JSON封装,所有应用级的返回参数将嵌入此对象 。
showapi_res_code int 0
易源返回标志,0为成功,其他为失败。
0成功
-1,系统调用错误
-2,可调用次数或金额为0
-3,读取超时
-4,服务端返回数据解析错误
-5,后端服务器DNS解析错误
-6,服务不存在或未上线
-7, API创建者的网关资源不足
-1000,系统维护
-1002,showapi_appid字段必传
-1003,showapi_sign字段必传
-1004,签名sign验证有误
-1005,showapi_timestamp无效
-1006,app无权限调用接口
-1007,没有订购套餐
-1008,服务商关闭对您的调用权限
-1009,调用频率受限
-1010,找不到您的应用
-1011,子授权app_child_id无效
-1012,子授权已过期或失效
-1013,子授权ip受限
-1014,token权限无效
showapi_res_error String 用户输入有误! 错误信息的展示
showapi_res_id String ce135f6739294c63be0c021b76b6fbff 本次请求id
...
2、应用级参数(系统级输出参数showapi_res_body字段中的json数据结构): 展开收起
名称 类型 示例值 描述
...
返回示例:

人员库-修改人员描述信息


接口地址:http://route.showapi.com/1948-19 (注意:接口支持https,更安全,但稍慢一些,你懂的。请根据自己的情况进行选择。)
支持格式:json
请求方法:HTTP协议,支持GET/POST方法。

二、请求参数/ Request parameter

非文件上传的POST时,enctype=application/x-www-form-urlencoded。
文件上传的POST时,enctype=multipart/form-data。

1、系统级参数(所有接入点都需要的参数):
参数名称 类型 示例值 必须 描述
showapi_appid String 100 易源应用id
showapi_sign String 698d51a19d8a121ce581499d7b701668 为了验证用户身份,以及确保参数不被中间人篡改,需要传递调用者的数字签名。 可选,在url后带上appid和secret即可
showapi_timestamp String 20141114142239 客户端时间。
格式yyyyMMddHHmmss,如20141114142239
为了在一定程度上防止“重放攻击”,平台只接受在10分钟之内的请求。如果不传或传空串,则系统不再做此字段的检测。
showapi_res_gzip String 1或0 返回值是否用gzip方式压缩。此值为1时将压缩,其他值不压缩。
...
2、应用级参数(每个接入点有自己的参数,当前接入点的参数见下表): 展开收起
参数名称 类型 默认值 示例值 必须 描述
GroupId String
TencentShenZhenEmployee
人员库ID
PersonId String
200
人员ID
PersonExDescriptionInfos List
[{"PersonExDescriptionIndex":1,"PersonExDescription":"修改后测试描述"}]
需要修改的人员描述字段内容,key-value PersonExDescriptionIndex(参数类型为Integer):人员库自定义描述字段Index,从0开始 PersonExDescription(参数类型为String):需要更新的人员库自定义描述字段内容 例子 [{ PersonExDescriptionIndex:1, PersonExDescription:"修改后测试描述" }]
...
请求示例:String res=new ShowApiRequest("http://route.showapi.com/1948-19","my_appId","my_appSecret") .addTextPara("GroupId","TencentShenZhenEmployee") .addTextPara("PersonId","200") .addTextPara("PersonExDescriptionInfos","[{\"PersonExDescriptionIndex\":1,\"PersonExDescription\":\"修改后测试描述\"}]") .post(); System.out.println(res);

三、返回参数/ Return parameter

以JSON格式返回结果。

1、系统级参数(所有接入点都会返回的参数): 展开收起
名称 类型 示例值 描述
showapi_res_body String {"city":"昆明","prov":"云南"} 消息体的JSON封装,所有应用级的返回参数将嵌入此对象 。
showapi_res_code int 0
易源返回标志,0为成功,其他为失败。
0成功
-1,系统调用错误
-2,可调用次数或金额为0
-3,读取超时
-4,服务端返回数据解析错误
-5,后端服务器DNS解析错误
-6,服务不存在或未上线
-7, API创建者的网关资源不足
-1000,系统维护
-1002,showapi_appid字段必传
-1003,showapi_sign字段必传
-1004,签名sign验证有误
-1005,showapi_timestamp无效
-1006,app无权限调用接口
-1007,没有订购套餐
-1008,服务商关闭对您的调用权限
-1009,调用频率受限
-1010,找不到您的应用
-1011,子授权app_child_id无效
-1012,子授权已过期或失效
-1013,子授权ip受限
-1014,token权限无效
showapi_res_error String 用户输入有误! 错误信息的展示
showapi_res_id String ce135f6739294c63be0c021b76b6fbff 本次请求id
...
2、应用级参数(系统级输出参数showapi_res_body字段中的json数据结构): 展开收起
名称 类型 示例值 描述
Response Object
RequestId String
47dfe0df-bc2a-4288-8c20-2ec08da3f297
唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
remark String
查询成功!
ret_code Number
0
...
返回示例:{ "showapi_res_error": "", "showapi_res_id": "cb072a958e134d99accce0f6f1bc9853", "showapi_res_code": 0, "showapi_res_body": { "Response": { "RequestId": "47dfe0df-bc2a-4288-8c20-2ec08da3f297" }, "remark": "查询成功!", "ret_code": 0 } }

人员库-修改人员基础信息


接口地址:http://route.showapi.com/1948-18 (注意:接口支持https,更安全,但稍慢一些,你懂的。请根据自己的情况进行选择。)
支持格式:json
请求方法:HTTP协议,支持GET/POST方法。

二、请求参数/ Request parameter

非文件上传的POST时,enctype=application/x-www-form-urlencoded。
文件上传的POST时,enctype=multipart/form-data。

1、系统级参数(所有接入点都需要的参数):
参数名称 类型 示例值 必须 描述
showapi_appid String 100 易源应用id
showapi_sign String 698d51a19d8a121ce581499d7b701668 为了验证用户身份,以及确保参数不被中间人篡改,需要传递调用者的数字签名。 可选,在url后带上appid和secret即可
showapi_timestamp String 20141114142239 客户端时间。
格式yyyyMMddHHmmss,如20141114142239
为了在一定程度上防止“重放攻击”,平台只接受在10分钟之内的请求。如果不传或传空串,则系统不再做此字段的检测。
showapi_res_gzip String 1或0 返回值是否用gzip方式压缩。此值为1时将压缩,其他值不压缩。
...
2、应用级参数(每个接入点有自己的参数,当前接入点的参数见下表): 展开收起
参数名称 类型 默认值 示例值 必须 描述
PersonId String
1002
人员ID
PersonName String
test1
需要修改的人员名称
Gender Number
2
需要修改的人员性别,0代表未填写,1代表男性,2代表女性。
...
请求示例:String res=new ShowApiRequest("http://route.showapi.com/1948-18","my_appId","my_appSecret") .addTextPara("PersonId","1002") .addTextPara("PersonName","test1") .addTextPara("Gender","2") .post(); System.out.println(res);

三、返回参数/ Return parameter

以JSON格式返回结果。

1、系统级参数(所有接入点都会返回的参数): 展开收起
名称 类型 示例值 描述
showapi_res_body String {"city":"昆明","prov":"云南"} 消息体的JSON封装,所有应用级的返回参数将嵌入此对象 。
showapi_res_code int 0
易源返回标志,0为成功,其他为失败。
0成功
-1,系统调用错误
-2,可调用次数或金额为0
-3,读取超时
-4,服务端返回数据解析错误
-5,后端服务器DNS解析错误
-6,服务不存在或未上线
-7, API创建者的网关资源不足
-1000,系统维护
-1002,showapi_appid字段必传
-1003,showapi_sign字段必传
-1004,签名sign验证有误
-1005,showapi_timestamp无效
-1006,app无权限调用接口
-1007,没有订购套餐
-1008,服务商关闭对您的调用权限
-1009,调用频率受限
-1010,找不到您的应用
-1011,子授权app_child_id无效
-1012,子授权已过期或失效
-1013,子授权ip受限
-1014,token权限无效
showapi_res_error String 用户输入有误! 错误信息的展示
showapi_res_id String ce135f6739294c63be0c021b76b6fbff 本次请求id
...
2、应用级参数(系统级输出参数showapi_res_body字段中的json数据结构): 展开收起
名称 类型 示例值 描述
Response Object
RequestId String
425ef6a9-818a-458b-93c6-1db4c23cd977
唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
remark String
查询成功!
ret_code Number
0
...
返回示例:{ "showapi_res_error": "", "showapi_res_id": "b846ae0826904e2d8c7eb7b38b504ef1", "showapi_res_code": 0, "showapi_res_body": { "Response": { "RequestId": "425ef6a9-818a-458b-93c6-1db4c23cd977" }, "remark": "查询成功!", "ret_code": 0 } }

人员库-增加人脸


接口地址:http://route.showapi.com/1948-20 (注意:接口支持https,更安全,但稍慢一些,你懂的。请根据自己的情况进行选择。)
支持格式:json
请求方法:HTTP协议,支持GET/POST方法。

二、请求参数/ Request parameter

非文件上传的POST时,enctype=application/x-www-form-urlencoded。
文件上传的POST时,enctype=multipart/form-data。

1、系统级参数(所有接入点都需要的参数):
参数名称 类型 示例值 必须 描述
showapi_appid String 100 易源应用id
showapi_sign String 698d51a19d8a121ce581499d7b701668 为了验证用户身份,以及确保参数不被中间人篡改,需要传递调用者的数字签名。 可选,在url后带上appid和secret即可
showapi_timestamp String 20141114142239 客户端时间。
格式yyyyMMddHHmmss,如20141114142239
为了在一定程度上防止“重放攻击”,平台只接受在10分钟之内的请求。如果不传或传空串,则系统不再做此字段的检测。
showapi_res_gzip String 1或0 返回值是否用gzip方式压缩。此值为1时将压缩,其他值不压缩。
...
2、应用级参数(每个接入点有自己的参数,当前接入点的参数见下表): 展开收起
参数名称 类型 默认值 示例值 必须 描述
PersonId String
1002
人员ID。
Image String
/9j/4AAQSkZJRgABAQEAAQABAAD/2wBDAAEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQH/2wBDAQEBAQEB………………………………s8On6VYtLavb2MXh/wzptpNpTsi2Ut8ZPNcq0U/xuFlLFZhjsRytVqFWlCjW3UIThDmiov3Jb2vKLem9z2sbVpYbC4TBPSnWpVJ14czvOanJxfNfmjZW0i0vI//2Q==
图片 base64 数据。人员人脸总数量 不可超过5张。 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
Url String
https://showapi.oss-cn-hangzhou.aliyuncs.com/modleapi/lzh/2.jpg
图片的 Url、Image必须提供一个,如果都提供,只使用 Url。 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。 非腾讯云存储的Url速度和稳定性可能受一定影响。 人员人脸总数量不可超过5张。 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。 例子: ["https://i04picsos.sogoucdn.com/61dc50b36b99ced8","https://i02picsos.sogoucdn.com/ccc3eba7fe35273d"]
...
请求示例:String res=new ShowApiRequest("http://route.showapi.com/1948-20","my_appId","my_appSecret") .addTextPara("PersonId","1002") .addTextPara("Image","/9j/4AAQSkZJRgABAQEAAQABAAD/2wBDAAEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQH/2wBDAQEBAQEB………………………………s8On6VYtLavb2MXh/wzptpNpTsi2Ut8ZPNcq0U/xuFlLFZhjsRytVqFWlCjW3UIThDmiov3Jb2vKLem9z2sbVpYbC4TBPSnWpVJ14czvOanJxfNfmjZW0i0vI//2Q==") .addTextPara("Url","https://showapi.oss-cn-hangzhou.aliyuncs.com/modleapi/lzh/2.jpg") .post(); System.out.println(res);

三、返回参数/ Return parameter

以JSON格式返回结果。

1、系统级参数(所有接入点都会返回的参数): 展开收起
名称 类型 示例值 描述
showapi_res_body String {"city":"昆明","prov":"云南"} 消息体的JSON封装,所有应用级的返回参数将嵌入此对象 。
showapi_res_code int 0
易源返回标志,0为成功,其他为失败。
0成功
-1,系统调用错误
-2,可调用次数或金额为0
-3,读取超时
-4,服务端返回数据解析错误
-5,后端服务器DNS解析错误
-6,服务不存在或未上线
-7, API创建者的网关资源不足
-1000,系统维护
-1002,showapi_appid字段必传
-1003,showapi_sign字段必传
-1004,签名sign验证有误
-1005,showapi_timestamp无效
-1006,app无权限调用接口
-1007,没有订购套餐
-1008,服务商关闭对您的调用权限
-1009,调用频率受限
-1010,找不到您的应用
-1011,子授权app_child_id无效
-1012,子授权已过期或失效
-1013,子授权ip受限
-1014,token权限无效
showapi_res_error String 用户输入有误! 错误信息的展示
showapi_res_id String ce135f6739294c63be0c021b76b6fbff 本次请求id
...
2、应用级参数(系统级输出参数showapi_res_body字段中的json数据结构): 展开收起
名称 类型 示例值 描述
Response Object
RequestId String
e6e29bb9-ef0e-4e66-aac9-d03d55833537
唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RetCode String[]
[0]
每张人脸图片添加结果,-1101 代表未检测到人脸,-1102 代表图片解码失败,其他非 0 值代表算法服务异常。
SucFaceIds String[]
["3198435889016520046"]
加入成功的人脸ID列表
SucFaceNum Number
1
加入成功的人脸数量
remark String
查询成功!
ret_code Number
0
...
返回示例:{ "showapi_res_error": "", "showapi_res_id": "49ddd5bbd7d94d72ab8aff932da4bb9c", "showapi_res_code": 0, "showapi_res_body": { "Response": { "RequestId": "e6e29bb9-ef0e-4e66-aac9-d03d55833537", "RetCode": [ 0 ], "SucFaceIds": [ "3198435889016520046" ], "SucFaceNum": 1 }, "remark": "查询成功!", "ret_code": 0 } }

人员库-删除人脸


接口地址:http://route.showapi.com/1948-21 (注意:接口支持https,更安全,但稍慢一些,你懂的。请根据自己的情况进行选择。)
支持格式:json
请求方法:HTTP协议,支持GET/POST方法。

二、请求参数/ Request parameter

非文件上传的POST时,enctype=application/x-www-form-urlencoded。
文件上传的POST时,enctype=multipart/form-data。

1、系统级参数(所有接入点都需要的参数):
参数名称 类型 示例值 必须 描述
showapi_appid String 100 易源应用id
showapi_sign String 698d51a19d8a121ce581499d7b701668 为了验证用户身份,以及确保参数不被中间人篡改,需要传递调用者的数字签名。 可选,在url后带上appid和secret即可
showapi_timestamp String 20141114142239 客户端时间。
格式yyyyMMddHHmmss,如20141114142239
为了在一定程度上防止“重放攻击”,平台只接受在10分钟之内的请求。如果不传或传空串,则系统不再做此字段的检测。
showapi_res_gzip String 1或0 返回值是否用gzip方式压缩。此值为1时将压缩,其他值不压缩。
...
2、应用级参数(每个接入点有自己的参数,当前接入点的参数见下表):
参数名称 类型 默认值 示例值 必须 描述
PersonId String
1002
人员ID
FaceId String
46456444
待删除的人脸ID 注意: 最大支持删除5张 例子: ["46456444","464343434","467494"]
请求示例:String res=new ShowApiRequest("http://route.showapi.com/1948-21","my_appId","my_appSecret") .addTextPara("PersonId","1002") .addTextPara("FaceId","46456444") .post(); System.out.println(res);

三、返回参数/ Return parameter

以JSON格式返回结果。

1、系统级参数(所有接入点都会返回的参数): 展开收起
名称 类型 示例值 描述
showapi_res_body String {"city":"昆明","prov":"云南"} 消息体的JSON封装,所有应用级的返回参数将嵌入此对象 。
showapi_res_code int 0
易源返回标志,0为成功,其他为失败。
0成功
-1,系统调用错误
-2,可调用次数或金额为0
-3,读取超时
-4,服务端返回数据解析错误
-5,后端服务器DNS解析错误
-6,服务不存在或未上线
-7, API创建者的网关资源不足
-1000,系统维护
-1002,showapi_appid字段必传
-1003,showapi_sign字段必传
-1004,签名sign验证有误
-1005,showapi_timestamp无效
-1006,app无权限调用接口
-1007,没有订购套餐
-1008,服务商关闭对您的调用权限
-1009,调用频率受限
-1010,找不到您的应用
-1011,子授权app_child_id无效
-1012,子授权已过期或失效
-1013,子授权ip受限
-1014,token权限无效
showapi_res_error String 用户输入有误! 错误信息的展示
showapi_res_id String ce135f6739294c63be0c021b76b6fbff 本次请求id
...
2、应用级参数(系统级输出参数showapi_res_body字段中的json数据结构): 展开收起
名称 类型 示例值 描述
Response Object
RequestId String
340236ad-9856-4c64-9f99-6d094121bf41
唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
SucDeletedNum Number
1
删除成功的人脸数量
SucFaceIds String[]
["3198393359204923699"]
删除成功的人脸ID列表
remark String
查询成功!
ret_code Number
0
...
返回示例:{ "showapi_res_error": "", "showapi_res_id": "c2674d45ab2448b08a235d11fde41e67", "showapi_res_code": 0, "showapi_res_body": { "Response": { "RequestId": "340236ad-9856-4c64-9f99-6d094121bf41", "SucDeletedNum": 1, "SucFaceIds": [ "3198393359204923699" ] }, "remark": "查询成功!", "ret_code": 0 } }

基于人员库-人脸搜索


接口地址:http://route.showapi.com/1948-4 (注意:接口支持https,更安全,但稍慢一些,你懂的。请根据自己的情况进行选择。)
支持格式:json
请求方法:HTTP协议,支持GET/POST方法。

二、请求参数/ Request parameter

非文件上传的POST时,enctype=application/x-www-form-urlencoded。
文件上传的POST时,enctype=multipart/form-data。

1、系统级参数(所有接入点都需要的参数):
参数名称 类型 示例值 必须 描述
showapi_appid String 100 易源应用id
showapi_sign String 698d51a19d8a121ce581499d7b701668 为了验证用户身份,以及确保参数不被中间人篡改,需要传递调用者的数字签名。 可选,在url后带上appid和secret即可
showapi_timestamp String 20141114142239 客户端时间。
格式yyyyMMddHHmmss,如20141114142239
为了在一定程度上防止“重放攻击”,平台只接受在10分钟之内的请求。如果不传或传空串,则系统不再做此字段的检测。
showapi_res_gzip String 1或0 返回值是否用gzip方式压缩。此值为1时将压缩,其他值不压缩。
...
2、应用级参数(每个接入点有自己的参数,当前接入点的参数见下表): 展开收起
参数名称 类型 默认值 示例值 必须 描述
GroupIds List
["2"]
希望搜索的人员库列表,上限100个。
Image String
/9j/4AAQSkZJRgABAQEAAQABAAD/2wBDAAEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQH/2wBDAQEBAQEB………………………………s8On6VYtLavb2MXh/wzptpNpTsi2Ut8ZPNcq0U/xuFlLFZhjsRytVqFWlCjW3UIThDmiov3Jb2vKLem9z2sbVpYbC4TBPSnWpVJ14czvOanJxfNfmjZW0i0vI//2Q==
图片 base64 数据。支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
Url String
https://showapi.oss-cn-hangzhou.aliyuncs.com/modleapi/lzh/2.jpg
图片的 Url、Image必须提供一个,如果都提供,只使用 Url。 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。 非腾讯云存储的Url速度和稳定性可能受一定影响。 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
MaxFaceNum Number
最多处理的人脸数目。默认值为1(仅检测图片中面积最大的那张人脸),最大值为10。 MaxFaceNum用于,当待识别图片包含多张人脸时,要搜索的人脸数量。 当 MaxFaceNum 不为1时,设MaxFaceNum=M,则实际上是 M:N 的人脸搜索(N为待搜索的人脸数)。
MinFaceSize Number
人脸长和宽的最小尺寸,单位为像素。默认为80。低于40将影响搜索精度。建议设置为80。
MaxPersonNum Number
被检测到的人脸,对应最多返回的最相似人员数目。默认值为5,最大值为10。 例,设MaxFaceNum为3,MaxPersonNum为5,则最多可能返回3*5=15个人员。
...
请求示例:String res=new ShowApiRequest("http://route.showapi.com/1948-4","my_appId","my_appSecret") .addTextPara("GroupIds","[\"2\"]") .addTextPara("Image","/9j/4AAQSkZJRgABAQEAAQABAAD/2wBDAAEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQH/2wBDAQEBAQEB………………………………s8On6VYtLavb2MXh/wzptpNpTsi2Ut8ZPNcq0U/xuFlLFZhjsRytVqFWlCjW3UIThDmiov3Jb2vKLem9z2sbVpYbC4TBPSnWpVJ14czvOanJxfNfmjZW0i0vI//2Q==") .addTextPara("Url","https://showapi.oss-cn-hangzhou.aliyuncs.com/modleapi/lzh/2.jpg") .addTextPara("MaxFaceNum","") .addTextPara("MinFaceSize","") .addTextPara("MaxPersonNum","") .post(); System.out.println(res);

三、返回参数/ Return parameter

以JSON格式返回结果。

1、系统级参数(所有接入点都会返回的参数): 展开收起
名称 类型 示例值 描述
showapi_res_body String {"city":"昆明","prov":"云南"} 消息体的JSON封装,所有应用级的返回参数将嵌入此对象 。
showapi_res_code int 0
易源返回标志,0为成功,其他为失败。
0成功
-1,系统调用错误
-2,可调用次数或金额为0
-3,读取超时
-4,服务端返回数据解析错误
-5,后端服务器DNS解析错误
-6,服务不存在或未上线
-7, API创建者的网关资源不足
-1000,系统维护
-1002,showapi_appid字段必传
-1003,showapi_sign字段必传
-1004,签名sign验证有误
-1005,showapi_timestamp无效
-1006,app无权限调用接口
-1007,没有订购套餐
-1008,服务商关闭对您的调用权限
-1009,调用频率受限
-1010,找不到您的应用
-1011,子授权app_child_id无效
-1012,子授权已过期或失效
-1013,子授权ip受限
-1014,token权限无效
showapi_res_error String 用户输入有误! 错误信息的展示
showapi_res_id String ce135f6739294c63be0c021b76b6fbff 本次请求id
...
2、应用级参数(系统级输出参数showapi_res_body字段中的json数据结构): 展开收起
名称 类型 示例值 描述
Response Object
Results Object[]
识别结果。
0 Object
Candidates Object[]
识别出的最相似候选人
0 Object
PersonId String
1001
人员ID
FaceId String
2875093635484912302
人脸ID
Score Number
100
候选者的匹配得分。 10万大小人脸库,若人脸均为类似抓拍照(人脸质量较差), 误识率百分之一对应分数为70分,误识率千分之一对应分数为80分,误识率万分之一对应分数为90分; 若人脸均为类似自拍照(人脸质量较好), 误识率百分之一对应分数为60分,误识率千分之一对应分数为70分,误识率万分之一对应分数为80分。 建议分数不要超过90分。您可以根据实际情况选择合适的分数。
FaceRect Object
检测出的人脸框位置
X Number
370
人脸框左上角横坐标。 人脸框包含人脸五官位置并在此基础上进行一定的扩展,若人脸框超出图片范围,会导致坐标负值。 若需截取完整人脸,可以在完整分completess满足需求的情况下,将负值坐标取0。
Y Number
46
人脸框左上角纵坐标。 人脸框包含人脸五官位置并在此基础上进行一定的扩展,若人脸框超出图片范围,会导致坐标负值。 若需截取完整人脸,可以在完整分completess满足需求的情况下,将负值坐标取0。
Width Number
75
人脸宽度
Height Number
75
人脸高度
FaceNum Number
1
搜索的人员库中包含的人脸数。
RequestId String
57b42b73-b978-45b9-8095-8f50e9642d35
唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
remark String
查询成功!
ret_code Number
0
...
返回示例:{ "showapi_res_error":"", "showapi_res_id":"c4d640dc5d764912be54bd477e2f6fca", "showapi_res_code":0, "showapi_res_body":{ "Response":{ "Results":[ { "Candidates":[ { "PersonId":"1001", "FaceId":"2875093635484912302", "Score":100 } ], "FaceRect":{ "X":370, "Y":46, "Width":75, "Height":75 } } ], "FaceNum":1, "RequestId":"57b42b73-b978-45b9-8095-8f50e9642d35" }, "remark":"查询成功!", "ret_code":0 } }

基于人员库-人脸验证


接口地址:http://route.showapi.com/1948-5 (注意:接口支持https,更安全,但稍慢一些,你懂的。请根据自己的情况进行选择。)
支持格式:json
请求方法:HTTP协议,支持GET/POST方法。

二、请求参数/ Request parameter

非文件上传的POST时,enctype=application/x-www-form-urlencoded。
文件上传的POST时,enctype=multipart/form-data。

1、系统级参数(所有接入点都需要的参数):
参数名称 类型 示例值 必须 描述
showapi_appid String 100 易源应用id
showapi_sign String 698d51a19d8a121ce581499d7b701668 为了验证用户身份,以及确保参数不被中间人篡改,需要传递调用者的数字签名。 可选,在url后带上appid和secret即可
showapi_timestamp String 20141114142239 客户端时间。
格式yyyyMMddHHmmss,如20141114142239
为了在一定程度上防止“重放攻击”,平台只接受在10分钟之内的请求。如果不传或传空串,则系统不再做此字段的检测。
showapi_res_gzip String 1或0 返回值是否用gzip方式压缩。此值为1时将压缩,其他值不压缩。
...
2、应用级参数(每个接入点有自己的参数,当前接入点的参数见下表): 展开收起
参数名称 类型 默认值 示例值 必须 描述
PersonId String
1002
待验证的人员ID。人员ID具体信息请参考人员库管理相关接口。
Image String
/9j/4AAQSkZJRgABAQEAAQABAAD/2wBDAAEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQH/2wBDAQEBAQEB………………………………s8On6VYtLavb2MXh/wzptpNpTsi2Ut8ZPNcq0U/xuFlLFZhjsRytVqFWlCjW3UIThDmiov3Jb2vKLem9z2sbVpYbC4TBPSnWpVJ14czvOanJxfNfmjZW0i0vI//2Q==
图片 base64 数据。 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
Url String
https://showapi.oss-cn-hangzhou.aliyuncs.com/modleapi/lzh/2.jpg
图片的 Url 。 图片的 Url、Image必须提供一个,如果都提供,只使用 Url。 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。 非腾讯云存储的Url速度和稳定性可能受一定影响。 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
...
请求示例:String res=new ShowApiRequest("http://route.showapi.com/1948-5","my_appId","my_appSecret") .addTextPara("PersonId","1002") .addTextPara("Image","/9j/4AAQSkZJRgABAQEAAQABAAD/2wBDAAEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQH/2wBDAQEBAQEB………………………………s8On6VYtLavb2MXh/wzptpNpTsi2Ut8ZPNcq0U/xuFlLFZhjsRytVqFWlCjW3UIThDmiov3Jb2vKLem9z2sbVpYbC4TBPSnWpVJ14czvOanJxfNfmjZW0i0vI//2Q==") .addTextPara("Url","https://showapi.oss-cn-hangzhou.aliyuncs.com/modleapi/lzh/2.jpg") .post(); System.out.println(res);

三、返回参数/ Return parameter

以JSON格式返回结果。

1、系统级参数(所有接入点都会返回的参数): 展开收起
名称 类型 示例值 描述
showapi_res_body String {"city":"昆明","prov":"云南"} 消息体的JSON封装,所有应用级的返回参数将嵌入此对象 。
showapi_res_code int 0
易源返回标志,0为成功,其他为失败。
0成功
-1,系统调用错误
-2,可调用次数或金额为0
-3,读取超时
-4,服务端返回数据解析错误
-5,后端服务器DNS解析错误
-6,服务不存在或未上线
-7, API创建者的网关资源不足
-1000,系统维护
-1002,showapi_appid字段必传
-1003,showapi_sign字段必传
-1004,签名sign验证有误
-1005,showapi_timestamp无效
-1006,app无权限调用接口
-1007,没有订购套餐
-1008,服务商关闭对您的调用权限
-1009,调用频率受限
-1010,找不到您的应用
-1011,子授权app_child_id无效
-1012,子授权已过期或失效
-1013,子授权ip受限
-1014,token权限无效
showapi_res_error String 用户输入有误! 错误信息的展示
showapi_res_id String ce135f6739294c63be0c021b76b6fbff 本次请求id
...
2、应用级参数(系统级输出参数showapi_res_body字段中的json数据结构): 展开收起
名称 类型 示例值 描述
Response Object
Score Number
1
给定的人脸图片与 PersonId 对应人脸的相似度。若 PersonId 下有多张人脸(Face),返回相似度最大的分数。
IsMatch Boolean[]
是否为同一人的判断。
RequestId String
a8eb4545-a154-4f86-9510-57a8be9cae0c
唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
remark String
调用成功!
ret_code Number
0
...
返回示例:{ "showapi_res_error":"", "showapi_res_id":"2f13053300a94a278beaa5e67b3ee771", "showapi_res_code":0, "showapi_res_body":{ "Response":{ "Score":0.999, "IsMatch":true, "RequestId":"a8eb4545-a154-4f86-9510-57a8be9cae0c" }, "remark":"调用成功!", "ret_code":0 } }

人脸检测与分析


接口地址:http://route.showapi.com/1948-1 (注意:接口支持https,更安全,但稍慢一些,你懂的。请根据自己的情况进行选择。)
支持格式:json
请求方法:HTTP协议,支持GET/POST方法。

二、请求参数/ Request parameter

非文件上传的POST时,enctype=application/x-www-form-urlencoded。
文件上传的POST时,enctype=multipart/form-data。

1、系统级参数(所有接入点都需要的参数):
参数名称 类型 示例值 必须 描述
showapi_appid String 100 易源应用id
showapi_sign String 698d51a19d8a121ce581499d7b701668 为了验证用户身份,以及确保参数不被中间人篡改,需要传递调用者的数字签名。 可选,在url后带上appid和secret即可
showapi_timestamp String 20141114142239 客户端时间。
格式yyyyMMddHHmmss,如20141114142239
为了在一定程度上防止“重放攻击”,平台只接受在10分钟之内的请求。如果不传或传空串,则系统不再做此字段的检测。
showapi_res_gzip String 1或0 返回值是否用gzip方式压缩。此值为1时将压缩,其他值不压缩。
...
2、应用级参数(每个接入点有自己的参数,当前接入点的参数见下表):
参数名称 类型 默认值 示例值 必须 描述
Image String
/9j/4AAQSkZJRgABAQEAAQABAAD/2wBDAAEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQH/2wBDAQEBAQEB………………………………s8On6VYtLavb2MXh/wzptpNpTsi2Ut8ZPNcq0U/xuFlLFZhjsRytVqFWlCjW3UIThDmiov3Jb2vKLem9z2sbVpYbC4TBPSnWpVJ14czvOanJxfNfmjZW0i0vI//2Q==
图片 base64 数据。支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
Url String
https://showapi.oss-cn-hangzhou.aliyuncs.com/modleapi/lzh/2.jpg
图片的 Url、Image必须提供一个,如果都提供,只使用 Url。 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。 非腾讯云存储的Url速度和稳定性可能受一定影响。 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
请求示例:String res=new ShowApiRequest("http://route.showapi.com/1948-1","my_appId","my_appSecret") .addTextPara("Image","/9j/4AAQSkZJRgABAQEAAQABAAD/2wBDAAEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQH/2wBDAQEBAQEB………………………………s8On6VYtLavb2MXh/wzptpNpTsi2Ut8ZPNcq0U/xuFlLFZhjsRytVqFWlCjW3UIThDmiov3Jb2vKLem9z2sbVpYbC4TBPSnWpVJ14czvOanJxfNfmjZW0i0vI//2Q==") .addTextPara("Url","https://showapi.oss-cn-hangzhou.aliyuncs.com/modleapi/lzh/2.jpg") .post(); System.out.println(res);

三、返回参数/ Return parameter

以JSON格式返回结果。

1、系统级参数(所有接入点都会返回的参数): 展开收起
名称 类型 示例值 描述
showapi_res_body String {"city":"昆明","prov":"云南"} 消息体的JSON封装,所有应用级的返回参数将嵌入此对象 。
showapi_res_code int 0
易源返回标志,0为成功,其他为失败。
0成功
-1,系统调用错误
-2,可调用次数或金额为0
-3,读取超时
-4,服务端返回数据解析错误
-5,后端服务器DNS解析错误
-6,服务不存在或未上线
-7, API创建者的网关资源不足
-1000,系统维护
-1002,showapi_appid字段必传
-1003,showapi_sign字段必传
-1004,签名sign验证有误
-1005,showapi_timestamp无效
-1006,app无权限调用接口
-1007,没有订购套餐
-1008,服务商关闭对您的调用权限
-1009,调用频率受限
-1010,找不到您的应用
-1011,子授权app_child_id无效
-1012,子授权已过期或失效
-1013,子授权ip受限
-1014,token权限无效
showapi_res_error String 用户输入有误! 错误信息的展示
showapi_res_id String ce135f6739294c63be0c021b76b6fbff 本次请求id
...
2、应用级参数(系统级输出参数showapi_res_body字段中的json数据结构): 展开收起
名称 类型 示例值 描述
Response Object
FaceInfos Object[]
人脸信息列表。
0 Object
FaceAttributesInfo Object
人脸属性信息,包含性别( gender )、年龄( age )、表情( expression )、 魅力( beauty )、眼镜( glass )、口罩(mask)、头发(hair)和姿态 (pitch,roll,yaw )。只有当 NeedFaceAttributes 设为 1 时才返回有效信息。
Age Number
0
年龄 [0~100]。NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
Beauty Number
0
魅力[0~100]。NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
Expression Number
0
微笑[0(normal,正常)~50(smile,微笑)~100(laugh,大笑)]。NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
EyeOpen Object
双眼是否睁开 [true,false]。只要有超过一只眼睛闭眼,就返回false。 NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。 注意:此字段可能返回 null,表示取不到有效值。
Gender Number
0
性别 [0(female,女性)~100(male,男性)]。 NeedFaceAttributes 不为 1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
Glass Object
是否有眼镜 [true,false]。NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
Hair Object
头发信息,包含头发长度(length)、有无刘海(bang)、头发颜色(color)。NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。 注意:此字段可能返回 null,表示取不到有效值。
Bang Number
0
0:有刘海,1:无刘海 注意:此字段可能返回 null,表示取不到有效值。
Color Number
0
0:黑色,1:金色,2:棕色,3:灰白色 注意:此字段可能返回 null,表示取不到有效值。
Length Number
0
0:光头,1:短发,2:中发,3:长发,4:绑发 注意:此字段可能返回 null,表示取不到有效值。
Hat Object
是否有帽子 [true,false]。NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。 注意:此字段可能返回 null,表示取不到有效值。
Mask Object
是否有口罩 [true,false]。NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。 注意:此字段可能返回 null,表示取不到有效值。
Pitch Number
0
上下偏移[-30,30]。NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。 建议:人脸入库选择[-10,10]的图片。
Roll Number
0
平面旋转[-180,180]。 NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。 建议:人脸入库选择[-20,20]的图片。
Yaw Number
0
左右偏移[-30,30]。 NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。 建议:人脸入库选择[-10,10]的图片。
FaceQualityInfo Object
人脸质量信息,包含质量分(score)、模糊分(sharpness)、光照分(brightness)、遮挡分(completeness)。只有当NeedFaceDetection设为1时才返回有效信息。 注意:此字段可能返回 null,表示取不到有效值。
Brightness Number
0
光照分:[0,100],评价图片光照程度,分数越高越亮。 参考范围: [0,30]偏暗,[30,70]光照正常,[70,100]偏亮。 建议:人脸入库选取[30,70]的图片。 注意:此字段可能返回 null,表示取不到有效值。
Completeness Object
Cheek Number
0
脸颊的遮挡分数[0,100],分数越高遮挡越少。 参考范围:[0,70]表示发生遮挡。 注意:此字段可能返回 null,表示取不到有效值。
Chin Number
0
下巴的遮挡分数[0,100],分数越高遮挡越少。 参考范围:[0,70]表示发生遮挡。 注意:此字段可能返回 null,表示取不到有效值。
Eye Number
0
眼睛的遮挡分数[0,100],分数越高遮挡越少。 参考范围:[0,80]表示发生遮挡。 注意:此字段可能返回 null,表示取不到有效值。
Eyebrow Number
0
眉毛的遮挡分数[0,100],分数越高遮挡越少。 参考范围:[0,80]表示发生遮挡。 注意:此字段可能返回 null,表示取不到有效值。
Mouth Number
0
嘴巴的遮挡分数[0,100],分数越高遮挡越少。 参考范围:[0,50]表示发生遮挡。 注意:此字段可能返回 null,表示取不到有效值。
Nose Number
0
鼻子的遮挡分数[0,100],分数越高遮挡越少。 参考范围:[0,60]表示发生遮挡。 注意:此字段可能返回 null,表示取不到有效值。
Score Number
0
质量分: [0,100],综合评价图像质量是否适合人脸识别,分数越高质量越好。 参考范围:[0,40]较差,[40,60] 一般,[60,80]较好,[80,100]很好。 建议:人脸入库选取70以上的图片。 注意:此字段可能返回 null,表示取不到有效值。
Sharpness Number
0
清晰分:[0,100],评价图片清晰程度,分数越高越清晰。 参考范围:[0,40]特别模糊,[40,60]模糊,[60,80]一般,[80,100]清晰。 建议:人脸入库选取80以上的图片。 注意:此字段可能返回 null,表示取不到有效值。
Height Number
119
人脸框高度。
Width Number
119
人脸框宽度。
X Number
171
人脸框左上角横坐标。 人脸框包含人脸五官位置并在此基础上进行一定的扩展,若人脸框超出图片范围,会导致坐标负值。 若需截取完整人脸,可以在完整分completess满足需求的情况下,将负值坐标取0。
Y Number
15
人脸框左上角纵坐标。 人脸框包含人脸五官位置并在此基础上进行一定的扩展,若人脸框超出图片范围,会导致坐标负值。 若需截取完整人脸,可以在完整分completess满足需求的情况下,将负值坐标取0。
ImageHeight Number
218
请求的图片高度。
ImageWidth Number
328
请求的图片宽度。
RequestId String
7355e5d7-0f84-40a5-982d-025f6f97de00
唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
remark String
查询成功!
返回说明!
ret_code Number
0
返回标识。0为成功,其余为失败
...
返回示例:{ "showapi_res_error": "", "showapi_res_id": "8ded12739e01423ebb48aaf836a051fb", "showapi_res_code": 0, "showapi_res_body": { "Response": { "FaceInfos": [ { "FaceAttributesInfo": { "Age": 0, "Beauty": 0, "Expression": 0, "EyeOpen": false, "Gender": 0, "Glass": false, "Hair": { "Bang": 0, "Color": 0, "Length": 0 }, "Hat": false, "Mask": false, "Pitch": 0, "Roll": 0, "Yaw": 0 }, "FaceQualityInfo": { "Brightness": 0, "Completeness": { "Cheek": 0, "Chin": 0, "Eye": 0, "Eyebrow": 0, "Mouth": 0, "Nose": 0 }, "Score": 0, "Sharpness": 0 }, "Height": 119, "Width": 119, "X": 171, "Y": 15 } ], "ImageHeight": 218, "ImageWidth": 328, "RequestId": "7355e5d7-0f84-40a5-982d-025f6f97de00" }, "remark": "查询成功!", "ret_code": 0 } }

五官定位


接口地址:http://route.showapi.com/1948-2 (注意:接口支持https,更安全,但稍慢一些,你懂的。请根据自己的情况进行选择。)
支持格式:json
请求方法:HTTP协议,支持GET/POST方法。

二、请求参数/ Request parameter

非文件上传的POST时,enctype=application/x-www-form-urlencoded。
文件上传的POST时,enctype=multipart/form-data。

1、系统级参数(所有接入点都需要的参数):
参数名称 类型 示例值 必须 描述
showapi_appid String 100 易源应用id
showapi_sign String 698d51a19d8a121ce581499d7b701668 为了验证用户身份,以及确保参数不被中间人篡改,需要传递调用者的数字签名。 可选,在url后带上appid和secret即可
showapi_timestamp String 20141114142239 客户端时间。
格式yyyyMMddHHmmss,如20141114142239
为了在一定程度上防止“重放攻击”,平台只接受在10分钟之内的请求。如果不传或传空串,则系统不再做此字段的检测。
showapi_res_gzip String 1或0 返回值是否用gzip方式压缩。此值为1时将压缩,其他值不压缩。
...
2、应用级参数(每个接入点有自己的参数,当前接入点的参数见下表):
参数名称 类型 默认值 示例值 必须 描述
Image String
/9j/4AAQSkZJRgABAQEAAQABAAD/2wBDAAEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQH/2wBDAQEBAQEB………………………………s8On6VYtLavb2MXh/wzptpNpTsi2Ut8ZPNcq0U/xuFlLFZhjsRytVqFWlCjW3UIThDmiov3Jb2vKLem9z2sbVpYbC4TBPSnWpVJ14czvOanJxfNfmjZW0i0vI//2Q==
图片 base64 数据。支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
Url String
https://showapi.oss-cn-hangzhou.aliyuncs.com/modleapi/lzh/2.jpg
图片的 Url、Image必须提供一个,如果都提供,只使用 Url。 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。 非腾讯云存储的Url速度和稳定性可能受一定影响。 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
请求示例:String res=new ShowApiRequest("http://route.showapi.com/1948-2","my_appId","my_appSecret") .addTextPara("Image","/9j/4AAQSkZJRgABAQEAAQABAAD/2wBDAAEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQH/2wBDAQEBAQEB………………………………s8On6VYtLavb2MXh/wzptpNpTsi2Ut8ZPNcq0U/xuFlLFZhjsRytVqFWlCjW3UIThDmiov3Jb2vKLem9z2sbVpYbC4TBPSnWpVJ14czvOanJxfNfmjZW0i0vI//2Q==") .addTextPara("Url","https://showapi.oss-cn-hangzhou.aliyuncs.com/modleapi/lzh/2.jpg") .post(); System.out.println(res);

三、返回参数/ Return parameter

以JSON格式返回结果。

1、系统级参数(所有接入点都会返回的参数): 展开收起
名称 类型 示例值 描述
showapi_res_body String {"city":"昆明","prov":"云南"} 消息体的JSON封装,所有应用级的返回参数将嵌入此对象 。
showapi_res_code int 0
易源返回标志,0为成功,其他为失败。
0成功
-1,系统调用错误
-2,可调用次数或金额为0
-3,读取超时
-4,服务端返回数据解析错误
-5,后端服务器DNS解析错误
-6,服务不存在或未上线
-7, API创建者的网关资源不足
-1000,系统维护
-1002,showapi_appid字段必传
-1003,showapi_sign字段必传
-1004,签名sign验证有误
-1005,showapi_timestamp无效
-1006,app无权限调用接口
-1007,没有订购套餐
-1008,服务商关闭对您的调用权限
-1009,调用频率受限
-1010,找不到您的应用
-1011,子授权app_child_id无效
-1012,子授权已过期或失效
-1013,子授权ip受限
-1014,token权限无效
showapi_res_error String 用户输入有误! 错误信息的展示
showapi_res_id String ce135f6739294c63be0c021b76b6fbff 本次请求id
...
2、应用级参数(系统级输出参数showapi_res_body字段中的json数据结构): 展开收起
名称 类型 示例值 描述
Response Object
FaceShapeSet Object[]
五官定位(人脸关键点)具体信息。
0 Object
FaceProfile Object[]
描述脸型轮廓的 21 点。
0 Object
X Number
43
x坐标
Y Number
137
Y坐标
LeftEye Object[]
描述左侧眼睛轮廓的 8 点。
0 Object
X Number
66
Y Number
137
LeftEyeBrow Object[]
描述左侧眉毛轮廓的 8 点。
0 Object
X Number
55
Y Number
120
LeftPupil Object[]
左瞳孔轮廓的 1 个点。
0 Object
X Number
80
Y Number
137
Mouth Object[]
描述嘴巴轮廓的 22 点。
0 Object
X Number
92
Y Number
204
Nose Object[]
描述鼻子轮廓的 13 点。
0 Object
X Number
116
Y Number
178
RightEye Object[]
描述右侧眼睛轮廓的 8 点。
0 Object
X Number
156
Y Number
136
RightEyeBrow Object[]
描述右侧眉毛轮廓的 8 点。
0 Object
X Number
166
Y Number
120
RightPupil Object[]
右瞳孔轮廓的 1 个点。
0 Object
X Number
141
Y Number
137
ImageHeight Number
280
请求的图片高度。
ImageWidth Number
280
请求的图片宽度。
RequestId String
7992cc83-0ba7-4292-b47b-3afc39ee7553
唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
remark String
查询成功!
ret_code Number
0
...
返回示例:{ "showapi_res_error": "", "showapi_res_id": "8bfdd4e02a5046c094e9556182585b52", "showapi_res_code": 0, "showapi_res_body": { "Response": { "FaceShapeSet": [ { "FaceProfile": [ { "X": 43, "Y": 137 }, { "X": 176, "Y": 136 } ], "LeftEye": [ { "X": 66, "Y": 137 }, { "X": 72, "Y": 132 } ], "LeftEyeBrow": [ { "X": 55, "Y": 120 }, { "X": 65, "Y": 113 } ], "LeftPupil": [ { "X": 80, "Y": 137 } ], "Mouth": [ { "X": 92, "Y": 204 }, { "X": 99, "Y": 205 } ], "Nose": [ { "X": 116, "Y": 178 }, { "X": 119, "Y": 151 } ], "RightEye": [ { "X": 156, "Y": 136 }, { "X": 150, "Y": 131 } ], "RightEyeBrow": [ { "X": 166, "Y": 120 }, { "X": 157, "Y": 113 } ], "RightPupil": [ { "X": 141, "Y": 137 } ] } ], "ImageHeight": 280, "ImageWidth": 280, "RequestId": "7992cc83-0ba7-4292-b47b-3afc39ee7553" }, "remark": "查询成功!", "ret_code": 0 } }

人脸比对


接口地址:http://route.showapi.com/1948-3 (注意:接口支持https,更安全,但稍慢一些,你懂的。请根据自己的情况进行选择。)
支持格式:json
请求方法:HTTP协议,支持GET/POST方法。

二、请求参数/ Request parameter

非文件上传的POST时,enctype=application/x-www-form-urlencoded。
文件上传的POST时,enctype=multipart/form-data。

1、系统级参数(所有接入点都需要的参数):
参数名称 类型 示例值 必须 描述
showapi_appid String 100 易源应用id
showapi_sign String 698d51a19d8a121ce581499d7b701668 为了验证用户身份,以及确保参数不被中间人篡改,需要传递调用者的数字签名。 可选,在url后带上appid和secret即可
showapi_timestamp String 20141114142239 客户端时间。
格式yyyyMMddHHmmss,如20141114142239
为了在一定程度上防止“重放攻击”,平台只接受在10分钟之内的请求。如果不传或传空串,则系统不再做此字段的检测。
showapi_res_gzip String 1或0 返回值是否用gzip方式压缩。此值为1时将压缩,其他值不压缩。
...
2、应用级参数(每个接入点有自己的参数,当前接入点的参数见下表): 展开收起
参数名称 类型 默认值 示例值 必须 描述
ImageA String
/9j/4AAQSkZJRgABAQEAAQABAAD/2wBDAAEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQH/2wBDAQEBAQEB………………………………s8On6VYtLavb2MXh/wzptpNpTsi2Ut8ZPNcq0U/xuFlLFZhjsRytVqFWlCjW3UIThDmiov3Jb2vKLem9z2sbVpYbC4TBPSnWpVJ14czvOanJxfNfmjZW0i0vI//2Q==
A 图片 base64 数据。 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
ImageB String
/9j/4AAQSkZJRgABAQEAYABgAAD/4QAiRXhpZgAATU0AKgAAAAgAAQESAAMAAAABAAEAAAAAAAD/2……………………j3uf9z/Gvv6GOqYduMdV2Z+cYrK6OKXNPSXdfqfupqWqpeWMdxDIk1vMu6OWNt8cqnoVYcEe4rjf+Eir4/8A+CN3/Ima9/18H+dfTlfVYXEe1pKpa1z5HFYJUKsqV72P/9k=
B 图片 base64 数据。 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
UrlA String
https://showapi.oss-cn-hangzhou.aliyuncs.com/modleapi/lzh/2.jpg
A 图片的 Url 。A 图片的 Url、Image必须提供一个,如果都提供,只使用 Url。 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。 非腾讯云存储的Url速度和稳定性可能受一定影响。 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
UrlB String
https://showapi.oss-cn-hangzhou.aliyuncs.com/modleapi/lzh/3.jpg
B 图片的 Url 。B 图片的 Url、Image必须提供一个,如果都提供,只使用 Url。 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。 非腾讯云存储的Url速度和稳定性可能受一定影响。 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
...
请求示例:String res=new ShowApiRequest("http://route.showapi.com/1948-3","my_appId","my_appSecret") .addTextPara("ImageA","/9j/4AAQSkZJRgABAQEAAQABAAD/2wBDAAEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQH/2wBDAQEBAQEB………………………………s8On6VYtLavb2MXh/wzptpNpTsi2Ut8ZPNcq0U/xuFlLFZhjsRytVqFWlCjW3UIThDmiov3Jb2vKLem9z2sbVpYbC4TBPSnWpVJ14czvOanJxfNfmjZW0i0vI//2Q==") .addTextPara("ImageB","/9j/4AAQSkZJRgABAQEAYABgAAD/4QAiRXhpZgAATU0AKgAAAAgAAQESAAMAAAABAAEAAAAAAAD/2……………………j3uf9z/Gvv6GOqYduMdV2Z+cYrK6OKXNPSXdfqfupqWqpeWMdxDIk1vMu6OWNt8cqnoVYcEe4rjf+Eir4/8A+CN3/Ima9/18H+dfTlfVYXEe1pKpa1z5HFYJUKsqV72P/9k=") .addTextPara("UrlA","https://showapi.oss-cn-hangzhou.aliyuncs.com/modleapi/lzh/2.jpg") .addTextPara("UrlB","https://showapi.oss-cn-hangzhou.aliyuncs.com/modleapi/lzh/3.jpg") .post(); System.out.println(res);

三、返回参数/ Return parameter

以JSON格式返回结果。

1、系统级参数(所有接入点都会返回的参数): 展开收起
名称 类型 示例值 描述
showapi_res_body String {"city":"昆明","prov":"云南"} 消息体的JSON封装,所有应用级的返回参数将嵌入此对象 。
showapi_res_code int 0
易源返回标志,0为成功,其他为失败。
0成功
-1,系统调用错误
-2,可调用次数或金额为0
-3,读取超时
-4,服务端返回数据解析错误
-5,后端服务器DNS解析错误
-6,服务不存在或未上线
-7, API创建者的网关资源不足
-1000,系统维护
-1002,showapi_appid字段必传
-1003,showapi_sign字段必传
-1004,签名sign验证有误
-1005,showapi_timestamp无效
-1006,app无权限调用接口
-1007,没有订购套餐
-1008,服务商关闭对您的调用权限
-1009,调用频率受限
-1010,找不到您的应用
-1011,子授权app_child_id无效
-1012,子授权已过期或失效
-1013,子授权ip受限
-1014,token权限无效
showapi_res_error String 用户输入有误! 错误信息的展示
showapi_res_id String ce135f6739294c63be0c021b76b6fbff 本次请求id
...
2、应用级参数(系统级输出参数showapi_res_body字段中的json数据结构): 展开收起
名称 类型 示例值 描述
Response Object
RequestId String
59c60baf-30a0-4abf-93a5-d22bf59011d3
唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
Score Number
6
两张图片中人脸的相似度分数。 若需要验证两张图片中人脸是否为同一人,则误识率千分之一对应分数为70分,误识率万分之一对应分数为80分,误识率十万分之一对应分数为90分。 一般超过80分则可认定为同一人。 若需要验证两张图片中的人脸是否为同一人,建议使用人脸验证接口。
remark String
查询成功!
返回说明!
ret_code Number
0
返回标识,0为成功,其余为失败
...
返回示例:{ "showapi_res_error": "", "showapi_res_id": "0bac6e8d237f4f40bc3d073d3f137e39", "showapi_res_code": 0, "showapi_res_body": { "Response": { "RequestId": "59c60baf-30a0-4abf-93a5-d22bf59011d3", "Score": 6.072973251342773 }, "remark": "查询成功!", "ret_code": 0 } }

人脸静态活体检测


接口地址:http://route.showapi.com/1948-6 (注意:接口支持https,更安全,但稍慢一些,你懂的。请根据自己的情况进行选择。)
支持格式:json
请求方法:HTTP协议,支持GET/POST方法。

二、请求参数/ Request parameter

非文件上传的POST时,enctype=application/x-www-form-urlencoded。
文件上传的POST时,enctype=multipart/form-data。

1、系统级参数(所有接入点都需要的参数):
参数名称 类型 示例值 必须 描述
showapi_appid String 100 易源应用id
showapi_sign String 698d51a19d8a121ce581499d7b701668 为了验证用户身份,以及确保参数不被中间人篡改,需要传递调用者的数字签名。 可选,在url后带上appid和secret即可
showapi_timestamp String 20141114142239 客户端时间。
格式yyyyMMddHHmmss,如20141114142239
为了在一定程度上防止“重放攻击”,平台只接受在10分钟之内的请求。如果不传或传空串,则系统不再做此字段的检测。
showapi_res_gzip String 1或0 返回值是否用gzip方式压缩。此值为1时将压缩,其他值不压缩。
...
2、应用级参数(每个接入点有自己的参数,当前接入点的参数见下表):
参数名称 类型 默认值 示例值 必须 描述
Image String
/9j/4AAQSkZJRgABAQEAAQABAAD/2wBDAAEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQH/2wBDAQEBAQEB………………………………s8On6VYtLavb2MXh/wzptpNpTsi2Ut8ZPNcq0U/xuFlLFZhjsRytVqFWlCjW3UIThDmiov3Jb2vKLem9z2sbVpYbC4TBPSnWpVJ14czvOanJxfNfmjZW0i0vI//2Q==
图片 base64 数据(图片的宽高比请接近3:4,不符合宽高比的图片返回的分值不具备参考意义)。 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
Url String
https://showapi.oss-cn-hangzhou.aliyuncs.com/modleapi/lzh/3.jpg
图片的 Url 。图片的 Url、Image必须提供一个,如果都提供,只使用 Url。 (图片的宽高比请接近 3:4,不符合宽高比的图片返回的分值不具备参考意义) 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。 非腾讯云存储的Url速度和稳定性可能受一定影响。 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
请求示例:String res=new ShowApiRequest("http://route.showapi.com/1948-6","my_appId","my_appSecret") .addTextPara("Image","/9j/4AAQSkZJRgABAQEAAQABAAD/2wBDAAEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQH/2wBDAQEBAQEB………………………………s8On6VYtLavb2MXh/wzptpNpTsi2Ut8ZPNcq0U/xuFlLFZhjsRytVqFWlCjW3UIThDmiov3Jb2vKLem9z2sbVpYbC4TBPSnWpVJ14czvOanJxfNfmjZW0i0vI//2Q==") .addTextPara("Url","https://showapi.oss-cn-hangzhou.aliyuncs.com/modleapi/lzh/3.jpg") .post(); System.out.println(res);

三、返回参数/ Return parameter

以JSON格式返回结果。

1、系统级参数(所有接入点都会返回的参数): 展开收起
名称 类型 示例值 描述
showapi_res_body String {"city":"昆明","prov":"云南"} 消息体的JSON封装,所有应用级的返回参数将嵌入此对象 。
showapi_res_code int 0
易源返回标志,0为成功,其他为失败。
0成功
-1,系统调用错误
-2,可调用次数或金额为0
-3,读取超时
-4,服务端返回数据解析错误
-5,后端服务器DNS解析错误
-6,服务不存在或未上线
-7, API创建者的网关资源不足
-1000,系统维护
-1002,showapi_appid字段必传
-1003,showapi_sign字段必传
-1004,签名sign验证有误
-1005,showapi_timestamp无效
-1006,app无权限调用接口
-1007,没有订购套餐
-1008,服务商关闭对您的调用权限
-1009,调用频率受限
-1010,找不到您的应用
-1011,子授权app_child_id无效
-1012,子授权已过期或失效
-1013,子授权ip受限
-1014,token权限无效
showapi_res_error String 用户输入有误! 错误信息的展示
showapi_res_id String ce135f6739294c63be0c021b76b6fbff 本次请求id
...
2、应用级参数(系统级输出参数showapi_res_body字段中的json数据结构): 展开收起
名称 类型 示例值 描述
Response Object
RequestId String
8770afe8-b94a-45de-9e38-71d89c1d9d9f
唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
Score Number
100
活体打分,取值范围 [0,100],分数一般落于[80, 100]区间内,0分也为常见值。推荐相大于 87 时可判断为活体。可根据具体场景自行调整阈值。
remark String
查询成功!
返回说明!
ret_code Number
0
返回标识,0为成功,其余为失败!
...
返回示例:{ "showapi_res_error": "", "showapi_res_id": "9dc36661517648a290968e96e32f93e0", "showapi_res_code": 0, "showapi_res_body": { "Response": { "RequestId": "8770afe8-b94a-45de-9e38-71d89c1d9d9f", "Score": 100 }, "remark": "查询成功!", "ret_code": 0 } }

服务商介绍:易源数据是昆明秀派科技有限公司旗下的大数据生产、交易、流通平台。

易源数据通过打破资源壁垒,搭建起数据资源的基础设施,将接口纳入统一的接口池,把多个异构数据源合并到同一根管线上,以统一的访问和控制方式,对外提供统一格式的数据。

让开发者可以像搭积木一样通过各种API操纵资源。

截至2017年12月,平台已经拥有API接口230个,日调用量2000万,覆盖全网10万+真实消费者,为超过3000+的企业用户提供全域数据服务。

 

联系方式:

电话: 4009988033

 

微博: http://www.weibo.com/showapi

 

邮箱: services@showapi.com

 

QQ: 3007663665

 

微信: show_api

进制数据介绍:

企业和程序员可以通过进制数据封装的API或SDK极速接入其他数据资源,同时进制数据提供数据交易等服务。通过进制数据,不仅开发成本极大降低,而且可以获得其他丰富的数据服务:数据交易,数据分析,区块链Token管理等服务。

 

 

联系我们:

电话:173-6457-5198

QQ① 群:792473404

客服 QQ:1643296538

微信客服:binstds

                                      扫描二维码添加客服微信

 

 

工作时间

 周一至周五 9:00 - 21:00(其中周三为 9:00 - 18:00) 

周六 9:00 - 12:00(节假日除外) 

 

 

进制数据团队

 

 

2020.01.01

 

 

 

 

 


其他服务商
热门API推荐
相关API推荐