上传文件

POST

https://api.huoban.com/openapi/v1/file/upload

单文件上传，返回的文件ID需要放入字段中进行存储，无法单独使用。

请求参数

Header 参数

Open-Authorization

string

必需

授权的 API Key

默认值:

Bearer {{API_KEY}}

Body 参数multipart/form-data

type

string

必需

文件类型，固定为 attachment

示例值:

attachment

name

string

上传后显示的文件名

必需

示例值:

image.png

source

file

上传的文件

必需

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.huoban.com/openapi/v1/file/upload' \
--header 'Open-Authorization;' \
--form 'type="attachment"' \
--form 'name="image.png"' \
--form 'source=@""'

返回响应

🟢200成功

application/json

Body

code

integer

错误码

必需

0 为成功，小于 10000 为系统异常，其他为业务异常

message

string

错误信息

必需

具体的错误原因，code 为 0 时返回“success”

data

object

返回数据

必需

返回具体数据的结构

file_id

string

文件ID

必需

需要放入字段中进行存储

meta

object

元数据

必需

用来描述返回数据原始信息

trace_id

string

请求ID

必需

每次请求接口会返回唯一的ID

示例

{
  "code": 0,
  "message": "success",
  "data": {
    "file_id": "188532336"
  },
  "meta": {
    "trace_id": "1650350652303566"
  }
}

修改于 2022-08-23 10:06:35

批量获取文件详情

订阅事件概述