| | 1 | [[TOC]] |
| | 2 | |
| | 3 | == 1.基本约定 == |
| | 4 | {{{ |
| | 5 | 接口通用参数 |
| | 6 | req_enc=utf-8(必须放url后面) |
| | 7 | resp_enc=utf-8(必须放url后面) |
| | 8 | common_session_id=xxxx(以cookies中的优先) |
| | 9 | |
| | 10 | 接口URL: 接口URL |
| | 11 | 必填参数:参数名=xxx(多种情况用括号解析) |
| | 12 | 非必填参数:参数名=xxx(多种情况用括号解析) |
| | 13 | 说明文档参数:添加某特定参数可以直接看接口文档 |
| | 14 | 是否需要登录:是,否 |
| | 15 | 返回格式:json,ssi,xml |
| | 16 | 缓存方式:接口缓存,对象缓存 |
| | 17 | 缓存时间:缓存时间 |
| | 18 | 返回结果:结果可能情况 |
| | 19 | }}} |
| | 20 | |
| | 21 | == 2.接口列表 == |
| | 22 | === 2.1 [=#point201 个人中心 - 登陆接口] === |
| | 23 | {{{ |
| | 24 | |
| | 25 | URI:/rest/login.jsp |
| | 26 | 请求方式:HTTPS POST |
| | 27 | 说明:用户登录接口 |
| | 28 | 参数: |
| | 29 | 1). username :用户名 |
| | 30 | 2). password :密码 |
| | 31 | 3). captcha :验证码(密码错误大于等于3次需要输入验证码) |
| | 32 | (验证码图片请求时会回设cookie:captcha,表单提交的时候带回cookie才能校验通过) |
| | 33 | 4). auto_login:cookie过期时间,不填默认为15天,最大不超过90天 |
| | 34 | 返回(json格式): |
| | 35 | 失败: |
| | 36 | {"status":" + ex.getStatus() + ","message":""+ ex.getMessage() + ""} |
| | 37 | 成功: |
| | 38 | {"status":0,"message":"ok","session":"abcdefghijk","userId":"123456 ","common_session_id":"abcdefghijk"} |
| | 39 | 说明: |
| | 40 | status : 处理状态(0 为成功,其他为失败) |
| | 41 | message : 相关状态信息 |
| | 42 | session : common_session_id值 |
| | 43 | common_session_id : common_session_id值 |
| | 44 | userId: 当前登录用户id |
| | 45 | }}} |