• 2.4.1.7.1. 认证与授权
    • 2.4.1.7.1.1. Login（登录）
    • 2.4.1.7.1.2. CheckTicket（票据校验）
    • 2.4.1.7.1.3. RefreshToken（重新获取 Token）
    • 2.4.1.7.1.4. User（当前用户信息）
    • 2.4.1.7.1.5. ResetPassword（更改密码）
    • 2.4.1.7.1.6. Upload（附件上传）
    • 2.4.1.7.1.7. Download（附件下载）
    • 2.4.1.7.1.8. Download（附件下载）

    2.4.1.7.1. 认证与授权

    2.4.1.7.1.1. Login（登录）

    属性值
    url/api/login
    http方法post
    Content-Typeapplication/json或application/x-www-form-urlencoded

    请求参数：

    字段字段名称字段类型说明是否必传
    username登录账户String登录账户是
    password登录密码String是
    system登录系统String是
    keep_alive会话周期Stringshort/medium/long否

    system 和 username 参数说明：

    登录系统systemusername
    MixPro系统MixPro用户名
    ADMIN系统ADMIN用户名
    APP应用APP手机号

    keep_alive 参数说明：

    值token 时效refresh_token 时效
    default2h1d
    short1d7d
    medium3d30d
    long7d90d

    返回示例：

    1. {
    2.     "code": 200,
    3.     "msg": "登录成功",
    4.     "mix_code": 130002,
    5.     "mix_msg": "",
    6.     "mix_ext": "",
    7.     "result": {
    8.         "user_id": 1000,
    9.         "username": "admin",
    10.         "is_super": 1,
    11.         "mobile": "13812312300",
    12.         "description": "",
    13.         "extension": "9527",
    14.         "email": "admin@mixlinker.com",
    15.         "address": "",
    16.         "reference": "mixlinker.pro.admin",
    17.         "created": "2018-06-14 20:00:00",
    18.         "ticket": "VXtqg4RfMM2rFsoXgKNhFjUHx2AtQAFh",
    19.         "refresh_token": "vmONEv3tyOGsoQBhCQyOXqDyqZlVixetTPEXL12CVeDIlgXXOHb3UuM9HBUhvXpN",
    20.         "keep_alive": "long",
    21.         "token": "VXtqg4RfMM2rFsoXgKNhFjUHx2AtQAFh"
    22.     }
    23. }

    备注：

    若无特殊说明，其他接口鉴权时 需要将token通过http请求头 header发送以下数据鉴权（$token表示登录返回的token数据）：

    Authorization:Bearer $token

    2.4.1.7.1.2. CheckTicket（票据校验）

    调用接口：

    属性值
    url/api/check_ticket
    http方法post
    Content-Typeapplication/json或application/x-www-form-urlencoded
    备注CheckTicket接口无需鉴权

    请求参数：

    字段字段名称字段类型说明是否必传
    source系统标识String是
    ticket票据（令牌）String是

    返回参数：

    字段字段名称字段类型说明是否必传
    code返回码Integer200：成功 500：失败是
    msg提示信息String是
    result返回结果Json是

    返回示例：

    1. {
    2.     "code":200,
    3.     "msg":"Ticket校验成功",
    4.     "mix_code":130003,
    5.     "mix_msg":"",
    6.     "mix_ext":"",
    7.     "result":{
    8.         "user_id":1001,
    9.         "username":"admin",
    10.         "is_super":1,
    11.         "description":"超级管理员",
    12.         "mobile":"13800138000",
    13.         "email":"admin@mixlinker.com",
    14.         "address":"深圳市美声创谷春谷3楼-智物联网络有限公司",
    15.         "created":"2018-10-18 16:44:17"
    16.     }
    17. }

    备注：

    CheckTicket接口提供单点登录鉴权，非单点登录时通过Login接口登录。

    2.4.1.7.1.3. RefreshToken（重新获取 Token）

    调用接口：

    属性值
    url/api/refresh_token
    http方法post
    Content-Typeapplication/json或application/x-www-form-urlencoded
    备注CheckTicket接口无需鉴权

    请求参数：

    字段字段名称字段类型说明是否必传
    refresh_token更新令牌String是
    source系统来源String如：ADMIN/MixPro/APP是

    返回参数：

    字段字段名称字段类型说明是否必传
    code返回码Integer200：成功 500：失败是
    msg提示信息String是
    result返回结果Json是

    返回示例：

    1. {
    2.     "code": 200,
    3.     "msg": "重新获取 Ticket 成功",
    4.     "mix_code": 130004,
    5.     "mix_msg": "",
    6.     "mix_ext": "",
    7.     "result": {
    8.         "user_id": 1000,
    9.         "username": "admin",
    10.         "realname": "",
    11.         "customer_id": "",
    12.         "is_super": 1,
    13.         "mobile": "13812312300",
    14.         "description": "",
    15.         "sex": "",
    16.         "position": "",
    17.         "phone": "",
    18.         "extension": "9527",
    19.         "email": "admin@mixlinker.com",
    20.         "address": "",
    21.         "template": "",
    22.         "script": "",
    23.         "reference": "mixlinker.pro.admin",
    24.         "created": "2018-06-14 20:00:00",
    25.         "ticket": "4iCJohHIaCQuoGsazi1KMm0hlMieO7rk",
    26.         "refresh_token": "MRFfbUGUWRdapLtK7Ur59EpluIoaFBmpujJzFs5H4fGj8f90g4M9vUM841jXoB5u",
    27.         "keep_alive": "default",
    28.         "token": "4iCJohHIaCQuoGsazi1KMm0hlMieO7rk"
    29.     }
    30. }

    2.4.1.7.1.4. User（当前用户信息）

    调用接口：

    属性值
    url/api/user
    http方法post
    Content-Typeapplication/json或application/x-www-form-urlencoded

    请求参数：

    字段字段名称字段类型说明是否必传
    -----

    返回参数：

    字段字段名称字段类型说明是否必传
    code返回码Integer200：成功 500：失败是
    msg提示信息String是
    result返回结果Json是

    返回示例：

    1. {
    2.     "code":200,
    3.     "msg":"查询成功",
    4.     "mix_code":130001,
    5.     "mix_msg":"",
    6.     "mix_ext":"",
    7.     "result":{
    8.         "user_id":1001,
    9.         "username":"admin",
    10.         "is_super":1,
    11.         "description":"超级管理员",
    12.         "mobile":"13800138000",
    13.         "email":"admin@mixlinker.com",
    14.         "address":"深圳市美声创谷春谷3楼-智物联网络有限公司",
    15.         "created":"2018-10-18 16:44:17"
    16.     }
    17. }

    2.4.1.7.1.5. ResetPassword（更改密码）

    调用接口：

    属性值
    url/api/reset_password
    http方法post
    Content-Typeapplication/json或application/x-www-form-urlencoded

    请求参数：

    字段字段名称字段类型说明是否必传
    old_password旧密码String是
    new_password新密码String是

    返回参数：

    字段字段名称字段类型说明是否必传
    code返回码Integer200：成功 500：失败是
    msg提示信息String是
    result返回结果Json是

    返回示例：

    1. {
    2.     "code":200,
    3.     "msg":"修改成功",
    4.     "mix_code":130004,
    5.     "mix_msg":"",
    6.     "mix_ext":"",
    7.     "result":[]
    8. }

    2.4.1.7.1.6. Upload（附件上传）

    调用接口：

    属性值
    url/api/file/upload
    http方法post
    Content-Typemultipart/form-data

    请求参数：

    字段字段名称字段类型说明是否必传
    upload_file文件File是
    type上传类型String作业：activity 服务：service 设备：equipment是

    返回参数：

    字段字段名称字段类型说明是否必传
    code返回码Integer200：成功 500：失败是
    msg提示信息String是
    result返回结果Json是

    返回示例：

    1. {
    2.     "code": 200,
    3.     "msg": "上传成功",
    4.     "mix_code":130005,
    5.     "mix_msg":"",
    6.     "mix_ext":"",
    7.     "result": {
    8.         "path": "equipment/2018/11/fangkuaizutaitu.gif"
    9.     }
    10. }

    2.4.1.7.1.7. Download（附件下载）

    调用接口：

    属性值
    url/api/file/download
    http方法get
    Content-Type无
    备注Download接口无需鉴权

    请求参数：

    字段字段名称字段类型说明是否必传
    path文件路径String是

    返回参数：

    字段字段名称字段类型说明是否必传
    code返回码Integer200：成功 500：失败否
    msg提示信息String否
    result返回结果Json否

    返回示例：

    1. {
    2.     "code": 500,
    3.     "msg": "文件不存在",
    4.     "mix_code":230006,
    5.     "mix_msg":"",
    6.     "mix_ext":"",
    7.     "result": []
    8. }

    备注：

    下载成功时，直接返回输出文件流；下载失败时，返回状态码和提示信息。

    2.4.1.7.1.8. Download（附件下载）

    调用接口：

    属性值
    url/api/setting/feedback
    http方法get
    Content-Type无

    请求参数：

    字段字段名称字段类型说明是否必传
    title反馈标题String是
    type反馈类型String是
    description反馈内容String是
    name反馈人员String否
    company公司名称String否
    email电子邮箱String否
    phone联系电话String否

    返回参数：

    字段字段名称字段类型说明是否必传
    code返回码Integer200：成功 500：失败否
    msg提示信息String否
    result返回结果Json否

    返回示例：

    1. {
    2.     "code": 200,
    3.     "msg": "反馈成功",
    4.     "mix_code":230006,
    5.     "mix_msg":"",
    6.     "mix_ext":"",
    7.     "result": []
    8. }