Home

回到权限鱼

服务器接口相关

测试服务器地址: http://114.55.58.184:9091
生产服务器地址: http://114.55.94.222:9091

登录接口

请求参数

/login/auth

参数名	参数说明
name	登录名(邮箱)
password	密码
signature	签名(暂未校验, 建议输入固定字符串)

请求方式

HTTP POST

返回值

{
    "code": 0,
    "message": "成功",
    "tokenInvalidTime": "2016-05-24 01:22:42",
    "data": {
        "name": "lidongxu@boxfish.cn",
        "token": "8140ab90fc9cad0ac6790a58ee96aeae60b180654a70485438d242430ddcd078",
        "type": "DEV",
        "realName": "李东旭",
        "createAt": "2016-05-12 14:58:41",
        "updateAt": "2016-05-20 10:29:30",
        "lastLoginTime": "2016-05-23 20:22:42"
    }
} 

token信息需要写入HTTP请求的header中, header name为 auth_fish_token .

查询教师VIP权限信息

请求参数

/vip/verification

参数名称	参数说明
username	教师注册名(注册邮箱)

请求方式

HTTP GET

返回值

未开通权限返回值

{
    "code": 0,
    "message": "成功",
    "tokenInvalidTime": "2016-05-24 01:36:26",
    "data": {
        "userId": -110,
        "username": "test2016110",
        "email": null,
        "schoolId": null,
        "school": null,
        "vip": null,
        "tips": null,
        "userExtraId": null,
        "namespaceHasUserId": null,
        "studentAccountId": 10111,
        "studentUsername": "allstar10111",
        "password": "558845",
        "deadAccount": "AUTH_FISH_GEN",
        "studentAccountMessage": "AUTH_FISH_GEN"
    }
}

开通权限返回值

{
    "code": 106,
    "message": "用户已拥有VIP权限",
    "tokenInvalidTime": "2016-05-24 01:34:49",
    "data": {
        "userId": -110,
        "username": "test2016110",
        "email": null,
        "schoolId": null,
        "school": "盒子鱼开发测试初级中学",
        "vip": null,
        "tips": null,
        "userExtraId": 45015,
        "namespaceHasUserId": 434594,
        "studentAccountId": 10111,
        "studentUsername": "allstar10111",
        "password": "558845",
        "deadAccount": "AUTH_FISH_GEN",
        "studentAccountMessage": "AUTH_FISH_GEN"
    }
}

教师开通VIP权限

请求参数

/vip/add

参数名称	参数说明
tel	电话
realName	真实姓名
username	教师用户名(注册邮箱)
schoolPhase	学校学段
schoolProvince	学校省份
schoolCity	学校城市
schoolCounty	学校区县
schoolName	学校名称

请求方式

HTTP POST

请求结果

成功请求结果

{
    "code": 0,
    "message": "成功",
    "tokenInvalidTime": "2016-05-24 01:49:20",
    "data": {
        "userId": -110,
        "username": "test2016110",
        "email": null,
        "schoolId": 10908,
        "school": "盒子鱼开发测试初级中学",
        "vip": "VIP",
        "tips": "已存在VIP权限",
        "userExtraId": 45286,
        "namespaceHasUserId": 434594,
        "studentAccountId": 10111,
        "studentUsername": "allstar10111",
        "password": "558845",
        "deadAccount": "AUTH_FISH_GEN",
        "studentAccountMessage": "AUTH_FISH_GEN"
    }
}

重复请求也为成功

重置登录用户密码

请求参数

/auth/fish/reset/password

参数名称	参数说明
name	用户名

请求方式

HTTP POST

返回值

{
    "code": 0,
    "message": "成功",
    "tokenInvalidTime": null,
    "data": null
}

通过邮件重置密码, 使用邮箱用户都可成功(发邮箱的密码配置在服务工程中).

查询登录用户类型

请求参数

/auth/fish/user/type

请求方式

HTTP GET

返回值

{
    "code": 0,
    "message": "成功",
    "tokenInvalidTime": null,
    "data": [
        {
            "type": "DEV"
        },
        {
            "type": "AD"
        },
        {
            "type": "OP"
        },
        {
            "type": "BD"
        }
    ]
}

查询登录用户信息

请求参数

/auth/fish/user

参数名称	参数说明
name	登录用户名(员工邮箱)

请求方式

HTTP GET

返回值

员工存在

{
    "code": 0,
    "message": "成功",
    "tokenInvalidTime": "2016-05-24 02:01:13",
    "data": {
        "id": 2,
        "name": "lidongxu@boxfish.cn",
        "type": "DEV",
        "realName": "李东旭",
        "createAt": "2016-05-12 14:58:41",
        "updateAt": "2016-05-20 10:29:30",
        "lastLoginTime": "2016-05-23 20:22:43"
    }
}

员工不存在

{
    "code": 112,
    "message": "用户不存在",
    "tokenInvalidTime": "2016-05-24 02:01:57",
    "data": null
}

新增/修改用户

请求参数

/auth/fish/user

参数名称	参数说明
name	登录用户名(员工邮箱, 新建用户会发送重置密码邮件)
realName	真实姓名
type	员工类型, 从 /auth/fish/user/type 获取

请求方式

HTTP POST

返回值

{
    "code": 0,
    "message": "成功",
    "tokenInvalidTime": "2016-05-24 02:05:39",
    "data": {
        "id": 127,
        "name": "testuser1@371223515.cn",
        "type": "BD",
        "realName": "测试用户3",
        "createAt": "2016-05-23 21:05:39",
        "updateAt": "2016-05-23 21:05:39",
        "lastLoginTime": null
    }
}