| 接口分类 | 请求方法 | 接口名称 | 接口功能 | 功能说明 |
|---|---|---|---|---|
| analyze | POST | /face/analyze/detection | 人脸检测 | 检测上传照片的人脸(Face)位置、性别、 年龄。 |
| POST | /face/analyze/landmark | 人脸标点 | 检测上传照片的面部轮廓,五官等关键点位置,包括 5 点、12 点、30 点、40 点、69 点、95 点六种模式 | |
| POST | /face/analyze/comparison | 人脸比对 | 计算两个人脸(Face)的相似度 | |
| person | GET | /face/persons | person列表 | 查询 person 列表 |
| POST | /face/persons | 创建person | 创建一个Person | |
| POST | /face/persons/{person_id}/faces | 添加face | 在某 person 添加 face | |
| POST | /face/persons/{person_id}/verification | 验证person | 返回 face 和指定 Person 的相似度 | |
| DELETE | /face/persons/{person_id} | 删除person | 删除某 person | |
| DELETE | /face/persons/{person_id}/faces | 删除face | 在某 person 删除某 face | |
| group | GET | /face/groups | group列表 | 查询 group 列表 |
| POST | /face/groups | 创建group | 创建 group | |
| POST | /face/groups/{group_id}/persons | 添加person | 在某 group 添加 person | |
| POST | /face/groups/{group_id}/search | 搜索person | 返回 给定face 和某 group 内相似度最高的 person | |
| DELETE | /face/groups/{group_id} | 删除group | 删除某 group | |
| DELETE | /face/groups/{group_id}/persons | 删除person | 在某 group 删除某 person |
在每一个 api 功能列表下,您都可以通过填写相应参数,对当前api进行试用。如何获取 api_key 与 api_secret ?
把除了 文件字段 以外的所有请求参数名(sign不参与签名)按字典升序进行排序。
参数名全部转换为小写。
把排序后的所有参数名与对应的参数值按 「参数名参数值」 的形式拼接成字符串, 如:key1value1key2value2...。
把 api_secret 作为后缀拼接到上一步生成的字串后面, 得到 待签名字符串。
最后再对 待签名字符串 用 MD5 摘要算法,得到签名结果 sign (32位小写)。
| 错误码 | 说明 |
|---|---|
| 200 | 请求成功 |
| -101 | 请求方法无效 |
| -201 | 必选参数未设置或参数名错误 |
| -202 | 请求超时 |
| -301 | 无效的api_key |
| -302 | 参数签名验证失败 |
| -303 | 未开通此api服务 |
| -304 | 余额不足 |
| -305 | 欠费 |
| -401 | 获取上传图片失败 |
| -402 | 错误的文件格式 |
| -403 | 图片地址参数未设置 |
| -404 | 无效的图片地址参数 |
| -405 | 读取上传图片发生错误 |
| -407 | 图片尺寸错误 |
| -500 | 内部服务错误 |
| -501 | 服务异常 |
| -502 | 服务处理超时 |
| -604 | 无效的参数 |
| -203 | 参数未设置 |
| -406 | 图片过大 |
| -601 | 未检测到人脸 |
| -602 | 错误的标点类型 |
| -603 | 未设置标点参数 |
| -605 | 未设置faceId参数 |
| -901 | face name已存在 |
| -902 | face uid已存在 |
| -903 | group 不存在 |
| -904 | person 不存在 |
| -905 | face 不存在 |
| -906 | person 数量超过最大数 |
| -907 | faces 数量超过最大数 |