Skip to content

获取图形验证码接口

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

请求说明

请求头

参数名中文名称必须类型描述
X-operating-sys-version调用方操作系统版本Stringwindows10.1.1
X-device-fingerprint调用方设备指纹String156aysdna213sc50
X-device-ip调用方IPString192.168.1.2
X-agentUser-Agent信息StringMozilla/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用于国际化语言设置Stringzh
X-client-id应用授权IDStringnTo1eRIub60vPb54WeE6aojPwYwImtl4

请求参数

返回示例

成功示例

HTTP/1.1 200 OK

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

json
{
    "error_code": "SDK.COMMON.1001",
    "error_msg": "Parameter X-client-id cannot be left blank."
}

返回参数

参数名中文名称类型描述
captchaId验证码idString验证码id
projectCodeString
captchaOriginalPathString
captchaFontTypeString
captchaFontSizeString
secretKeyString
originalImageBase64原生图片base64String原生图片base64
point滑块点选坐标String滑块点选坐标
jigsawImageBase64滑块图片base64String滑块图片base64
wordList点选文字String点选文字
pointList点选坐标String点选坐标
pointJson点坐标(base64加密传输)String点坐标(base64加密传输)
tokentoken(每次请求的验证码唯一标识)Stringtoken(每次请求的验证码唯一标识)
result校验结果String校验结果
captchaVerification后台二次校验参数String后台二次校验参数

竹云IDaaS开放平台