员工身份(EIAM)

校验图形验证码接口

接口

滑动图形验证码滑块后,调用校验图形验证码接口。

# 请求说明

POST https://{your_domain}/api/v2/sdk/captcha/verify

请求类型:application/json

# 请求Header参数

参数名 中文名称 必须 类型 示例
X-operating-sys-version 调用方操作系统版本 String windows10.1.1
X-device-fingerprint 调用方设备指纹 String 156aysdna213sc50
X-device-ip 调用方IP String 192.168.1.2
X-agent User-Agent信息 String Mozilla/5.0 (iPhone; CPU iPhone OS 13_3 like Mac OS X) AppleWebKit/605.1.15(KHTML, like Gecko)
Mobile/15E148/HuaWei-AnyOffice/2.6.1802.0010/com.huawei.cloudlink.workplace
X-L 用于国际化语言设置 String zh
X-client-id 应用授权ID String nTo1eRIub60vPb54WeE6aojPwYwImtl4

# 请求包体示例

#用于发送手机验证码场景
{
  "point_json": "{\"x\":237.0,\"y\":5.0}",
  "token": "71dd26999e314f9abb0c635336976635",
  "sender":"15201657315"
}
#用于发送邮箱验证码场景
{
  "point_json": "{\"x\":237.0,\"y\":5.0}",
  "token": "71dd26999e314f9abb0c635336976635",
  "sender":"zhangsan@qq.com"
}
1
2
3
4
5
6
7
8
9
10
11
12

# 请求参数

参数名 中文名称 必须 类型 描述
point_json 坐标信息 String 坐标信息,y轴固定值5.0
获取坐标信息请参考JS、VUE拼图验证码 DEMO
token 获取图形验证码返回的token String 获取图形验证码返回的token
sender 发送方 String 发送方(手机号、邮箱)

# 返回示例

成功示例:
HTTP/1.1 200 OK
Content-Type: application/json
{
    "captcha_token":"71dd26999e314f9abb0c635336976635---{\"x\":237.0,\"y\":5.0}"
}
错误示例:
HTTP/1.1 400 Bad Request
{
    "error_code": "SDK.COMMON.1001",
    "error_msg": "Parameter X-client-id cannot be left blank."
}
1
2
3
4
5
6
7
8
9
10
11
12

# 返回参数

参数名 中文名称 类型 描述
captcha_token 图形验证码校验成功的Token String 图形验证码校验成功的Token