1. 文件上传

上传文件并获取上传后的文件链接信息,支持批量上传(最多10个文件,单文件大小不超过5M)。

注意

  • 如果接口需要提供auth-token,你需要通过轻筑开放平台创建应用来获取appid和secret,然后通过appid和secret来获取接口访问凭证auth-token。
  • 如果需要获取当前用户的使用信息,授权确保你能获取到qzcode,然后通过网页授权接口获取相关信息。

1.1. 1. 基本信息

概况 内容
接口地址 /api/platform/file/upload
请求方法 POST
请求数据类型 multipart/form-data
响应数据类型 JSON

1.2. 2. 请求数据

1.2.1. 请求头(request-header)

请求头除了默认的参数还需要添加如下请求头参数:

字段 描述
auth-token 接口访问凭据,你可以通过平台下发的appid和secret获取凭据
Content-Type multipart/form-data

1.2.2. 请求体(request-body)

字段 类型 是否必填 描述
files array 待上传的文件

1.3. 3. 响应数据

响应数据中 code, message, data 为默认字段,所有字段如下表所示:

字段 类型 是否必填 描述
code number 返回码,1为正常返回,其他为错误返回
message string 返回消息
data array 返回的文件信息,与上传文件列表一一对应。如果文件列表中的元素为null或无效的文件的返回对应的数组元素字段都为空字符串
key string 上传后的文件key
url string 上传后的文件url(不带签名,不能直接访问)
signedUrl string 上传后的文件url(带签名,可以直接访问,有效访问时间为20分钟,失效后需要重新获取签名)
originalFilename string 原文件名

响应数据结构如下所示:

{
    "code" : 1,
    "message" : "XXX",
    "data" : [{
        "key": "XXXX.jpg",
        "url": "https://file.example.com/XXX.jpg",
        "signedUrl": "xxxxxxxxxxxx",
        "originalFilename": "XXXXX.jpg"
    }]
}

注意如果对应的上传文件为空或者上传失败这返回的对应列表元素字段全为空。

建议在存储时保存文件的url值使用不带签名的url。在需要展示时在调用 获取文件签名 的接口获取新的带签名的文件链接,以保证能正确显示访问

1.4. 4. 错误码

当返回数据中的 code 不为 0 时,为错误返回。其中errCode为详细的错误码。

© All Rights Reserved            updated 2024-08-23 10:14:55

results matching ""

    No results matching ""