API参考

优质
小牛编辑
133浏览
2023-12-01

接口目录

创建白板

POST /board/api/create-board

返回字段

参数描述取值
errcode错误码,1000 为正常int
board白板信息object
board.id白板 IDstring
board.create_time创建时间string
board.rw_token有读写权限的 tokenstring
board.r_token只读权限的 tokenstring

返回示例:

{
    "board": {
        "id": "17lok52y",
        "create_time": "1",
        "rw_token": "1",
        "r_token": "1"
    },
    "errcode": 1000
}

获取一页白板

GET /board/api/get-boards

URL 参数

参数描述取值
page页数,默认 1int
limit每页个数,默认 15int

返回字段

参数描述取值
errcode错误码,1000 为正常int
boards白板列表object array
boards.id白板 IDstring
boards.create_time创建时间string
boards.rw_token有读写权限的 tokenstring
boards.r_token只读权限的 tokenstring
count总个数int

返回示例:

{
    "errcode": 1000,
    "boards": [
        {
            "id": "17lok52y",
            "create_time": "1",
            "rw_token": "1",
            "r_token": "1"
        }
    ],
    "count": 33
}

获取白板

GET /board/api/get-board

URL 参数

参数描述取值
id白板 IDstring

返回字段

参数描述取值
errcode错误码,1000 为正常int
create_time创建时间string
options用户白板操作object array
options.timestamp创建时间string
options.page页码int
options.dataJSON 数据,描述该操作string

返回示例:

{
    "errcode": 1000,
    "create_time": "2010-11-22 15:16:17 +0800 CST",
    "options": [
        {
            "board_id": 1,
            "timestamp": "1",
            "page": 1,
            "data": "1"
        }
    ]
}

获取用户白板操作

GET /board/api/get-options

URL 参数

参数描述取值
id白板 IDstring
page需要获取哪一页page,如果不填,返回所有的操作int

返回字段

参数描述取值
errcode错误码,1000 为正常int
options用户白板操作object array
options.timestamp创建时间string
options.page页码int
options.dataJSON 数据,描述该操作string

返回示例:

{
    "errcode": 1000,
    "options": [
        {
            "board_id": 1,
            "timestamp": "1",
            "page": 1,
            "data": "1"
        }
    ]
}

删除白板

POST /board/api/delete-board

URL 参数

参数描述取值
id白板 IDstring

返回字段

参数描述取值
errcode错误码,1000 为正常int

返回示例:

{
    "errcode": 1000
}

删除白板

POST /board/api/delete-boards

URL 参数

参数描述取值
ids白板 ID(用 , 隔开)string

返回字段

参数描述取值
errcode错误码,1000 为正常int

返回示例:

{
    "errcode": 1000
}