v3/csec/captcha_get

目录

1 /v3/csec/captcha_get

为防止恶意注册/暴力破解/灌水等,保护用户安全和应用信息安全,可以采用要求用户登录/发表留言时输入验证码的方式。

调用本接口可以获取验证码图片,本接口需要与“校验验证码”接口配合使用:
用户点击“获取验证码”按钮后,应用调用本接口可获取验证码图片并显示在界面上;用户在输入框中输入验证码并确认后,应用需调用“校验验证码”接口(v3/csec/captcha_verify)判断用户输入的验证码是否正确。

1.1 URL

http://[域名]/v3/csec/captcha_get

正式环境域名或测试环境IP详见:API3.0文档#请求URL说明

1.2 格式

json

1.3 HTTP请求方式

GET, POST

1.4 IP限制

TRUE

1.5 输入参数说明

各个参数请进行URL 编码,编码时请遵守 RFC 1738

(1)公共参数
发送请求时必须传入公共参数,详见公共参数说明

(2)私有参数
无。

1.6 请求示例

http://113.108.20.23/v3/csec/captcha_get?
openid=B624064BA065E01CB73F835017FE96FA&
openkey=5F154D7D2751AEDC8527269006F290F70297B7E54667536C&
appid=2&
sig=9999b41ad0b688530bb1b21c5957391c&
pf=qzone&
format=json&
userip=112.90.139.30

1.7 返回参数说明

参数名称 描述
ret 返回码。详见公共返回码说明#OpenAPI V3.0 返回码
msg 如果错误,返回错误信息。
is_lost 判断是否有数据丢失。如果应用不使用cache,不需要关心此参数。

0或者不返回:没有数据丢失,可以缓存。
1:有部分数据丢失或错误,不要缓存。

filename 验证码jpg图片名称串,在调用“校验图片验证码”接口(v3/csec/captcha_verify)来验证图片合法性和时效性时使用。
二进制数据流 验证码jpg图片内容的二进制数据流。

1.8 正确返回示例

成功时,返回HTTP包,HTTP包中包含了二进制流图片。
开发者需要解析HTTP返回包,得到filename,以及二进制文件。

注:
1. 在PHP中,可以使用curl_setopt($CurlHandle, CURLOPT_HEADER, true); 来获取HTTP返回包的数据,从而获取filename以及二进制数据流。
2. 如果想直接浏览图片,可以在浏览器地址栏输入GET请求链接,请求发送成功后,会提示保存文件,文件名即返回包中的filename。保存后,修改文件的后缀名为.jpg,即可打开图片)

Content-type: image/jpg;
Content-Disposition: attachment;
filename= aef400a3241033709a1be0790f250aa6c7;
二进制数据流

1.9 错误返回示例

Content-type: text/html; charset=utf-8
{
"ret":1002,
"msg":"请先登录"
}

以上信息是否解决您的问题?

Copyright © 1998 - 2019 Tencent. All Rights Reserved.

腾讯公司 版权所有

有问必答 返回顶部