chong

Merge branch master

... ... @@ -6,6 +6,7 @@
* [状态码](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,6 +27,7 @@
* [课程信息](未整理/课程信息.md)
## 关于服务器
* [基础知识](服务器/基础知识.md)
* [数据库连接池](服务器/数据库连接池.md)
* [获取访问用户的IP地址](未整理/获取访问用户的IP地址.md)
... ... @@ -46,23 +49,28 @@
* [分类页面学习课程数\(老师学生通用接口\)](未整理/分类页面学习课程数老师学生通用接口.md)
## 关于事件
* [新的事件发送定义(讨论中)](未整理/新的事件发送定义(讨论中).md)
## 关于统计
* [用户单词同步](未整理/用户单词同步.md)
* [用户积分排行](未整理/用户积分排行.md)
* [用户每日积分排行](未整理/用户每日积分排行.md)
## 前端
* [老师版班级管理](未整理/老师版班级管理.md)
## 关于客户端
* [通用](客户端/通用.md)
* [iOS](客户端/iOS.md)
* [Android](客户端/Android.md)
* [html5](客户端/html5.md)
## 外教版
* [外教版](未整理/外教版.md)
* [客户端详细](未整理/客户端多国语文案.md)
* [服务端详细](未整理/服务端多国语文案.md)
... ... @@ -70,6 +78,7 @@
* [获取下载节点接口](未整理/获取下载节点接口.md)
## 技术文档
* [服务器接口文档](未整理/服务器接口文档.md)
* 接口列表
* [注册接口](未整理/注册接口.md)
... ... @@ -104,24 +113,28 @@
* [学生版具体模板介绍](未整理/具体模板介绍.md)
## 学习模板
* [单词学习](未整理/单词学习.md)
* [视频学习](未整理/视频学习.md)
* [音频学习](未整理/音频学习.md)
* [纯文章学习](未整理/纯文章学习.md)
## 练习模板
* [看文字选图](未整理/看文字选图.md)
* [听音选图](未整理/听音选图.md)
* [填空练习](未整理/填空练习.md)
* [听写练习](未整理/听写练习.md)
## 考试模板
* [文字单选题](未整理/文字单选题.md)
* [听音选图片](未整理/听音选图片.md)
* [阅读理解](未整理/阅读理解.md)
* [完形填空](未整理/完形填空.md)
-----
---
* [教师版具体模板介绍](未整理/教师版具体模板介绍.md)
* [本地存储相关](未整理/本地存储相关.md)
* [学习统计相关](未整理/学习统计相关.md)
... ... @@ -199,6 +212,7 @@
* [打电话接口](未整理/打电话接口.md)
## 产品文档
* [学习行为之听力时长统计 20150708update](未整理/学习行为之听力时长统计.md)
* [分享 20150710update](未整理/分享.md)
* [学生版逻辑树 update20150713](未整理/学生版逻辑树-update20150713.md)
... ... @@ -206,6 +220,7 @@
* [老师版分类上的数据:已学课程](未整理/老师版分类上:已学课程.md)
## 测试文档
* [共通测试](未整理/共通测试.md)
* [学生端测试](未整理/学生端测试.md)
* [老师端测试](未整理/老师端测试.md)
... ... @@ -228,9 +243,11 @@
* [微信账号升级](未整理/微信账号升级.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)
... ...
# 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": "该用户没有绑定其它用户!"
}
```
... ...