文档库相关接口

日期: 2020-09-26 00:35:47

创盛视联数码科技(北京)有限公司

一、流程说明

文档上传实际上到账户下面,要在房间内使用,需要调用关联/取消关联接口 进行操作

二、相关接口

1.上传文档

  • 描述
创建文档信息并获取上传信息, 通过返回上传信息,执行上传文档操作

注意,第一步doc_size参数需要和第二步实际上传文档大小一致

1.1 获取文档上传信息
  • 地址:
https://ccapi.csslcloud.net/api/v1/doc/add
  • 备注:
需要THQS加密请求
  • 方法:
POST/GET
  • 请求参数
参数名称 参数类型 参数说明 备注
account_id 字符串 账号ID 必须
doc_name 字符串 文件名 必须
doc_size 整型 文档大小,单位Byte(最大不能超过104857600 必须
allow_animation 整型 是否极速文档 默认为0, 0不支持 1支持ppt 2ppt极速
  • 返回数据格式:
{
  "data": {
    "upload_url": "https://document.csslcloud.net/api/document/upload?userid=41E8063FC799ACE5&docid=06EDECC84FB4F764"
  },
  "result": "OK"
}
1.2 文档上传
  • 地址:
 上传地址通过 上一步 获取文档信息接口 返回(data.upload_url)
 文件格式支持:  .doc  .docx  .ppt  .pptx  .pdf  .png
 后续支持jpg
  • 方法:
POST
  • 请求参数
参数名称 参数类型 参数说明 备注
file 二进制 文档 必须
supportanimation 整型 支持动画,0:不支持 1:支持 (只对PPT有效) 可选

备注:

file需要放到request body里面,supportanimation参数需要拼接到URL中, 如果需要

  • 返回数据格式:
{
    "datas": {
        "docId": "0A0833E541533352"
    },
    "errorCode": 0,
    "success": true
}

2.删除账户共享文件

  • 描述
实际删除账户下的共享文档
  • 地址:
https://ccapi.csslcloud.net/api/v1/doc/delete
  • 备注:
需要THQS加密请求
  • 方法:
POST/GET
  • 请求参数
参数名称 参数类型 参数说明 备注
account_id 字符串 账号ID 必须
doc_id 字符串 文档ID 必须
  • 返回数据格式:
  {
          result: 'OK', # 失败: FAIL,成功:OK
  }

3.获取账户共享文档列表

  • 描述:
获取某个账户下共享文档列表
  • 地址:
https://ccapi.csslcloud.net/api/v1/doc/list
  • 备注:
需要THQS加密请求
  • 方法:
POST/GET
  • 请求参数
参数名称 参数类型 参数说明 备注
account_id 字符串 用户账号ID 必须
page 整型 获取指定页,默认返回第一页 可选
lines 整型 每页的数据条数,默认每页50 可选
room_id 整型 查询该账户下的文档 是否与该房间已关联 可选
doc_id 整型 文档ID, 用于查询 可选
doc_name 字符串 文档名, 用于查询 可选
time_gte 日期 date/datetime 根据此参数,选择上传时间>= 该值的文档 可选
time_lte 日期 date/datetime 根据此参数,选择上传时间<= 该值的文档 可选
  • 返回数据格式:
  {
       result: "OK",
       picDomain: "https://image.csslcloud.net", # 实际去访问文档的地址
       docs: [
           {
                id: "CFD3C4FB8D2B6148", # 文件ID
                name: "MBA讲座.ppt", # 文件名称
                pageSize: 24, # 文件页数
                roomId: "2EE731074C8D64679C33DC5901307461", # 共享盘房间ID
                size: 3679232 # 文件大小
                useSDK: 0 # ppt动效 0: 未开启  1: 开启
                create_time: "2018-01-01 12:00:00" # 上传时间
                status: 1 # -2: 未上传  -1:上传失败 0: 上传成功 1: 转换成功 2: 转换中 3: 转换失败
                related: 1 #  1: 已关联 0 未关联,如果room_id参数没传,则不返回该字段
          }
          ...
       ],
       total: 1,  # 总页数
       current: 1 # 当前页数
  }

4.获取房间文档列表

  • 描述:
客户端根据返回的共享盘房间ID和文件ID去访问实际文档地址
  • 地址:
https://ccapi.csslcloud.net/api/v1/doc/auth/list
  • 备注:
需要THQS加密请求
  • 方法:
POST/GET
  • 请求参数
参数名称 参数类型 参数说明 备注
account_id 字符串 账号ID 必须
room_id 字符串 房间ID 必须
page 整型 获取指定页,默认返回第一页 可选
lines 整型 每页的数据条数,默认每页50 可选
doc_id 字符串 文件ID 用于查询 可选
doc_name 字符串 文件名 用于查询 可选
  • 返回数据格式:
  {
       result: "OK",
       picDomain: "https://image.csslcloud.net", # 实际去访问文档的地址
       docs: [
           {
                id: "CFD3C4FB8D2B6148", # 文件ID
                name: "MBA讲座.ppt", # 文件名称
                pageSize: 24, # 文件页数
                roomId: "2EE731074C8D64679C33DC5901307461", # 共享盘房间ID
                size: 3679232 # 文件大小
                useSDK: 0 # ppt动效 0: 未开启  1: 开启
                create_time: "2018-01-01 12:00:00" # 上传时间
                status: 1 # 文档状态  0 上传成功 1 转换成功 2 转换失败
          }
          ...
       ],
       total: 1,  # 总页数
       current: 1 # 当前页数
  }

5.文档关联接口

  • 描述:
将账户共享文档与房间关联, 支持批量关联
  • 地址:
https://ccapi.csslcloud.net/api/v1/doc/relate
  • 备注:
需要THQS加密请求
  • 方法:
GET/POST
  • 请求参数
参数名称 参数类型 参数说明 备注
account_id 字符串 账号ID 必须
room_id 字符串 房间ID 必须
doc_id 字符串 文档ID 必须
  • 返回数据格式:
 {
      result: 'OK', # 失败: FAIL,成功:OK
 }

6.取消文档关联

  • 描述:
将账户共享文档与房间取消关联, 支持批量取消关联
  • 地址:
https://ccapi.csslcloud.net/api/v1/doc/unrelate
  • 备注:
需要THQS加密请求
  • 方法:
GET/POST
  • 请求参数
参数名称 参数类型 参数说明 备注
account_id 字符串 账号ID 必须
room_id 字符串 房间ID 必须
doc_id 字符串 文档ID 必须
  • 返回数据格式:
 {
      result: 'OK', # 失败: FAIL,成功:OK
 }

7. 设置文档转码回调通知

  • 描述:
当文档转码成功/失败后,以API POST的方式通知客户
  • 地址:
https://ccapi.csslcloud.net/api/v1/callback/add
  • 备注:
需要THQS加密请求
文档转码完成后, 以POST方式通知的到客户
请求客户API接口参数
{
 "doc_id":"DFDFGGFD54545SFEW34552", # 文档ID
 "convert_status":1 # 转码完成为1 转码失败为3
}
如果客户收到回调通知需返回
{
 "result":"OK"
}
  • 方法:
GET/POST
  • 请求参数
参数名称 参数类型 参数说明 备注
account_id 字符串 账号ID 必须
service_name 字符串 请填写 doc 必须
action_name 字符串 请填写 doc_transcode 必须
callback_api 字符串 回调API地址 必须
switch_on 整型 回调开关 1:开启 0:关闭 必须
  • 返回数据格式:
 {
      result: 'OK', # 失败: FAIL,成功:OK
 }

8. 取消设置文档转码回调通知

  • 描述:
删除文档回调设置
  • 地址:
https://ccapi.csslcloud.net/api/v1/callback/del
  • 备注:
需要THQS加密请求
  • 方法:
GET/POST
  • 请求参数
参数名称 参数类型 参数说明 备注
account_id 字符串 账号ID 必须
service_name 字符串 请填写 doc 必须
action_name 字符串 请填写 doc_transcode 必须
  • 返回数据格式:
 {
      result: 'OK', # 失败: FAIL,成功:OK
 }

9. 更新设置文档转码回调通知

  • 描述:
更新文档回调设置
  • 地址:
https://ccapi.csslcloud.net/api/v1/callback/update
  • 备注:
需要THQS加密请求
  • 方法:
GET/POST
  • 请求参数
参数名称 参数类型 参数说明 备注
account_id 字符串 账号ID 必须
service_name 字符串 请填写 doc 必须
action_name 字符串 请填写 doc_transcode 必须
new_callback_api 字符串 新的回调URL地址 必须
  • 返回数据格式:
 {
      result: 'OK', # 失败: FAIL,成功:OK
 }

10. 获取文档下载地址

  • 描述:
获取文档下载地址
  • 地址:
https://ccapi.csslcloud.net/api/v1/doc/download
  • 备注:
需要THQS加密请求
  • 方法:
GET/POST
  • 请求参数
参数名称 参数类型 参数说明 备注
account_id 字符串 账号ID 必须
room_id 字符串 房间ID 必须
doc_id 字符串 文档ID 必须
  • 返回数据格式:
{
  // 文档信息
  "doc": {
    "uploadFileType": 2,
    "userId": "123",
    "id": "123",
    "md5": "E753B5CBAA0CC2AB62A232767B8667EB",
    "roomId": "123",
    "fileName": "第一讲 二次函数的面积.ppt",
    "useSDK": 0,
    "useSdk": false,
    "pageTitles": [
      "第一讲 二次函数下的面积问题"
    ],
    "pageSize": 12,
    "mode": 0,
    "size": 857600,
    "name": "第一讲 二次函数的面积.ppt"
  },
  // 文档下载地址
  "down_url": "http://doc-origin.csslcloud.net/document/88C79C053AFF11E39C33DC5901307461/CA982990E70632FB.ppt",
  "picDomain": "http://image.csslcloud.net",
  "result": "OK"
}

11. 文档名称重命名

  • 描述:
文档名称重命名
  • 地址:
https://ccapi.csslcloud.net/api/v1/doc/update
  • 备注:
需要THQS加密请求
  • 方法:
GET/POST
  • 请求参数
参数名称 参数类型 参数说明 备注
account_id 字符串 账号ID 必须
doc_name 字符串,长度不超过200 文档名称 必须
doc_id 字符串 文档ID 必须
  • 返回数据格式:
{
  result: 'OK', # 失败: FAIL,成功:OK
}

results matching ""

    No results matching ""