客户身份(CIAM)
校验图形验证码
本文档为您介绍滑动图形验证码滑块后，调用校验图形验证码接口相关内容。
# 请求说明
POST https://{your_domain}/api/v2/sdk/captcha/verify
# 请求头
| 参数名 | 中文名称 | 必须 | 类型 | 示例 |
|---|---|---|---|---|
| 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) |
| X-L | 用于国际化语言设置 | 否 | String | zh |
| X-client-id | 应用授权ID | 是 | String | nTo1eRIub60vPb54WeE6aojPwYwImtl4 |
| content-type | 内容格式类型 | 是 | String | application/json |
# 请求示例
用于发送手机验证码场景
{
"point_json": "{\"x\":237.0,\"y\":5.0}",
"token": "71dd26999e314f9abb0c635336976635",
"sender": "15200000000"
}
用于发送邮箱验证码场景
{
"point_json": "{\"x\":237.0,\"y\":5.0}",
"token": "71dd26999e314f9abb0c635336976635",
"sender": "15200000000@163.com"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
2
3
4
5
6
7
8
9
10
11
12
13
# 请求参数
| 参数名 | 中文名称 | 必须 | 类型 | 描述 |
|---|---|---|---|---|
| point_json | 坐标信息 | 是 | String | 坐标信息 |
| 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": "IDAAS.SDK.CAPTCHA.0002",
"error_msg": "Graphic verification code verification failed"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
2
3
4
5
6
7
8
9
10
11
12
13
14
# 返回参数
| 参数名 | 中文名称 | 类型 | 描述 |
|---|---|---|---|
| captcha_token | 图形验证码校验通过令牌 | String | 图形验证码校验成功的Token |
# 错误码
| 状态码 | 错误码 | 错误信息 | 处理措施 |
|---|---|---|---|
| 400 | IDAAS.SDK.PARAM.0001 | Device information is incomplete | 请检查输入的设备信息是否完整 |
| 设备信息不完整 | |||
| 400 | IDAAS.SDK.PARAM.0002 | clientId cannot be empty | 请检查输入的clientId是否为空 |
| clientId不能为空 | |||
| 400 | IDAAS.SDK.PARAM.0003 | The app is not registered, please register the app first | 请检查输入的clientId是否正确 |
| 应用未注册，请先注册应用 | |||
| 400 | IDAAS.SDK.PARAM.0004 | Point json cannot be empty | 请检查输入的坐标信息是否为空 |
| 坐标信息不能为空 | |||
| 400 | IDAAS.SDK.PARAM.0005 | Token cannot be empty | 请检查输入的图形验证码身份令牌是否为空 |
| 图形验证码身份令牌不能为空 | |||
| 400 | IDAAS.SDK.PARAM.0006 | Sender cannot be empty | 请检查输入的发送方是否为空 |
| 发送方不能为空 | |||
| 400 | IDAAS.SDK.CAPTCHA.0002 | Graphic verification code verification failed | 请检查输入项是否正确并重新调用 |
| 图形验证码校验失败 |