图片验证码接口设计文档Word文档下载推荐.docx
《图片验证码接口设计文档Word文档下载推荐.docx》由会员分享，可在线阅读，更多相关《图片验证码接口设计文档Word文档下载推荐.docx（9页珍藏版）》请在冰豆网上搜索。
日期：
审核：
日期：
（版权所有，翻版必究）
文件修改记录
修改日期
修改状态
修改页码及条款
修改人
审核人
批准人
目录
1.功能说明4
2.接口说明4
3.接口参数4
3.1获取验证码图片4
3.2验证验证码6
3.3监控验证码7
1.功能说明
图片验证码系统与公司具体业务无关，它的功能相对简单，主要有获取验证码图片和验证验证码两个过程，对运维开通监控接口。
网络通讯使用HTTP+GET。
2.接口说明
接口描述中总是有一个参数clientid（业务编码）用来指定由哪个业务发起的请求。
其中clientid从1开始算起，其具体含义由图片验证码系统定义：
业务编码
业务描述
1
邮箱登陆
2
个邮发送短信
21
Coco发送短信
3
个邮发送彩信
31
Coco发送彩信
4
个邮通讯录
5
个邮传真
51
Coco传真
体验中心
7
精品订阅后台管理系统
8
网盘登陆
9
网盘提取文件
10
群邮件
11
WAP系统
999
运营
…
其他业务
9999
运维监控
注意：
clientid为0时，服务器会认为非法业务，不会响应请求。
3.接口参数
3.1获取验证码图片
接口含义：
客户端通过http请求获取验证码图片
接口协议：
HTTP/GET
命令字：
getimage
请求参数说明：
参数
描述
约束
clientid
业务编码，描述当前使用的是哪些业务
整数必须大于0
随机数
随机数是为了防止缓存
请求示例：
http:
//[PVCSVR-GETIMAGE-URL]/getimage?
clientid=[clientid]&
如，
//I:
10080/getimage?
clientid=1&
19383
应答消息字段：
应答消息实体：
验证码图片流
在应答消息头中，服务器设置有Cookie，其中包含agentid会话字符串
应答示例：
HTTP/1.1200OK
Date:
Fri,21Nov200801:
57:
21GMT
Connection:
close
Accept-Ranges:
bytes
Pragma:
No-cache
Set-Cookie:
agentid=a06dfd7f5146a842907f9a174a194ee6b4a11065bc1137c70b54293878208980;
PATH=/;
DOMAIN=;
Content-Type:
image/jpeg
Content-Length:
1381
[图片字节流]
3.2验证验证码
业务服务器通过http请求验证验证码的正确性
HTTP/GET
confirmimage
pvccode=[验证码字符串]?
verifysession=[session字符串]
整数，必须大于0
pvccode
验证码字符串
agentid
会话字符串
运维在使用此接口时，业务编码clientid请设置为9999
请求示例：
//Imagecode.api.localdomain:
10081/confirmimage?
pvccode=idio&
agentid=865c0c0b4ab0e063e5caa3387c1a8741c2946f6b9b7292fcded763083c81bcbf
字段名
类型
长度（字节）
是否必选
String
64
必选
与验证请求中的agentid一致
Result
Integer
验证结果：
0：
正确
1：
错误
Wed,18Feb200908:
04:
20GMT
KeepAlive
74
f6748a1d219db516e2346ba6a98be47d22329bc34bc7343bc9624b61d12767a9
Result=1
3.3监控验证码
运维通过http请求获取验证码字符串
//[PVCSVR-GETIMAGE-URL]
如，http:
10080
HTTP/1.1200OK
Fri,21Nov200802:
24:
57GMT
agentid=8d7a4d0fb2e0f875f80e379af403eaae338daa834058ade0ce2c6072ec8ef7df;
text
4
hJFw
升级会员 