【星云网盘】开放接口文档

【星云网盘】开放接口文档

  • 下文中我们将调用开放接口的开发者称之为:使用者,将提供开放接口的开发者称之为:提供者。
  • 本文接口全部基于签名访问
  • 参考OSS是静态存储技术。
  • 采用了虚拟存储管理技术来扩充存储器。

签名说明

  • 下文中我们将调用开放接口的开发者称之为:使用者,将提供开放接口的开发者称之为:提供者。
  • 签名验证,提供者,要对外提供开放接口时,调用基础服务验证请求是否有权限。
  • 应用权限分为,应用权限,用户应用权限,用户应用权限是需要用户在登录时授权的权限。
  • 提供者,只需要在使用者传来的数据中加入下面数据,提供者需要调用/verify_sign接口验证签名
    myAppId:是提供者在开放平台申请的,
    authorityCode:权限code,该接口的权限标识,是提供者在开放平台创建的应用权限或用户应用权限code
    userId:用户id,验证用户权限时必填,不验证用户权限可以不填。
  • 使用者,在使用提供者提供的接口的时候需要传递:
    signType:签名类型
    appId:应用id,使用者在开放平台申请的。
    sign:签名
    signData:签名的数据
  • 签名类型详解
    md5:md5签名,使用BASE64编码signData。
    aes:aes签名,使用BASE64编码signData。
    aes_md5:aes和md5结合签名,signData使用aes加密,签名使用md5,适用于安全级别比较高的调用。
    在使用aes_md5签名方式的时候开放平台会返回签名数据给提供者,由提供者使用自己的appSecret使用aes进行解密获取数据
  • 签名规则
    签名的字段按26个字母的顺序排序,
    然后转换成json拼接上appSecret秘钥
    使用md5/aes加密字符串
    签名必须是字符串

文件服务开放接口

删除文件


描述

删除文件

接口

/open/file

请求方法

DELETE

入参

字段 必填 类型 描述
paths query 文件的路径地址集合,包含文件名
urls query 文件的url地址集合

返回参数【无】

字段 类型 描述

获取文件


描述

获取文件

接口

/open/file

请求方法

GET

入参

字段 必填 类型 描述
paths query 文件的路径地址集合,包含文件名
urls query 文件的url地址集合

返回参数【集合】

字段 类型 描述
id String 主键id
name String 文件名称
size Long 文件大小
folderId String 文件夹主键
userId String 用户id
hashCode String 文件源id
status String 状态:0:有效,1:无效
createTime Date 创建时间
updateTime Date 更新时间
url String 下载地址
path String 文件夹路径

删除文件夹


描述

删除文件夹

接口

/open/folder

请求方法

DELETE

入参

字段 必填 类型 描述
path path 路径

返回参数【无】

字段 类型 描述

修改文件状态为有效状态


描述

修改文件状态为有效状态

接口

/open/file_status/valid

请求方法

PUT

入参

字段 必填 类型 描述
paths query 文件的路径地址集合,包含文件名
urls query 文件的url地址集合

返回参数【集合】

字段 类型 描述
id String 主键id
name String 文件名称
size Long 文件大小
folderId String 文件夹主键
userId String 用户id
hashCode String 文件源id
status String 状态:0:有效,1:无效
createTime Date 创建时间
updateTime Date 更新时间
url String 下载地址
path String 文件夹路径

签名上传


描述

签名上传,formData方式提交

接口

/open/sign_upload/file

请求方法

POST

入参【form-data方式提交】

字段 必填 类型 描述
appId body 应用名称
sign body 签名
timeStamp body 时间戳
randomStr body 随机字符串
fixedPath body 固定的文件路径
name body 文件名称
hashCode body 文件hash值,文件的唯一值,md5加密计算
fileIndex body 文件续传开始的位置
size body 文件大小
folderPath body 文件夹路径
resumed body 是否开启断点续传
resumed body 是否开启断点续传,true:开启,false:不开启
status body 状态:0:有效,1:无效

返回参数【对象】

字段 类型 描述
fileIndex Long 文件续传索引
hashCode String 文件hash值
uploadUrl String 上传地址
finish Boolean 是否完成,true:完成,false:未完成
fastFinish boolean 是否是秒传,true:是,false:不是
renewalSize Long 每次上传文件大小
filePath String 用文件存储位置,网盘文件夹路径
downloadUrl String 下载地址

联系方式

  1. 技术交流讨论群:887216693
  2. 如果发现项目中有bug请加群反馈,我们将第一时间修复bug。
  3. 有问题请加群询问群主或管理员,我们承诺一定在第一时间回复你。
  4. 我们也支持定制版本开发,如有需要请联系我们。
  5. 星云项目官网:点击跳转
  6. 由于本人没什么设计天赋,在ui方面做的还不足,如有愿意为开源事业做贡献的ui设计师,可以联系本人,谢谢。

很赞哦! (0)

文章评论