首页 API市场 文档中心 注册 登录
首页 > 文档中心 > 开发指南 > 文件交互规范

文件交互规范

文件上传

说明:当业务接口入参涉及文件时,需先调用开放银行平台-文件上传接口进行文件上传,然后将上传成功返回的文件ID传入业务接口

调用方式

请求协议 HTTPS
请求方式 POST
请求报文格式 application/x-www-form-urlencoded
响应报文格式 application/json
请求Url /api/open/uploadFile
签名 参照【API接入规范】

参看SDK中Example.java类的 uploadFile() 方法

注意事项:单个文件上传大小不超过100M

请求参数列表

序号 请求参数 参数格式 是否必输 参数描述
1 filePath String Y 文件全路径(含文件名)

响应参数

  • 输出示例
  • 
    {
      "fileId": "group1/M00/E4/C8/CmAFGVsQ8kKABgzNAAfnmKOP3xs.50a78f",
      "requestId": 2004896396427308037,
      "fileHashValue": "50a78f12d41e3b51df45b19430e2b2f0b992357b"
    }
          
  • 输出参数说明

  • 序号 参数名 参数格式 是否必输 参数位置 参数描述
    1 fileId String Y Body 文件ID
    2 requestId String Y Body 请求ID
    3 fileHashValue String Y Body 文件哈希值(SHA1)

文件下载

说明:先调用对应业务查询接口获取文件ID,然后调用文件下载接口下载文件

调用方式

请求协议 HTTPS
请求方式 GET
请求报文格式 application/x-www-form-urlencoded
响应报文格式 application/json
请求Url /api/open/downloadFile
签名 参照【API接入规范】

参看SDK中Example.java类的 downloadFile() 方法

注意事项:单个文件下载大小不超过100M

请求参数列表

序号 请求参数 参数格式 是否必输 参数描述
1 fileId String 必输 文件ID
2 filePath String 必输 文件全路径(含文件名)

响应参数

  • 输出示例
  • 
    {
      "code": "OPEN25800",
      "msg": "下载成功",
      "traceId": "OPEN-00-LOCAL-800"
    }
          
  • 输出参数说明

  • 序号 参数名 参数格式 是否必输 参数位置 参数描述
    1 code String Y Body 响应码
    2 msg String Y Body 响应信息
    3 traceId String Y Body 跟踪ID