telechat接口文檔

Date: 2018/07/05
Author: xkan

接口格式說明

url：請求url
method：請求方式
param：請求參數(shù)
return：返回結(jié)果

返回數(shù)據(jù)格式如下

[
    'status' ==> 100,
    'desc' ==> 'ok'
    'data' ==> [
        'key' ==> 'value',
        ...
    ]
]

其中 status === 100 表示請求數(shù)據(jù)成功鉴分，其他值則表示請求失敗描验。
status 不同數(shù)字及其對應(yīng)含義自定

用戶操作類

登錄

• url: /user/login?r=1
• method: post

param

return

##返回用戶id
[JWT]{user.id}

上文表示返回一個 JSON Web Token, 載荷當(dāng)中包含 user.id 字段(data信息中)，具體實例如下：

{
"status":100,
"desc":"ok",
"data":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MTksImlhdCI6MTUzMTQ3MjE5MiwiZXhwIjoxNTMxNDcyMjUyfQ.pPkzyjgRqXzh7R9AYEAWFwyfWfJC9M7LP2kHMzxfIj4"
}

注冊

• url: /user/regist?r=1
• method: post

param

return

[JWT]{user.id}

退出登錄

• url: /user/login?r=1
• method: get

return

##返回需要登出用戶id
[JWT]{user.id}

多用戶信息

• url: /user/list?r=1
• method: get

return

[
    {id, 用戶名, 昵稱, 頭像, 個性簽名, 等級, 權(quán)限, 金幣, 簽到天數(shù), 禁言標(biāo)志},
    {...}
] 

單用戶信息

• url: /user/info?r=1
• method: get

param

return

{id, 用戶名, 昵稱, 頭像, 個性簽名, 等級, 權(quán)限, 金幣, 簽到天數(shù), 禁言標(biāo)志}

房間類

多房間信息

• url: admin/room/list?r=1
• method: get

return

[
    {id, 房間名, 圖標(biāo), 公告, 歡迎語},
    {...}
] 

單房間信息

• url: admin/room/info
• method: get

param

return

{id, 房間名, 圖標(biāo), 公告, 歡迎語}

創(chuàng)建房間接口

• url: admin/room/create
• method: post

param

return

//訪問這個接口自動創(chuàng)建該房間數(shù)據(jù)庫
{房間的id}

刪除房間接口

• url: admin/room/drop
• method: get

param

return

//訪問這個接口自動刪除該房間數(shù)據(jù)庫
{房間的id}

后臺

登錄

• url: admin/login/login
• method: post

param

return

//返回管理員id
{id}

登出

• url: admin/login/logout
• method: get

return

//返回需要登出管理員id
{id}

添加管理員

• url: admin/admin/create
• method: post

param

return

//返回已經(jīng)添加的管理員id
{id}

刪除管理員

• url: admin/admin/deladmin
• method: post

param

return

//返回已經(jīng)刪除的管理員id
{id}

單個管理員

• url: admin/admin/info
• method: post

param

return

//返回單個管理員信息
{id,user,status}

多個管理員

• url: admin/admin/list
• method: get

return

//多個管理員信息
{id,user,status}
...

修改管理員信息

• url: admin/admin/update
• method: post

param

return

//返回修改管理員id
{id}

修改管理員權(quán)限

• url: admin/admin/updatestatus
• method: post

param

return

//返回修改管理員id
{id}