OpenAPI

上传资源 (计划中)

上传资源文件，其中一个用途是在报关单信息中指定随附单据（附件）的内容：

  1. 先上传文件，取得资源ID
  2. 在报关单（或其他需要附件的单证），指定用此资源ID

上传资源文件

请求

  • 接口路径：v1/resource?filename={filename}
  • 请求方法：POST
  • 请求头内容：
    • Content-Type: 对应的资源文件类型，如：application/pdf
  • 请求Body内容
    • 具体文件原文
属性 类型 是否必填 说明
filename String 非必填 档案名字

响应

  • HTTP状态: 200 代表调用成功

  • 响应正文：

{
    "success": true,
    "message": null,
    "result": "1dac7eafdaf142f9aa6b615bdc5823f1",
    "error": null
}
属性 类型 说明
success Boolean 创建是否成功 true成功 false 失败
message String 创建失败返回错误消息
result String 创建成功返回资源ID
error String 失败详细内容

修改资源文件

请求

  • 接口路径：v1/resource/{id}?filename={filename}
  • 请求方法：PUT
  • 请求头内容：
    • Content-Type: 对应的资源文件类型，如：application/pdf
  • 请求Body内容
    • 具体文件原文
属性 类型 是否必填 说明
id String 必填 资源ID
filename String 非必填 档案名字

响应

  • HTTP状态: 200 代表调用成功

  • 响应正文：

{
    "success": true,
    "message": null,
    "result": null,
    "error": null
}
属性 类型 说明
success Boolean 修改是否成功 true成功 false 失败
message String 修改失败返回错误消息
result N/A 保留
error N/A 保留

下载资源文件

请求

  • 接口路径：v1/resource/{id}
  • 请求方法：GET
属性 类型 是否必填 说明
id String 必填 资源ID

响应

  • HTTP状态:

    • 200 代表调用成功
    • 404 代表资源不存在

  • 响应头内容：

    • Content-Type: 对应的资源文件类型，如：application/pdf
    • Content-Disposition: attachment;filename={filename}（上传时未指定档案名字则不含 filename）

  • 响应Body内容

    • 具体文件原文（二进制内容）