API参考

接口目录

• 创建文档
• 获取文档列表
• 获取文档
• 获取文档图片列表
• 更新文档
• 删除文档
• 批量删除文档
• 错误码
• 消息通知

创建文档

POST /doc/api/create

先调用存储微服务的上传文件接口，拿到 storage_id 上传的文档标题可以为空。若为空，取存储的文件名，去掉文件名的扩展名作为文档标题

JSON 参数

返回字段

返回示例：

{
    "errcode": 1000,
    "id": "17lok52y",
    "msg": "OK"
}

获取文档列表

GET /doc/api/list

文档状态表：

URL 参数

返回字段

返回示例：

{
    "count": 33,
    "docs": [
        {
            "id": "17lok52y",
            "created_at": "2010-11-22T15:16:17+08:00",
            "updated_at": "2010-11-22T15:16:17+08:00",
            "storage_id": "1",
            "status": 1,
            "access": "1",
            "title": "1",
            "uploader_name": "1",
            "page_count": 1
        }
    ],
    "errcode": 1000,
    "msg": "OK"
}

获取文档

GET /doc/api/get

URL 参数

返回字段

返回示例：

{
    "doc": {
        "id": "17lok52y",
        "created_at": "2010-11-22T15:16:17+08:00",
        "updated_at": "2010-11-22T15:16:17+08:00",
        "storage_id": "1",
        "status": 1,
        "access": "1",
        "title": "1",
        "uploader_name": "1",
        "page_count": 1
    },
    "errcode": 1000,
    "msg": "OK"
}

获取文档图片列表

GET /doc/api/list_images

URL 参数

返回字段

返回示例：

{
    "errcode": 1000,
    "images": [
        {
            "index": 1,
            "url": "https://www.xnip.cn/wp-content/uploads/2021/docimg28/61-jb30pi5sauj.png"
        }
    ],
    "msg": "OK"
}

更新文档

POST /doc/api/update

URL 参数

JSON 参数

返回字段

返回示例：

{
    "errcode": 1000,
    "msg": "OK"
}

删除文档

POST /doc/api/delete

URL 参数

返回字段

返回示例：

{
    "errcode": 1000,
    "msg": "OK"
}

批量删除文档

POST /doc/api/delete_docs

URL 参数

返回字段

返回示例：

{
    "errcode": 1000,
    "msg": "OK"
}

错误码

消息通知

文档转码成功

{"id":"17lok52y","status":"finished"}

文档转码失败

{"id":"17lok52y","status":"failed","err_msg":"document format does not match"}