图片验证码接口设计文档.docx
- 文档编号:8215069
- 上传时间:2023-01-29
- 格式:DOCX
- 页数:9
- 大小:220.61KB
图片验证码接口设计文档.docx
《图片验证码接口设计文档.docx》由会员分享,可在线阅读,更多相关《图片验证码接口设计文档.docx(9页珍藏版)》请在冰豆网上搜索。
图片验证码接口设计文档
图片验证码接口设计文档
文件编号
受控编号
01
版次
1.0
密级
内部公开
总页数
6
附录
无
作者:
张传明日期:
2008-11-21
批准:
日期:
审核:
日期:
(版权所有,翻版必究)
文件修改记录
修改日期
修改状态
修改页码及条款
修改人
审核人
批准人
目录
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传真
6
体验中心
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]&随机数
如,
http:
//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=;
Set-Cookie:
agentid=a06dfd7f5146a842907f9a174a194ee6b4a11065bc1137c70b54293878208980;PATH=/;DOMAIN=;
Content-Type:
image/jpeg
Content-Length:
1381
[图片字节流]
3.2验证验证码
接口含义:
业务服务器通过http请求验证验证码的正确性
接口协议:
HTTP/GET
命令字:
confirmimage
请求参数说明:
pvccode=[验证码字符串]?
verifysession=[session字符串]
参数
描述
约束
clientid
业务编码
整数,必须大于0
pvccode
验证码字符串
无
agentid
会话字符串
无
注意:
运维在使用此接口时,业务编码clientid请设置为9999
请求示例:
http:
//Imagecode.api.localdomain:
10081/confirmimage?
clientid=1&pvccode=idio&agentid=865c0c0b4ab0e063e5caa3387c1a8741c2946f6b9b7292fcded763083c81bcbf
应答消息字段:
字段名
类型
长度(字节)
是否必选
描述
agentid
String
64
必选
与验证请求中的agentid一致
Result
Integer
4
必选
验证结果:
0:
正确
1:
错误
应答示例:
HTTP/1.1200OK
Date:
Wed,18Feb200908:
04:
20GMT
Connection:
KeepAlive
Content-Length:
74
f6748a1d219db516e2346ba6a98be47d22329bc34bc7343bc9624b61d12767a9
Result=1
3.3监控验证码
接口含义:
运维通过http请求获取验证码字符串
接口协议:
HTTP/GET
命令字:
getimage
请求参数说明:
无
请求示例:
http:
//[PVCSVR-GETIMAGE-URL]
如,http:
//I:
10080
应答消息字段:
无
应答消息实体:
验证码字符串
注意:
在应答消息头中,服务器设置有Cookie,其中包含agentid会话字符串
应答示例:
HTTP/1.1200OK
Date:
Fri,21Nov200802:
24:
57GMT
Connection:
close
Accept-Ranges:
bytes
Pragma:
No-cache
Set-Cookie:
agentid=8d7a4d0fb2e0f875f80e379af403eaae338daa834058ade0ce2c6072ec8ef7df;PATH=/;DOMAIN=;
Set-Cookie:
agentid=8d7a4d0fb2e0f875f80e379af403eaae338daa834058ade0ce2c6072ec8ef7df;PATH=/;DOMAIN=;
Content-Type:
text
Content-Length:
4
hJFw
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 图片 验证 接口 设计 文档