wiki:pconline_4.1.0/interface

Version 2 (modified by wuchangbo, 11 years ago) (diff)

--

1.基本约定

接口通用参数
req_enc=utf-8(必须放url后面)
resp_enc=utf-8(必须放url后面)
common_session_id=xxxx(以cookies中的优先)

接口URL: 接口URL
必填参数:参数名=xxx(多种情况用括号解析)
非必填参数:参数名=xxx(多种情况用括号解析)
说明文档参数:添加某特定参数可以直接看接口文档
是否需要登录:是,否
返回格式:json,ssi,xml
缓存方式:接口缓存,对象缓存
缓存时间:缓存时间
返回结果:结果可能情况

2.接口列表

2.1 个人中心 - 登陆接口

 URI:/rest/login.jsp
        请求方式:HTTPS POST
        说明:用户登录接口
	参数:
	  1). username :用户名
	  2). password :密码
	  3). captcha :验证码(密码错误大于等于3次需要输入验证码)
             (验证码图片请求时会回设cookie:captcha,表单提交的时候带回cookie才能校验通过)
          4). auto_login:cookie过期时间,不填默认为15天,最大不超过90天
	返回(json格式):
            失败:
            {"status":" + ex.getStatus() + ","message":""+ ex.getMessage() + ""}
            成功:
            {"status":0,"message":"ok","session":"abcdefghijk","userId":"123456 ","common_session_id":"abcdefghijk"}
	   说明:
               status : 处理状态(0 为成功,其他为失败)
	       message : 相关状态信息
	       session : common_session_id值
	       common_session_id : common_session_id值
	       userId: 当前登录用户id

2.2 个人中心 - 验证码接口

   URL:http://captcha.pconline.com.cn/captcha/v.jpg
       请求方式:HTTP GET
       说明:获取用户验证码
       参数:调用的时候在cookie设置captcha