AIPAAS文档中心

Appearance

Return to top
当前页面

人脸管理接口

人脸注册

向人脸库中添加人脸(如果group,userid不存在, 则会自动创建用户组和注册用户)

  • 请求路径:

/face-api/v3/face/add

  • Header：
参数值
Content-Typeapplication/json
token令牌
  • Body请求参数
参数必选类型说明
image是string图片信息。
image_type是string图片类型 BASE64:图片的base64值，base64编码后的图片数据。
group_id是string用户组id，标识一组用户（由数字、字母、下划线组成），长度限制40B。产品建议：根据您的业务需求，可以将需要注册的用户，按照业务划分，分配到不同的group下。
user_id是string用户id（由数字、字母、下划线组成），长度限制40B
user_info否string用户资料，长度限制256B 默认空
  • 请求示例
  {
      "image": "图片base62编码值",
      "image_type": "BASE64",
      "group_id": "group_repeat",
      "user_id" : "user1",
      "user_info" : "abc"
  }
  • 返回结果
字段必选类型说明
face_token是string人脸图片的唯一标识
location是array人脸在图片中的位置
+left是double人脸区域离左边界的距离
+top是double人脸区域离上边界的距离
+width是double人脸区域的宽度
+height是double人脸区域的高度

同一张人脸无法在同一个用户组下注册多次**

  • 返回示例
{
  "error_code": 0,
  "error_msg": "SUCCESS",
  "log_id": 1234567890123,
  "timestamp": 1533094602,
  "cached": 0,
  "result": {
      "face_token": "2fa64a88a9d5118916f9a303782a97d3",
      "location": {
            "top": "79",
            "left": "79",
            "width": "79",
            "height": "79"
      }
  }
}

人脸注册（无人脸检测）

向人脸库中添加人脸(如果group,userid不存在, 则会自动创建用户组和注册用户)

  • 请求路径:

/face-api/v3/face/addNoDetect

  • Header：
参数值
Content-Typeapplication/json
token令牌
  • Body请求参数
参数必选类型说明
image是string图片信息。
image_type是string图片类型 BASE64:图片的base64值，base64编码后的图片数据。
group_id是string用户组id，标识一组用户（由数字、字母、下划线组成），长度限制40B。产品建议：根据您的业务需求，可以将需要注册的用户，按照业务划分，分配到不同的group下。
user_id是string用户id（由数字、字母、下划线组成），长度限制40B
user_info否string用户资料，长度限制256B 默认空
  • 请求示例
{
  "image": "图片base62编码值",
  "image_type": "BASE64",
  "group_id": "group_repeat",
  "user_id" : "user1",
  "user_info" : "abc"
}
  • 返回结果
字段必选类型说明
face_token是string人脸图片的唯一标识

同一张人脸无法在同一个用户组下注册多次**

  • 返回示例
{
  "error_code": 0,
  "error_msg": "SUCCESS",
  "log_id": 1234567890123,
  "timestamp": 1533094602,
  "cached": 0,
  "result": {
      "face_token": "2fa64a88a9d5118916f9a303782a97d3"
  }
}

人脸更新

用于对人脸库中指定用户，更新其下的人脸图像。 说明：针对一个user_id执行更新操作，新上传的人脸图像将覆盖该group_id中user_id的原有所有图像。

  • 请求路径:

/face-api/v3/face/update

  • Header：
参数值
Content-Typeapplication/json
token令牌
  • Body请求参数
参数必选类型说明
image是string图片信息。
image_type是string图片类型 BASE64:图片的base64值，base64编码后的图片数据。
group_id是string用户组id，标识一组用户（由数字、字母、下划线组成），长度限制40B
user_id是string用户id（由数字、字母、下划线组成），长度限制40B
user_info否string用户资料，长度限制128B 默认空
  • 请求示例
{
  "image": "027d8308a2ec665acb1bdf63e513bcb9",
  "image_type": "BASE64",
  "group_id": "group_repeat",
  "user_id" : "user1",
  "user_info" : "cba"
}
  • 返回结果
字段必选类型说明
face_token是string人脸图片的唯一标识
location是array人脸在图片中的位置
+left是double人脸区域离左边界的距离
+top是double人脸区域离上边界的距离
+width是double人脸区域的宽度
+height是double人脸区域的高度
  • 返回示例
{
  "error_code": 0,
  "error_msg": "SUCCESS",
  "log_id": 1234567890123,
  "timestamp": 1533094612,
  "cached": 0,
  "result": {
      "face_token": "2fa64a88a9d5118916f9a303782a97d3",
      "location": {
            "top": "79",
            "left": "79",
            "width": "79",
            "height": "79"
      }
  }
}

人脸更新 (无人脸检测)

用于对人脸库中指定用户，更新其下的人脸图像。 说明：针对一个user_id执行更新操作，新上传的人脸图像将覆盖该group_id中user_id的原有所有图像。

  • 请求路径:

/face-api/v3/face/update

  • Header：
参数值
Content-Typeapplication/json
token令牌
  • Body请求参数
参数必选类型说明
image是string图片信息。
image_type是string图片类型 BASE64:图片的base64值，base64编码后的图片数据。
group_id是string用户组id，标识一组用户（由数字、字母、下划线组成），长度限制40B
user_id是string用户id（由数字、字母、下划线组成），长度限制40B
user_info否string用户资料，长度限制128B 默认空
  • 请求示例
{
  "image": "027d8308a2ec665acb1bdf63e513bcb9",
  "image_type": "BASE64",
  "group_id": "group_repeat",
  "user_id" : "user1",
  "user_info" : "cba"
}
  • 返回结果
字段必选类型说明
face_token是string人脸图片的唯一标识
  • 返回示例
{
  "error_code": 0,
  "error_msg": "SUCCESS",
  "log_id": 1234567890123,
  "timestamp": 1533094612,
  "cached": 0,
  "result": {
      "face_token": "2fa64a88a9d5118916f9a303782a97d3"
  }
}

人脸列表

获取一个用户下的人脸列表

  • 请求路径

/face-api/v3/face/list

  • Header：
参数值
Content-Typeapplication/json
token令牌
  • Body请求参数
参数必选类型说明
user_id是string用户id（由数字、字母、下划线组成），长度限制40B
group_id是string用户组id（由数字、字母、下划线组成） 长度限制40B
  • 请求示例
{
  "user_id": "user1",
  "group_id": "group1"
}
  • 返回结果
字段必选类型说明
face_list是array人脸信息列表
+face_token是string人脸标志
+ctime是string人脸创建时间
  • 返回示例
{
  "error_code": 0,
  "error_msg": "SUCCESS",
  "log_id": 1234567890123,
  "timestamp": 1533094619,
  "cached": 0,
  "result": {
      "face_list": [
          {
              "face_token": "fid1",
              "ctime": "2018-01-01 00:00:00"
          }
      ]
  }
}

删除人脸

删除用户下的某一张人脸 如果该用户下没有其他人脸了则同时删除用户

  • 请求路径

/face-api/v3/face/delete

  • Header：
参数值
Content-Typeapplication/json
token令牌
  • Body请求参数
参数必选类型说明
user_id是string用户id（由数字、字母、下划线组成），长度限制40B
group_id是string用户组id（由数字、字母、下划线组成） 长度限制40B
face_token是string人脸id（由数字、字母、下划线组成）长度限制64B
  • 请求示例
{
  "user_id": "user1",
  "group_id": "group1",
  "face_token": "2fa64a88a9d5118916f9a303782a97d3"
}
  • 返回结果 通过返回的error_code判断是否成功 如失败则查看error_msg获得具体错误信息
  • 通过返回的error_code判断是否成功 如失败则查看error_msg获得具体错误信息
{
  "error_code": 0,
  "error_msg": "SUCCESS",
  "log_id": 1234567890123,
  "timestamp": 1533094650,
  "cached": 0,
  "result": null
}

文档中心

Copyright © 2022-present aipaas