Merge branch master

chong
Commit d4a654ebe8644785473d3483d929470bee382dc6 d4a654eb 2 parents 75c16659 cf22b45f
Showing 2 changed files with 300 additions and 103 deletions
SUMMARY.md
用户鉴权/README.md
--- a/SUMMARY.md
View file @d4a654e
+++ b/SUMMARY.md
View file @d4a654e
 # Summary
 * [Introduction](README.md)
-    * [CHANGELOG](README.md#changelog)
+  * [CHANGELOG](README.md#changelog)
-    * [OAuth2.0](README.md#oauth2.0)
+  * [OAuth2.0](README.md#oauth2.0)
-    * [状态码](README.md#status_code)
+  * [状态码](README.md#status_code)
 ## 关于用户
+
 * [注册](未整理/注册接口.md)
 * [登录](未整理/登录接口.md)
 * [用户设备绑定](未整理/用户设备绑定.md)
@@ -13,11 +14,12 @@
 * [用户信息](用户相关/用户信息.md)
 * [用户修改真实姓名绑定邮箱](未整理/用户修改真实姓名绑定邮箱.md)
-## API
+## 用户鉴权
-* [API概述](api概述.md)
+
-    * [base api](base.md)
+* [用户鉴权](用户鉴权/README.md)
 ## 关于获取图书
+
 * [书架](未整理/书架.md)
 * [图书目录](未整理/图书目录.md)
 * [课程分类](未整理/课程分类信息查询.md)
@@ -25,8 +27,9 @@
 * [课程信息](未整理/课程信息.md)
 ## 关于服务器
+
 * [基础知识](服务器/基础知识.md)
-    * [数据库连接池](服务器/数据库连接池.md)
+  * [数据库连接池](服务器/数据库连接池.md)
 * [获取访问用户的IP地址](未整理/获取访问用户的IP地址.md)
 * [客户端配置](未整理/客户端相关配置接口.md)
 * [教师偏好设置](未整理/教师偏好设置接口.md)
@@ -46,82 +49,92 @@
 * [分类页面学习课程数\(老师学生通用接口\)](未整理/分类页面学习课程数老师学生通用接口.md)
 ## 关于事件
+
 * [新的事件发送定义（讨论中）](未整理/新的事件发送定义（讨论中）.md)
 ## 关于统计
+
 * [用户单词同步](未整理/用户单词同步.md)
 * [用户积分排行](未整理/用户积分排行.md)
 * [用户每日积分排行](未整理/用户每日积分排行.md)
 ## 前端
+
 * [老师版班级管理](未整理/老师版班级管理.md)
 ## 关于客户端
+
 * [通用](客户端/通用.md)
 * [iOS](客户端/iOS.md)
 * [Android](客户端/Android.md)
 * [html5](客户端/html5.md)
 ## 外教版
+
 * [外教版](未整理/外教版.md)
-    * [客户端详细](未整理/客户端多国语文案.md)
+  * [客户端详细](未整理/客户端多国语文案.md)
-    * [服务端详细](未整理/服务端多国语文案.md)
+  * [服务端详细](未整理/服务端多国语文案.md)
 * [外教课程分类数据](未整理/外教课程分类数据.md)
 * [获取下载节点接口](未整理/获取下载节点接口.md)
 ## 技术文档
+
 * [服务器接口文档](未整理/服务器接口文档.md)
-    * 接口列表
+  * 接口列表
-        * [注册接口](未整理/注册接口.md)
+    * [注册接口](未整理/注册接口.md)
-        * [登录接口](未整理/登录接口.md)
+    * [登录接口](未整理/登录接口.md)
-        * [获取推荐的课程](未整理/获取推荐的课程.md)
+    * [获取推荐的课程](未整理/获取推荐的课程.md)
-        * [购买课程](未整理/购买课程.md)
+    * [购买课程](未整理/购买课程.md)
-        * [下载资源](未整理/下载资源.md)
+    * [下载资源](未整理/下载资源.md)
-        * [获取课程内容](未整理/获取课程内容.md)
+    * [获取课程内容](未整理/获取课程内容.md)
-        * [提交练习成绩](未整理/提交练习成绩.md)
+    * [提交练习成绩](未整理/提交练习成绩.md)
-        * [提交测验成绩](未整理/提交测验成绩.md)
+    * [提交测验成绩](未整理/提交测验成绩.md)
-        * [查看学习历史](未整理/查看学习历史.md)
+    * [查看学习历史](未整理/查看学习历史.md)
-        * [找老师](未整理/找老师.md)
+    * [找老师](未整理/找老师.md)
-        * [老师推荐](未整理/老师推荐.md)
+    * [老师推荐](未整理/老师推荐.md)
-        * [看成绩](未整理/看成绩.md)
+    * [看成绩](未整理/看成绩.md)
-        * [跟读打分](未整理/跟读打分.md)
+    * [跟读打分](未整理/跟读打分.md)
-        * [多盟转换链接口](未整理/多盟转换链接口.md)
+    * [多盟转换链接口](未整理/多盟转换链接口.md)
-        * [查询激活用户来源接口](未整理/查询激活用户来源接口.md)
+    * [查询激活用户来源接口](未整理/查询激活用户来源接口.md)
-        * [修改密码接口](未整理/修改密码接口.md)
+    * [修改密码接口](未整理/修改密码接口.md)
-        * [修改昵称接口](未整理/修改昵称接口.md)
+    * [修改昵称接口](未整理/修改昵称接口.md)
-        * [找回密码接口](未整理/找回密码接口.md)
+    * [找回密码接口](未整理/找回密码接口.md)
-        * [班级管理系列接口](未整理/班级管理系列接口.md)
+    * [班级管理系列接口](未整理/班级管理系列接口.md)
-        * [环信添加好友系列接口](未整理/环信添加好友系列接口.md)
+    * [环信添加好友系列接口](未整理/环信添加好友系列接口.md)
-        * [获取oss服务授权接口](未整理/获取oss服务授权接口.md)
+    * [获取oss服务授权接口](未整理/获取oss服务授权接口.md)
-        * [获取申请好友接口](未整理/获取申请好友接口.md)
+    * [获取申请好友接口](未整理/获取申请好友接口.md)
-        * [处理微信新旧openId登录接口](未整理/处理微信新旧openId登录接口.md)
+    * [处理微信新旧openId登录接口](未整理/处理微信新旧openId登录接口.md)
-        * [分享今日积分\/总积分排名接口](未整理/分享今日积分|总积分排名接口.md)
+    * [分享今日积分\/总积分排名接口](未整理/分享今日积分|总积分排名接口.md)
-        * [老师课程推荐 学生端](未整理/老师课程推荐-学生端.md)
+    * [老师课程推荐 学生端](未整理/老师课程推荐-学生端.md)
-        * [老师课程推荐 老师端](未整理/老师课程推荐-老师端.md)
+    * [老师课程推荐 老师端](未整理/老师课程推荐-老师端.md)
-    * 坑
+  * 坑
-        * [数据库连接池](服务器/数据库连接池.md)
+    * [数据库连接池](服务器/数据库连接池.md)
 * [模板类型](未整理/模板类型.md)
 * [学生版具体模板介绍](未整理/具体模板介绍.md)
 ## 学习模板
+
 * [单词学习](未整理/单词学习.md)
 * [视频学习](未整理/视频学习.md)
 * [音频学习](未整理/音频学习.md)
 * [纯文章学习](未整理/纯文章学习.md)
 ## 练习模板
+
 * [看文字选图](未整理/看文字选图.md)
 * [听音选图](未整理/听音选图.md)
 * [填空练习](未整理/填空练习.md)
 * [听写练习](未整理/听写练习.md)
 ## 考试模板
+
 * [文字单选题](未整理/文字单选题.md)
 * [听音选图片](未整理/听音选图片.md)
 * [阅读理解](未整理/阅读理解.md)
 * [完形填空](未整理/完形填空.md)
------
+---
+
 * [教师版具体模板介绍](未整理/教师版具体模板介绍.md)
 * [本地存储相关](未整理/本地存储相关.md)
 * [学习统计相关](未整理/学习统计相关.md)
@@ -138,67 +151,68 @@
 * [静态资源下载优化逻辑](未整理/静态资源下载优化逻辑.md)
 * [动态更新分类优化逻辑](未整理/动态更新分类优化逻辑.md)
 * [在线授课相关文档](未整理/在线授课相关文档.md)
-    * [腾讯云通信登录](未整理/腾讯云通信登录.md)
+  * [腾讯云通信登录](未整理/腾讯云通信登录.md)
-    * [在线授课接口定义](未整理/在线授课接口定义.md)
+  * [在线授课接口定义](未整理/在线授课接口定义.md)
-    * [远程教学之流程消息](未整理/远程教学之流程消息.md)
+  * [远程教学之流程消息](未整理/远程教学之流程消息.md)
-    * [单词学习模板Json信息](未整理/单词学习模板Json信息.md)
+  * [单词学习模板Json信息](未整理/单词学习模板Json信息.md)
-    * [教师版模板控件Id定义](未整理/教师版模板控件Id定义.md)
+  * [教师版模板控件Id定义](未整理/教师版模板控件Id定义.md)
-    * [远程教学之页面动作消息](未整理/远程教学之页面动作消息.md)
+  * [远程教学之页面动作消息](未整理/远程教学之页面动作消息.md)
-    * [远程教学之画板相关消息](未整理/远程教学之画板相关消息.md)
+  * [远程教学之画板相关消息](未整理/远程教学之画板相关消息.md)
-    * [在线授课单词表同步](未整理/在线授课单词表同步.md)
+  * [在线授课单词表同步](未整理/在线授课单词表同步.md)
-    * [远程教学之回答相关消息](未整理/远程教学之回答相关消息.md)
+  * [远程教学之回答相关消息](未整理/远程教学之回答相关消息.md)
-    * [错误处理列表](未整理/错误处理列表.md)
+  * [错误处理列表](未整理/错误处理列表.md)
-    * [关于用户掉线的处理机制](未整理/关于用户掉线的处理机制.md)
+  * [关于用户掉线的处理机制](未整理/关于用户掉线的处理机制.md)
-    * [错误处理机制](未整理/错误处理机制.md)
+  * [错误处理机制](未整理/错误处理机制.md)
-    * [远程教学之消息顺序保证机制](未整理/远程教学之消息顺序保证机制.md)
+  * [远程教学之消息顺序保证机制](未整理/远程教学之消息顺序保证机制.md)
-    * [关于测试App](未整理/关于测试App.md)
+  * [关于测试App](未整理/关于测试App.md)
-    * [关于保障上课通知的到达](未整理/关于保障上课通知的到达.md)
+  * [关于保障上课通知的到达](未整理/关于保障上课通知的到达.md)
-    * [资源预下载和本地通知](未整理/资源预下载和本地通知.md)
+  * [资源预下载和本地通知](未整理/资源预下载和本地通知.md)
-    * [在线授课其他消息](未整理/在线授课其他消息.md)
+  * [在线授课其他消息](未整理/在线授课其他消息.md)
-    * [待解决问题](未整理/待解决问题.md)
+  * [待解决问题](未整理/待解决问题.md)
-    * [师生课后评价](未整理/师生课后评价.md)
+  * [师生课后评价](未整理/师生课后评价.md)
-    * [最后一页（学习成就）json信息](未整理/最后一页（学习成就）json信息.md)
+  * [最后一页（学习成就）json信息](未整理/最后一页（学习成就）json信息.md)
-    * [视频的开关](未整理/视频的开关.md)
+  * [视频的开关](未整理/视频的开关.md)
-    * [邀请上课呼叫逻辑](未整理/邀请上课呼叫逻辑.md)
+  * [邀请上课呼叫逻辑](未整理/邀请上课呼叫逻辑.md)
-    * [用户发送小文件失败的处理](未整理/用户发送小文件失败的处理.md)
+  * [用户发送小文件失败的处理](未整理/用户发送小文件失败的处理.md)
-    * [自动上传用户腾讯云日志](未整理/自动上传用户腾讯云日志.md)
+  * [自动上传用户腾讯云日志](未整理/自动上传用户腾讯云日志.md)
-    * [常见反馈问题回答](未整理/常见反馈问题回答.md)
+  * [常见反馈问题回答](未整理/常见反馈问题回答.md)
 * [IOS数据客户端相关文档](未整理/IOS数据客户端.md)
 * [IOS编码规范](未整理/IOS编码规范.md)
 * [Android编码规范](未整理/Android编码规范.md)
 * [教学效果提升](未整理/教学效果提升.md)
 * [外教版](未整理/外教版.md)
-    * [客户端详细](未整理/客户端多国语文案.md)
+  * [客户端详细](未整理/客户端多国语文案.md)
-    * [服务端详细](未整理/服务端多国语文案.md)
+  * [服务端详细](未整理/服务端多国语文案.md)
 * [权限鱼](未整理/权限鱼.md)
-    * [权限鱼接口](未整理/权限鱼接口.md)
+  * [权限鱼接口](未整理/权限鱼接口.md)
-    * [学校接口详情](未整理/学校接口详情.md)
+  * [学校接口详情](未整理/学校接口详情.md)
 * [老师信息接口](未整理/老师信息接口.md)
-    * [1. 老师对产品认可度](未整理/老师对产品认可度.md)
+  * [1. 老师对产品认可度](未整理/老师对产品认可度.md)
-        * [1. 获取认可度选项静态数据](未整理/获取认可度选项静态数据.md)
+    * [1. 获取认可度选项静态数据](未整理/获取认可度选项静态数据.md)
-        * [2. 获取老师认可度](未整理/获取老师认可度.md)
+    * [2. 获取老师认可度](未整理/获取老师认可度.md)
-        * [3. 保存老师认可度](未整理/保存老师认可度.md)
+    * [3. 保存老师认可度](未整理/保存老师认可度.md)
-    * [2. 老师职称](未整理/老师职称.md)
+  * [2. 老师职称](未整理/老师职称.md)
-        * [1. 获取职称选项静态数据](未整理/获取职称选项静态数据.md)
+    * [1. 获取职称选项静态数据](未整理/获取职称选项静态数据.md)
-        * [2. 获取老师职称](未整理/获取老师职称.md)
+    * [2. 获取老师职称](未整理/获取老师职称.md)
-        * [3. 保存老师职称](未整理/保存老师职称.md)
+    * [3. 保存老师职称](未整理/保存老师职称.md)
-    * [3. 老师红包](未整理/老师红包.md)
+  * [3. 老师红包](未整理/老师红包.md)
-        * [1. 获取红包选项静态数据](未整理/获取红包选项静态数据.md)
+    * [1. 获取红包选项静态数据](未整理/获取红包选项静态数据.md)
-        * [2. 获取老师红包](未整理/获取老师红包.md)
+    * [2. 获取老师红包](未整理/获取老师红包.md)
-        * [3. 保存老师红包](未整理/保存老师红包.md)
+    * [3. 保存老师红包](未整理/保存老师红包.md)
-    * [4. 老师盒子](未整理/老师盒子.md)
+  * [4. 老师盒子](未整理/老师盒子.md)
-        * [1. 查看老师发放盒子情况](未整理/查看老师发放盒子情况.md)
+    * [1. 查看老师发放盒子情况](未整理/查看老师发放盒子情况.md)
-        * [2. 记录老师发放盒子情况](未整理/记录老师发放盒子情况.md)
+    * [2. 记录老师发放盒子情况](未整理/记录老师发放盒子情况.md)
-    * [5. 群发红包](未整理/群发红包.md)
+  * [5. 群发红包](未整理/群发红包.md)
-    * [6. 退回群红包](未整理/退回群红包.md)
+  * [6. 退回群红包](未整理/退回群红包.md)
-    * [7. 群红包流水--包括余额](未整理/群红包流水.md)
+  * [7. 群红包流水--包括余额](未整理/群红包流水.md)
 * [外教点评](未整理/外教点评.md)
 * [日志查询](未整理/日志查询.md)
-    * [app日志查询](未整理/app日志查询.md)
+  * [app日志查询](未整理/app日志查询.md)
 * [静态资源的下载策略](未整理/静态资源的下载策略.md)
 * [打电话接口](未整理/打电话接口.md)
 ## 产品文档
+
 * [学习行为之听力时长统计 20150708update](未整理/学习行为之听力时长统计.md)
 * [分享 20150710update](未整理/分享.md)
 * [学生版逻辑树 update20150713](未整理/学生版逻辑树-update20150713.md)
@@ -206,31 +220,34 @@
 * [老师版分类上的数据：已学课程](未整理/老师版分类上：已学课程.md)
 ## 测试文档
+
 * [共通测试](未整理/共通测试.md)
 * [学生端测试](未整理/学生端测试.md)
 * [老师端测试](未整理/老师端测试.md)
-    * [课程模块](未整理/课程模块.md)
+  * [课程模块](未整理/课程模块.md)
-    * [班级管理](未整理/班级管理.md)
+  * [班级管理](未整理/班级管理.md)
-        * 班级数据修改
+    * 班级数据修改
-            * [增加班级](未整理/增加班级.md)
+      * [增加班级](未整理/增加班级.md)
-            * [修改班级信息](未整理/修改班级信息.md)
+      * [修改班级信息](未整理/修改班级信息.md)
-        * 班级信息查看
+    * 班级信息查看
-            * [查看班级学生情况](未整理/查看班级学生情况.md)
+      * [查看班级学生情况](未整理/查看班级学生情况.md)
-            * [删除班级学生](未整理/删除班级学生.md)
+      * [删除班级学生](未整理/删除班级学生.md)
-            * [更换班级](未整理/更换班级.md)
+      * [更换班级](未整理/更换班级.md)
-            * [查看班级课程情况](未整理/查看班级课程情况.md)
+      * [查看班级课程情况](未整理/查看班级课程情况.md)
-        * 新申请的处理
+    * 新申请的处理
-            * [同意学生加入班级](未整理/同意学生加入班级.md)
+      * [同意学生加入班级](未整理/同意学生加入班级.md)
-            * [拒绝学生加入班级](未整理/拒绝学生加入班级.md)
+      * [拒绝学生加入班级](未整理/拒绝学生加入班级.md)
-    * [消息模块](未整理//b消息模块.md)
+  * [消息模块](未整理//b消息模块.md)
-    * [个人中心](未整理//b/b个人中心.md)
+  * [个人中心](未整理//b/b个人中心.md)
-    * [其他模块](未整理//b/b其他模块.md)
+  * [其他模块](未整理//b/b其他模块.md)
 * [微信账号升级](未整理/微信账号升级.md)
 ## 客服文档
+
 * [客服电话反馈](未整理/客服电话反馈.md)
 ## 未分类
+
 * [Android-项目](未整理/Android-项目.md)
 * [BoxFishVote项目打包部署操作流程](未整理/BoxFishVote项目打包部署操作流程.md)
 * [IOS-BoxFish-app-推送手机idfa的接口](未整理/IOS-BoxFish-app-推送手机idfa的接口.md)
@@ -245,3 +262,5 @@
 * [网页测试Demo数据](未整理/网页测试Demo数据.md)
 * [获取当前分类下存在的班级](未整理/获取当前分类下存在的班级.md)
+
+
--- a/用户鉴权/README.md 0 → 100644
View file @d4a654e
+++ b/用户鉴权/README.md 0 → 100644
View file @d4a654e
+# boxfish用户认证系统
+
+#### 测试环境部署地址
+
+[http://114.55.58.184:8099/](http://114.55.58.184:8099/)
+
+#### 生产环境部署地址
+
+[http\(s\)//base.boxfish.cn/passbook/](http://base.boxfish.cn/passbook/)
+
+认证接口 /user/auth
+
+#### 请求方式
+
+POST 方法
+
+#### 请求头信息
+
+x-be-product   com.boxfishedu.teacher \(必须包含 teacher or student \)
+
+#### 请求参数
+
+* json
+  ```json
+  {
+     "username":"username",
+     "password":"password"
+  }
+  ```
+
+#### 返回值
+
+* 合法用户  
+  http code 200
+
+  ```json
+  {
+      "id": 7566,
+      "username": "b@b.cn",
+      "access_token": "futT9nmvb5",
+      "score":3801,
+      "goal":100,
+      "figure_url":"http://avatars.boxfish.cn/user/-12/figure/1411532427.jpg"
+  }
+  ```
+
+* 用户不存在  
+  http code 404
+
+  ```json
+  {
+    "msg":  "用户不存在!"
+  }
+  ```
+
+* 用户密码不正确
+
+  http code 401
+
+  ```json
+  {
+      "msg":"用户密码不正确!"
+  }
+  ```
+
+* 用户不合法 用户头信息中 和用户账号类型不匹配  
+     http code 412
+
+  ```json
+  {
+        "msg":"用户不合法"
+  }
+  ```
+
+#### 用户信息接口 /user/me
+
+#### URL参数
+
+* access\_token string 必须
+
+#### 请求方式
+
+GET 方法
+
+#### 返回值
+
+* 合法用户  
+  http code 200
+
+  ```json
+  {
+      "id": 7566,
+      "username": "b@b.cn",
+      "access_token": "futT9nmvb5",
+      "score":3801,
+      "goal":100,
+      "figure_url":"http://avatars.boxfish.cn/user/-12/figure/1411532427.jpg"
+
+    }
+  ```
+
+* accessToken 不合法
+
+  http code 400
+
+  ```json
+  {
+    "msg": "accessToken 不合法!"
+  }
+  ```
+
+* 用户不存在  
+  http code 404
+
+  ```json
+  {
+    "msg":  "用户不存在!"
+  }
+  ```
+
+  #### 用户信息接口 /relation/user/{user\_id}?access\_token={access\_token}
+
+#### URL参数
+
+* user\_id Long 必须
+* access\_token string 必须
+
+#### 请求方式
+
+GET 方法
+
+#### 返回值
+
+* 用户关系合法
+  http code 200
+  ```json
+  {
+    "id": 100000000640,
+    "target": {
+                "id": 1298963,
+                "username": "iosstudent13@bf.cn",
+                "score": 3912,
+                "gold": 2362,
+                "figure_url": "http://avatars.boxfish.cn/user/1298963/figure/1477366527.jpg"
+              }
+    }
+  ```
+* accessToken 不合法
+
+  http code 400
+
+  ```json
+  {
+    "msg": "accessToken 不合法!"
+  }
+  ```
+
+* accessToken 过期
+
+  http code 401
+
+  ```json
+  {
+    "msg": "用户token过期！"
+  }
+  ```
+
+* 该用户没有绑定其它用户！  
+  http code 404
+
+  ```json
+  {
+    "msg":  "该用户没有绑定其它用户！"
+  }
+  ```
+
+
+