校验图形验证码 - ValidateCaptcha
功能介绍
校验图形验证码。
URI
POST /api/v2/sdk/captcha/verify
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
Content-Type | 是 | String | 该字段内容填为“application/json;charset=utf8”。 |
X-operating-sys-version | 是 | String | 调用方操作系统版本，例如：Android 10。 |
X-device-fingerprint | 是 | String | 调用方设备指纹，例如：156aysdna213sc50。 |
X-device-ip | 否 | String | 调用方IP，例如：10.10.10.1。 |
X-agent | 是 | String | 用户Agent信息，例如：Mozilla/5.0 (Linux; Android 10; Redmi K30 Build/QKQ1.190825.002; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/80.0.3987.99 Mobile Safari/537.36。 |
X-L | 否 | String | 用于国际化语言设置，例如：zh。 |
X-client-id | 是 | String | 应用标识，注册应用后分配的ClientId。 |
X-tenant-id | 否 | String | 租户id，ISV应用调用则为必填，需要将{domain_name}换成ISV通用域名{common_domain}，请求Header参数中需要指定对应租户的tenant_id，并将X-client-id换成ISV应用模板的client_id。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
point_json | 是 | String | 坐标信息，y轴固定值5.0。 |
token | 是 | String | 获取图形验证码返回的token。 |
sender | 是 | String | 发送方（手机号、邮箱）。 |
响应参数
状态码：200
参数 | 参数类型 | 描述 |
|---|---|---|
captcha_token | String | 图形验证码校验通过的凭证。 |
状态码：400
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码。 |
error_msg | String | 错误详情。 |
请求示例
校验图形验证码。坐标信息为{"x":237.0,"y":5.0}，token为71d******635，发送方手机号为12345678901。
POST https://{domain_name}/api/v2/sdk/captcha/verify
X-operating-sys-version: Android 10
X-device-fingerprint: 156aysdna213sac
X-device-ip: 10.10.10.1
X-agent: Mozilla/5.0 (Linux; Android 10; Redmi K30 Build/QKQ1.190825.002; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/80.0.3987.99 Mobile Safari/537.36
X-L: zh
X-client-id: DRrYIqauawN0I8myTMoDTPys6ezGZxnm
X-tenant-id: 08f770f51f80d2f40f38c00cb199fd21
{
"point_json": "{\"x\":237.0,\"y\":5.0}",
"token": "71d******635",
"sender": "12345678901"
} 响应示例
状态码：200
请求成功。
{
"captcha_token" : "71d******635---{\"x\":237.0,\"y\":5.0}"
} 状态码
状态码 | 描述 |
|---|---|
200 | 请求成功。 |
400 | 参数无效。 |
错误码
请参见错误码。
