竹云IDaaS•开放平台
员工身份(EIAM)

获取图形验证码接口

接口

用于人机校验的初始化图形验证码。在发送短信或邮件验证码前，必须先完成人机校验，以区分是否为真实用户。 接口交互流程如下：

# 请求说明

GET https://{your_domain}/api/v2/sdk/captcha

# 请求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

# 请求参数

无

# 返回示例

成功示例：
HTTP/1.1 200 OK
Content-Type: application/json
{
    "captchaId": null,
    "projectCode": null,
    "captchaOriginalPath": null,
    "captchaFontType": null,
    "captchaFontSize": null,
    "secretKey": "yMXC583dP4R7uhmq",
    "originalImageBase64": "iVBORw0KGgoAAAANSUhEUgAAATYABj/WRVk78AAAAASUVORK5CYII=",
    "point": null,
    "jigsawImageBase64": "iVBORw0KGgoAAAANSUhEUgADcAAAAASUVORK5CYII=",
    "wordList": null,
    "pointList": null,
    "pointJson": null,
    "token": "389c21b32a8e4eba9a6d75b71150bfd1",
    "result": false,
    "captchaVerification": null
}
错误示例：
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
13
14
15
16
17
18
19
20
21
22
23
24
25
26

# 返回参数

参数名 中文名称 类型 描述
captchaId 验证码id String 验证码id
projectCode String
captchaOriginalPath String
captchaFontType String
captchaFontSize String
secretKey String
originalImageBase64 原生图片base64 String 原生图片base64
point 滑块点选坐标 String 滑块点选坐标
jigsawImageBase64 滑块图片base64 String 滑块图片base64
wordList 点选文字 String 点选文字
pointList 点选坐标 String 点选坐标
pointJson 点坐标(base64加密传输) String 点坐标(base64加密传输)
token token(每次请求的验证码唯一标识) String token(每次请求的验证码唯一标识)
result 校验结果 String 校验结果
captchaVerification 后台二次校验参数 String 后台二次校验参数

校验图形验证码接口