YesApi 接口文档

1505 阿里云OSS 字符串上传

接口路径(新)：http://hn216.api.okayapi.com/api/App/OSS_Aliyun/PutObject

接口路径(旧)：http://hn216.api.okayapi.com/?s=App.OSS_Aliyun.PutObject

接口描述： 阿里云OSS对象存储，简单上传，字符串上传。透传返回阿里云OSS的上传结果。

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign字符串可选公共参数接口签名，其中：
  • 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名，点击获取我的静态签名
  • 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选0公共参数 数据返回结构，其中：
  • return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}；
  • return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
object字符串必须设置文件名称
content字符串必须待上传的文件内容

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

HTTP通用示例 
请求：
{你的接口域名}/?s=App.OSS_Aliyun.PutObject&object=test.hmtl&content=haha&app_key={你的app_key}&sign={动态签名}

返回（重点关注info.url即可，对应上传成功后的地址）：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "server": "AliyunOSS",
        "date": "Tue, 02 Jun 2020 14:11:24 GMT",
        "content-length": "0",
        "connection": "keep-alive",
        "x-oss-request-id": "5ED65E0C5369E8383519E6CD",
        "etag": "\"4E4D6C332B6FE62A63AFE56171FD3725\"",
        "x-oss-hash-crc64ecma": "12320981391698477175",
        "content-md5": "Tk1sMytv5ipjr+Vhcf03JQ==",
        "x-oss-server-time": "44",
        "info": {
            "url": "http://yesapi2.oss-cn-beijing.aliyuncs.com/test.hmtl",
            "content_type": null,
            "http_code": 200,
            "header_size": 310,
            "request_size": 434,
            "filetime": -1,
            "ssl_verify_result": 0,
            "redirect_count": 0,
            "total_time": 0.119515,
            "namelookup_time": 0.004217,
            "connect_time": 0.03995,
            "pretransfer_time": 0.040002,
            "size_upload": 4,
            "size_download": 0,
            "speed_download": 0,
            "speed_upload": 33,
            "download_content_length": 0,
            "upload_content_length": 4,
            "starttransfer_time": 0.119451,
            "redirect_time": 0,
            "redirect_url": "",
            "primary_ip": "59.110.190.24",
            "certinfo": [],
            "primary_port": 80,
            "local_ip": "172.18.36.145",
            "local_port": 59338,
            "method": "PUT"
        },
        "oss-request-url": "http://yesapi2.oss-cn-beijing.aliyuncs.com/test.hmtl", // 重点关注info.url即可，对应上传成功后的地址
        "oss-redirects": 0,
                            "oss-stringtosign": "PUT\nTk1sMytv5ipjr+Vhcf03JQ==\napplication/octet-stream\nTue, 02 Jun 2020 14:11:24 GMT\n/yesapi2/test.hmtl",
            "oss-requestheaders": {
                "Accept-Encoding": "",
                "Content-Length": "4",
                "Content-Md5": "Tk1sMytv5ipjr+Vhcf03JQ==",
                    "Content-Type": "application/octet-stream",
                "Date": "Tue, 02 Jun 2020 14:11:24 GMT",
                "Host": "yesapi2.oss-cn-beijing.aliyuncs.com",
                "Authorization": "OSS LTAIswNj9Bevh5gI:FjykiUsNTke+0/TVbYiEUE9Tw54="
            },
        "body": ""
    },
    "msg": "V2.1.1 YesApi App.OSS_Aliyun.PutObject"
}

接口返回及数据结构

返回字段类型说明
ret整型接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
dataobject/array/混合接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.info.url字符串成功上传后返回的OSS链接
msg字符串提示信息，面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳，例如：1657513450
_auth字符串反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单
YesApi 接口文档

1506 阿里云OSS 文件上传

接口路径(新)：http://hn216.api.okayapi.com/api/App/OSS_Aliyun/UploadFile

接口路径(旧)：http://hn216.api.okayapi.com/?s=App.OSS_Aliyun.UploadFile

接口描述： 阿里云OSS对象存储，简单上传，文件上传，文件必须通过base64方式编码后传递。透传返回阿里云OSS的上传结果。

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign字符串可选公共参数接口签名，其中：
  • 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名，点击获取我的静态签名
  • 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选0公共参数 数据返回结构，其中：
  • return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}；
  • return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
content字符串必须此参数建议使用POST方式传递，且必须进行base64编码后传递，对待上传文件二进制内容进行basse64编码后的数据，此部分数据需要纳入签名。格式示例：content=R0lGODlhAQABAIAAAHd3dwAAACH5BAAAAAAALAAAAAABAAEAAAICRAEAOw==
object字符串必须上传的文件名。例如：object=test.jpg

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

HTTP通用示例 
请求：
{你的接口域名}/?s=App.OSS_Aliyun.UploadFile&content=R0lGODlhAQABAIAAAHd3dwAAACH5BAAAAAAALAAAAAABAAEAAAICRAEAOw==&object=test.jpg&app_key={你的app_key}&sign={动态签名}

返回（重点关注info.url即可，对应上传成功后的地址）：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "oss-request-url": "http://yesapi2.oss-cn-beijing.aliyuncs.com/test.jpg",
        "server": "AliyunOSS",
        "date": "Tue, 02 Jun 2020 14:30:54 GMT",
            "content-length": "0",
        "connection": "keep-alive",
                "x-oss-request-id": "5ED6629E50ED1C34382A3B57",
        "etag": "\"EEDC1958E803411BFC5B0405341C4320\"",
                    "x-oss-hash-crc64ecma": "2656481331512443984",
            "content-md5": "7twZWOgDQRv8WwQFNBxDIA==",
                        "x-oss-server-time": "43",
        "info": {
            "url": "http://yesapi2.oss-cn-beijing.aliyuncs.com/test.jpg", // 重点关注info.url即可，对应上传成功后的地址
            "content_type": null,
            "http_code": 200,
            "header_size": 334,
            "request_size": 398,
            "filetime": -1,
            "ssl_verify_result": 0,
            "redirect_count": 0,
            "total_time": 0.11914199999999997,
            "namelookup_time": 0.004186,
            "connect_time": 0.038564,
            "pretransfer_time": 0.038617,
            "size_upload": 43,
            "size_download": 0,
            "speed_download": 0,
            "speed_upload": 360,
            "download_content_length": 0,
            "upload_content_length": 43,
            "starttransfer_time": 0.073071,
            "redirect_time": 0,
            "redirect_url": "",
            "primary_ip": "59.110.190.24",
            "certinfo": [],
            "primary_port": 80,
            "local_ip": "172.18.36.145",
            "local_port": 32812,
            "method": "PUT"
        },
                            "oss-redirects": 0,
            "oss-stringtosign": "PUT\n\nimage/jpeg\nTue, 02 Jun 2020 14:30:54 GMT\n/yesapi2/test.jpg",
                                "oss-requestheaders": {
                                    "Accept-Encoding": "",
                                    "Content-Type": "image/jpeg",
                                    "Date": "Tue, 02 Jun 2020 14:30:54 GMT",
                                    "Host": "yesapi2.oss-cn-beijing.aliyuncs.com",
                                    "Authorization": "OSS LTAIswNj9Bevh5gI:bZkbpYb/NUIQdLlrFR4sj87wGr4="
                                },
        "body": ""
    },
    "msg": "V2.1.1 YesApi App.OSS_Aliyun.UploadFile"
}

接口返回及数据结构

返回字段类型说明
ret整型接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
dataobject/array/混合接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.info.url字符串成功上传后返回的OSS链接
msg字符串提示信息，面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳，例如：1657513450
_auth字符串反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单
YesApi 接口文档

1507 阿里云OSS 列举文件

接口路径(新)：http://hn216.api.okayapi.com/api/App/OSS_Aliyun/ListObjects

接口路径(旧)：http://hn216.api.okayapi.com/?s=App.OSS_Aliyun.ListObjects

接口描述： 阿里云OSS对象存储，列举指定存储空间（Bucket）下的所有文件或者符合条件的文件（Object）。

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign字符串可选公共参数接口签名，其中：
  • 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名，点击获取我的静态签名
  • 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选0公共参数 数据返回结构，其中：
  • return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}；
  • return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
delimiter字符串可选对文件名称进行分组的一个字符。CommonPrefixes是以delimiter结尾，并有共同前缀的文件集合。
prefix字符串可选本次查询结果的前缀。需要匹配的文件名前缀
num字符串可选100最小：1；最大：1000分页数量，列举文件的最大个数。默认为100，最大值为1000。
marker字符串可选标明本次列举文件的起点。可用于分页取下一页。

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

HTTP通用示例 
// 请求
{你的接口域名}/?s=App.OSS_Aliyun.ListObjects&num=2&app_key={你的app_key}&sign={动态签名}

// 返回
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "items": {
            "objects": [
            {
                "key": "144727_b9fb6f9574acb734b19984ccf94fd255.jpg",
                "lastModified": "2020-06-30T06:47:30.000Z",
                "eTag": "\"3752122B3E0D4AE5803B3AECE46EF58C\"",
                "type": "Normal",
                "size": 232039,
                "storageClass": "Standard"
            },
            {
                "key": "144812_954c0e9a4333ae7f92b4ff9a6e194fab.jpg",
                "lastModified": "2020-06-30T06:48:13.000Z",
                "eTag": "\"3752122B3E0D4AE5803B3AECE46EF58C\"",
                "type": "Normal",
                "size": 232039,
                "storageClass": "Standard"
            }
            ],
            "next_marker": "144812_954c0e9a4333ae7f92b4ff9a6e194fab.jpg",
            "prefix": []
        }
    },
    "msg": "V3.3.0 YesApi App.OSS_Aliyun.ListObjects"
}

// 请求（下一页）
{你的接口域名}/?s=App.OSS_Aliyun.ListObjects&num=2&marker=144812_954c0e9a4333ae7f92b4ff9a6e194fab.jpg&app_key={你的app_key}&sign={动态签名}

// 返回
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "items": {
            "objects": [
            {
                "key": "145317_fb6919d84a43fa1b8915b755f36538a5.jpg",
                "lastModified": "2020-06-30T06:53:18.000Z",
                "eTag": "\"3752122B3E0D4AE5803B3AECE46EF58C\"",
                "type": "Normal",
                "size": 232039,
                "storageClass": "Standard"
            },
            {
                "key": "145352_b0831abe10c206f79837e37200b40e81.jpg",
                "lastModified": "2020-06-30T06:53:53.000Z",
                "eTag": "\"3752122B3E0D4AE5803B3AECE46EF58C\"",
                "type": "Normal",
                "size": 232039,
                "storageClass": "Standard"
            }
            ],
            "next_marker": "145352_b0831abe10c206f79837e37200b40e81.jpg",
            "prefix": []
        }
    },
    "msg": "V3.3.0 YesApi App.OSS_Aliyun.ListObjects"
}

接口返回及数据结构

返回字段类型说明
ret整型接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
dataobject/array/混合接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.objects字符串列举的文件
data.next_marker字符串用于获取下一页
data.prefix字符串前缀
msg字符串提示信息，面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳，例如：1657513450
_auth字符串反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单
YesApi 接口文档

1508 阿里云OSS 删除文件

接口路径(新)：http://hn216.api.okayapi.com/api/App/OSS_Aliyun/DeleteObject

接口路径(旧)：http://hn216.api.okayapi.com/?s=App.OSS_Aliyun.DeleteObject

接口描述： 阿里云OSS对象存储，删除文件，支持单个或多个文件的删除。

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign字符串可选公共参数接口签名，其中：
  • 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名，点击获取我的静态签名
  • 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选0公共参数 数据返回结构，其中：
  • return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}；
  • return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
object字符串必须最小：1待删除的文件名。例如：object=test.jpg，多个文件使用竖线分割。如：object=test.jpg|123.jpg

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段类型说明
ret整型接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
dataobject/array/混合接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
msg字符串提示信息，面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳，例如：1657513450
_auth字符串反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

特别注意：当前 hn216.api.okayapi.com 为临时接口测试域名！请先完成 绑定独立接口域名后 ，才能正式进行API调用。

由 果创云YesApi.cn 提供技术支持，4万+开发者都在用，累计API调用1,800,000＋万次