接口路径(新):http://hn216.api.okayapi.com/api/App/CDN/UploadImg
接口路径(旧):http://hn216.api.okayapi.com/?s=App.CDN.UploadImg
接口描述: 上传 通过表单方式上传图片。如有需要,也可以使用二制流application/octet-stream格式上传。上传后,可以在小白平台-数据-素材库查看已上传的图片文件。推荐优先使用App.CDN.UploadImgByBase64接口上传。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
file | file | 必须 | 最大:2097152;范围:image/vnd.microsoft.icon/image/x-icon/image/jpg/image/jpeg/image/png/image/gif/image/bmp/image/svg+xml/application/octet-stream | 待上传的图片文件,最大2M。上传的文件,不需要纳入签名。此文件参数需要客户端通过表单方式提交。暂不支持在线测试。 | |
file_type | 字符串 | 可选 | 最大:80 | 文件分类,为空时取当前文件类型,可用于日后的文件整理和查询。例如:file_type=image/jpg,或:file=user。修改文件分类不会影响文件使用。 | |
upload_full_file_path | 字符串 | 可选 | 【仅限使用自己的七牛CDN时生效】用于指定上传图片文件的完整路径,支持目录设置和原始的文件名,例如:upload_full_file_path=images/123.jpg。为空时由系统自动生成随机文件名 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
请求(需要用表单方式传文件file):
{你的接口域名}/?s=App.CDN.UploadImg&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"url": "http://cdn7.okayapi.com/20170920223113_62b11e9002a749d4d468824b0c10bbd6"
},
"msg": ""
}
HTML表单示例:
<form class="form-horizontal" action="http://api.okayapi.com{你的接口域名}/?s=App.CDN.UploadImg&app_key=xxxxxxx&sign=xxxxx" method="post" enctype="multipart/form-data">
<input type="file" name="file">
<button type="submit" class="btn btn-success">upload</button>
</form>
注:完整的接口链接,可以在小白开放平台在线调试中生成并获取。
import yesapi from '../../utils/YesApi/yesapi.js';
在你的小程序中,调用以下代码,上传图片。
wx.chooseImage({
count: 1,
success: function (res) {
yesapi.requestAppCDNUploadImg(res.tempFilePaths[0], function (res) {
console.log('图片上传完毕:', res);
})
}
})
成功上传后,控制台可以看到输出:
图片上传完毕: {"ret":200,"data":{"err_code":0,"err_msg":"","url":"http:\/\/cdn7.okayapi.com\/yesyesapi_20200321142306_766ff9602d5550b2c69b1e9627d176ea.jpeg","id":"3177"},"msg":"V1.5.1 小白开放接口 App.CDN.UploadImg"}
依赖的上传接口是(目前只支持单张图片上传):
yesap.requestAppCDNUploadImg(imgFilePath, onSuccess, onError)
JS SDK 下载:https://github.com/yesapicn/yesapi-wxmini-sdk
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作状态码,0成功,1失败 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.url | 字符串 | 成功上传时返回的图片URL,失败时为空 |
data.https_url | 字符串 | 成功上传时返回的HTTPS图片URL,失败或不支持HTTPS时为空 |
data.id | 字符串 | 成功上传时返回的文件ID,失败时为空 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://hn216.api.okayapi.com/api/App/CDN/UploadImgByBase64
接口路径(旧):http://hn216.api.okayapi.com/?s=App.CDN.UploadImgByBase64
接口描述: 上传 为方便上传文件,可将待上传的文件二进制内容进行base64编码后上传,必须使用POST传递file参数,只是用POST请求方式还不行,一定要把file参数放到POST里,而不能拼到链接GET参数。上传后,可以在小白平台-数据-素材库查看已上传的图片文件。已经支持的格式:jpeg/jpg/gif/bmp/png/icon/svg
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
file | 字符串 | 必须 | 数据源:POST | 此参数必须使用POST方式传递,且必须进行base64编码后传递,对待上传文件二进制内容进行basse64编码后的数据,此部分数据需要纳入签名。格式示例:file=data:image/gif;base64,R0lGODlhAQABAIAAAHd3dwAAACH5BAAAAAAALAAAAAABAAEAAAICRAEAOw== | |
file_name | 字符串 | 必须 | 上传的文件名。例如:file_name=test.jpg | ||
file_type | 字符串 | 可选 | 上传的文件类型,用于纪录备忘。例如:file_type=image/jpg | ||
upload_full_file_path | 字符串 | 可选 | 【仅限使用自己的七牛CDN时生效】用于指定上传图片文件的完整路径,支持目录设置和原始的文件名,例如:upload_full_file_path=images/123.jpg。为空时由系统自动生成随机文件名 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
请求:
{你的接口域名}/?s=App.CDN.UploadImgByBase64&file={base64编码后的图片数据,例如下面这样}&file_name=aa.png&file_type=image/png&app_key={你的app_key}&sign={动态签名}
以下参数使用POST方式传递:
{
"file": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABEAAAAQCAYAAADwMZRfAAACVklEQVQ4jT1TbbLTMAxcfyVpSxhm
OsAheiyuxIE4z+PxgzaNE3+yUujLjOs0trSr1cr8+PWzm96Rc0bn3lqDtQ7DMOB0OsE5h1qP8yQr
JVjTeceioaOUAi8/ctEzyMLoR2OMrm1LmlgCxnHEwNVqRYorMpNNIaAHBxv3jLjvSAyWzNY7XfIu
yHHbdK9kKI8AOibttWFdnrp7Oeu9kbKUY+C9hycnSybWloM2Lz2fT333TBIs7/hBS7Qd8L1UGB46
ogtKIEXRQ8rwxesupUkiY6iVD2SVwT84f7qgJWoSnxv1OBLYboEKRdCnNkXXM+6WDMZpImund0yj
PsjwNWWiFEVI7jgMU1B0EblSSKEs/y+XWcud5hMMmcfHHTNZe8/sonTdC7YSj84wSEqS4ESQbIDz
+Qw3WeLybhT9Ktw4qOAfLd7ZIXlUyF7QGdSZJcl3Jq5kuke2nOUK81enhJkVwYYwgg3C9XrF7XaD
M0cLC9n10nnWlG18LHj+vX8AEhIx7rCSrVAHWefphO9fv8HbgMwE4oO806GV+rCEuEQsjxUbmyFG
rKkibxRWvCElSGvf3n7j/f0PxU0qsCyhG1xVrdS9vuO+LvD0zfz5C7Wb4Od5ppWz1idB67picF7J
SoLX7DCHPj03DbQs2VAajhlbnGn3JpesBl0uF1LcD3+QneylHMP58ksgiDh9eTyw3Fcp55hENZM7
umOD/++PY/gEQEbD8bsMYt43ipuxpZ1jMMJz2NFC1464REbsCixtXzil00j7NjQumdjCPZUNhYI6
jsBkJ0rR8A+sfY/QK75NfQAAAABJRU5ErkJggg==
",
}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"id":"100",
"url": "http://cdn7.okayapi.com/20170920223113_62b11e9002a749d4d468824b0c10bbd6"
},
"msg": ""
}
<?php
// 引入PHP SDK文件
require_once dirname(__FILE__) . '/OkayApiClient.php';
// 调用小白开放接口(根据需要,可动态调整请求参数)
$uploadFile = 'a.jpg';
$rs = OkayApiClient::request('App.CDN.UploadImgByBase64', array('file' => base64EncodeImage($uploadFile), 'file_name' => 'a.jpg', 'file_type' => 'image/jpg'));
function base64EncodeImage ($image_file) {
$base64_image = '';
$image_info = getimagesize($image_file);
$image_data = fread(fopen($image_file, 'r'), filesize($image_file));
$base64_image = 'data:' . $image_info['mime'] . ';base64,' . chunk_split(base64_encode($image_data));
return $base64_image;
}
// 输出结果
print_r($rs);
/**
Array
(
[ret] => 200
[data] => Array
(
[err_code] => 0
[err_msg] =>
[url] => http://cd8.okayapi.com/20170920223113_62b11e9002a749d4d468824b0c10bbd6
)
[msg] => 小白开放接口:App.CDN.UploadImgByBase64
)
*/
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作状态码,0成功,1失败 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.url | 字符串 | 成功上传时返回的图片URL,失败时为空 |
data.https_url | 字符串 | 成功上传时返回的HTTPS图片URL,失败或不支持HTTPS时为空 |
data.id | 字符串 | 成功上传时返回的文件ID,失败时为空 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://hn216.api.okayapi.com/api/App/CDN/UploadOfficeByBase64
接口路径(旧):http://hn216.api.okayapi.com/?s=App.CDN.UploadOfficeByBase64
接口描述: 上传 通过Base64编码后,上传Word、Excel和PPT,以及PDF、TXT文本、HTML页面、Zip压缩包、CAD等常用文件。上传后,可以在小白平台-数据-素材库查看已上传的图片文件。已经支持的格式有:doc/docx/xls/xlsx/ppt/pptx/pdf/txt/html/htm/log/key/numbers/pages/zip/rar/7z/css/js/stp/igs/dwg
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
file | 字符串 | 必须 | 数据源:POST | 此参数必须使用POST方式传递,且必须进行base64编码后传递,对待上传的Office文件二进制内容进行basse64编码后的数据,此部分数据需要纳入签名。 | |
file_name | 字符串 | 必须 | 上传的文件名,需要带上文件扩展名。例如:file_name=文档.doc | ||
file_type | 字符串 | 可选 | 上传的文件类型,用于纪录备忘。例如:file_type=doc | ||
upload_full_file_path | 字符串 | 可选 | 【仅限使用自己的七牛CDN时生效】用于指定上传图片文件的完整路径,支持目录设置和原始的文件名,例如:upload_full_file_path=images/123.jpg。为空时由系统自动生成随机文件名 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
请求:
{你的接口域名}/?s=App.CDN.UploadOfficeByBase64&file_name=11.doc&app_key={你的app_key}&sign={动态签名}
同时通过POST方式,传递Base64编码后的文件内容,例如:
file=UEsDBBQAAAAIAPxxXk9LVVb02AAAAD0CAAALABQAX3JlbHMvLnJlbHMBABAAAAAAAAAAAAAAAAAAAAAAAK2STUsDQQyG7/0VQ+7dbCuISHd7EaE3kfoDwkx2d2jng0zU+u8dRNGFUgQ95s2bh+eQzfYUjuaFpfgUO1g1LRiONjkfxw6e9vfLG9j2i80jH0lrpUw+F1NvYulgUs23iMVOHKg0KXOsmyFJIK2jjJjJHmhkXLftNcpPBvQzptm5DmTnVmD2b5n/xsbASo6U0CbhZZZ6Leq5VDjJyNqBS/ahxuWj0VQy4Hmh9e+F0jB4y3fJPgeOes6LT8rRsbusRDlfMrr6T6N541vmNYlD9xl/2eDsC/rFO1BLAwQUAAAACAD8cV5PBCHWFboAAAAbAQAAEQAUAGRvY1Byb3BzL2NvcmUueG1sAQAQAAAAAAAAAAAAAAAAAAAAAABtjk1rhEAQRO/+Cpm7tm4gBFn1llMWAklgr0Pb0WGdD6Y7GX9+JrKYS45FvXrUedzsWn5TZONdr9q6USU59JNxc68+3p+rJzUOxRlDhz7Sa/SBohjiMu8cdxh6tYiEDoBxIau5zoTL5aePVkuOcYag8aZnglPTPIIl0ZMWDb/CKhxGdVdOeCjDV1x3wYRAK1lywtDWLfyxQtHyv4O9OciNzUGllOr0sHP5UQvXy8vbfr4yjkU7JAVD8QNQSwMEFAAAAAgA/HFeT/eOlC+MAAAA1wAAABAAFABkb2NQcm9wcy9hcHAueG1sAQAQAAAAAAAAAAAAAAAAAAAAAACdzs0KwjAQBOB7nyLk3qZ6ECn9uRTPHqr3kmzagNkNyVrq2xsRfACPwzAf0w67f4gNYnKEnTxUtRSAmozDpZO36VKe5dAX7TVSgMgOksgDTJ1cmUOjVNIr+DlVucbcWIp+5hzjoshap2Ek/fSArI51fVKwM6ABU4YfKL9is/G/qCH9+Zfu0ytkT/XFG1BLAwQUAAAACAD8cV5PFQCfAFkCAADoBQAAEQAUAHdvcmQvZG9jdW1lbnQueG1sAQAQAAAAAAAAAAAAAAAAAAAAAAClVM1OGzEQvvMUK9/JbkqgYcUGoaJUHJCqpjyA4/XuWvhPYydpeuupHKoiLpV6q4R6rNTe4W1KOPIKtfcnW0KpIprD2jOe75uZzxPv7b8VPJhSMEzJBHU7EQqoJCplMk/QyZvhZh/tDzb2ZnGqyERQaQMHkCaGBBXW6jgMDSmowKajNJXuLFMgsHUm5KHKMkboYY0Mn0XRTgiUY+uSmYJpg2q2mV6HLgU8c3UJXjHNFKQaFKHGOO9hdbhkXIfwPkPDKzCTS5pulKAJyLhm2RSMgDIqs5tEibhqMPY8LaL3IPUS1HGgWpUyuUvYjcqd4K0W5ikEbR+jAmvasuX/x/YS1EQ3bIKsI6vAcDrRXiDtrnrMOLPzUtqGZvovTaetFGoN7atlWeBTx9IdFigQJD7KpQI85jRB7irRwI3+GJPT3Mkg02AWE8WVG/5h+UNhea7SuV91+XkF5TKyc05d/BTzBC2+Xy4+f6ijWcoaf+Rd4RJUfer9UElrXCA2hLEEHQDDPDiRzP05aXA8Qr4W83d/cSDNIxCKjT0wDD8CZNImqImp671XrLNfmBUPW7UfRIDlqy3XbdrBzY/z2y/Xi0/fbs4v764+Ls4ubs9+/rr+enf13sfZKrqSySMMJbbCFhSnFF7TjIJ7s7zYdq7dvaU0wxNuUQAxSxMER2mvKiNTyq4H2K4AOh+9c1HuMel2d/38uqRuv9Pf6vu9Aka9YFqBBcxsAzrG4LmV9ritng8Flhe2NcfKWiVam9Psj9OqsQQ9j3a9WZWdoP529PgINbKEzTyG7Zs92PgNUEsDBBQAAAAIAPxxXk9EvFB6NAQAANYPAAAPABQAd29yZC9zdHlsZXMueG1sAQAQAAAAAAAAAAAAAAAAAAAAAADVV11u4zYQft9TCHp3ZBtB0RqrLBwXiwRwjSBO+k5RlMWaIgWSsuxcoDfoBfrca+05OqQoWZZk1SiwQOsXc74ZDmeG8yN+/nLMmHcgUlHBQ392N/U9wrGIKd+F/vvb18mP/peHT5/LhdInRpQH4lwtytBPtc4XQaBwSjKk7kROOPASITOkgZS7oBQyzqXARCnQlrFgPp3+EGSIct+pyfAtejIk90U+wSLLkaYRZVSfrK5aTTm77+nJKJZCiUTfwb5AJAnFxFoEO2dTu8qY72V48bzjQqKIkdAHRf4D+BoL/DNJUMG0MqR8kY50lP37KrhWXrlAClMa+m80g/BsSOm9igyBi+UCq0E4XXI1vIEgpZeKotBfSoqY984pXAXxftn6gTkzApkDYqE/dfRKdRDapXsSGOVdSGWIsdUAriXdkw4YD6Ki0IzyLkqySKieiVkuKdcd9IA4VWnXVsGErDFUaOHsyhGGjOoIlzU9mzpkTyTvCOVCUQ2p3vX0owbmDXKOXI0VNcAFJ/aCjX1ty6K4MZdT5jwjUi8Z3TVnRkgRE6yKzRDfwSJwiRV00y3vUpVnJN+QYzeIBl6D5m7Ic7Qjj5Kg/SOBwureUiJRRl6M4YjjVMi1wHvDBKB0/6n7P2wh9KQG28TRuhj6jCTa0Kda6LUwlUWOCFv8sLRnhD5U9Q46QXV1NBblCupJCtbcYsXiRVa5TNmBdQwH3nN8gQWtDarIcwm9xwRkU2QR9LhuWB5jK6lF3rs140cPjITWIuvBku7SAWGiS0J4H0fdHAnOpqi0cQgzgmQ3y4BMKLusBufnEpCnU54S3qvjpl4ie//uairCbHMCDkeJJrK97ouY9IW6uG+I6pbPRlFu/DBBdDtsjNw6oVLptVXhLPwN1ybb/Gm3lPX52n+qg+UKpV0aQa9r24EFW/Uph4NyJNFOojw1BsSVmEkyzwk+x6G/MUOH2QnAoSTqYx1cpVyr6No4mBK0hkOrn9wP9JP7c+nXGOGT9+3lDGigiMYwL5CcbJf+ZauwpvedxSl4i+HmRpx1ofJe6sB4ZqD1nL8i1gvGdbkbzWwMgxwmEm5+37PlzGnHuunK5iuDkdsipM3AH4nOm+F7VxLigtmLRJ9bJ4eOWGUyLJ5tgdT9tTIqPiJn/VlS1nvxWcnWWGkbdrXP1tOrKP1rAgyN862ClWCjCsb4EeLx7FcYdKMS83+UmD0J+TGuY1SCkxVh183k5Shbje9Wze7recXtoIFEHG0z3poqPdBnKnyg0bQYVTJdt+Ci0TVnfvvrz29//N470sG9E9v49/jkGBn432UCmg5621BsD7//wJS7+tzoPRDce2MIdw+OIdZ52jwRdiCaYgRPksK2xhS+0mEKOYn/5wvk4gUxtb+xN8S/ejHMByb8fOjFcOtzoOZ8pJPV5vKWKmhwxNUr9fDpb1BLAwQUAAAACAD8cV5P9CONi+8AAAC2AgAAEgAUAHdvcmQvZm9udFRhYmxlLnhtbAEAEAAAAAAAAAAAAAAAAAAAAAAAtZHPTsMwDIfve4ood5ayA0LV0okL4gIHtj2Al7qrpfyp4qxhb0/WbScQQhrcEv+++JPj5erDWTFiZApey/t5JQV6E1ryey23m+e7R7lqZstcd8EnFoX2XGct+5SGWik2PTrgeRjQl6wL0UEq17hXOcR2iMEgc2nmrFpU1YNyQF42l34i1x4carkhhyzeMIv34OAMmB4i44kZwWpZVVJN78CRPV6rccKnYKBk+mt9hEiws3iK1Fn2Rbo+ul2w37oWf+16Koj9/VicifkWldh6KltE8bq+/TNb7OBg00/SF7QjJjJQlnjA/1FeDtzMPgFQSwMEFAAAAAgA/HFeT7WL3yYUBgAA8VUAABUAFAB3b3JkL3RoZW1lL3RoZW1lMS54bWwBABAAAAAAAAAAAAAAAAAAAAAAAO1cbW/bNhD+3l8h6OvQypItvwR1irSO0QFZZyQZ9pmWKVs1RWkknSb59TtS75acuK3Tdds5QMyXh7zj8eFRPAp+++4+ZtYdFTJK+NR23/Rsi/IgWUV8PbX/uJ2/Htvvzl+9JWdqQ2NqAZrLMzK1N0qlZ44jAygm8k2SUg51YSJioiAr1s5KkC/QS8wcr9cbOjGJuJ23F8e0T8IwCugsCXYx5SrrRFBGFGgqN1EqbYuTmE7t94zwrX1e6HjJqG4gdUHAxE1gFN+Hrrau/pJivfzAhHVH2NTumY/tnL91SgBTbdzcfHJcDlhtvRbOv9R/ZX9e1l8bNxvO/Jlf9mcAJAhgEF06Xnil7BooS7b7doeXow9NfK3/fgs/dGfj/rCB71f4QdsWF5de32vgBxXe77DdcDC4bOD9Cj9s4S/n/vxi1MAb0IZFfNs5g6V1SkiYsI+d8Pm8Bq9QTo04WXuuDtAoJp8TMYd6M7fATW6ph5SGJADYR8ruqIoCYn2iO6rFkDNKngEE8kmAsyczjviPV6CS6dStY2wVHzJVGDF2ox4YvZJGWZmwaDWHQpMxbcqJSTeQzKU1cGtBTNoSifozUpubDUlBimskrGXe9VpaaSKBDvbBvo27iLjKV2qx8AFN1G/JKivu1x1C2Y3JrWVdUF93cKyw/uj7hLkZ8Ehprt8tzX9SmlOzJiwKi+jtwB16mWhLBoTRlbZ71kExLS84RW6vNkcbsqIdxbXxud4EPie3pv9VSpzGyL2WkZ32amK8mbO+TO2J7/m2FZB0aofgGiAZp9Cf5GvbImwN+32gsgE+vxb3RjzpZpXbGxyyekNEKqSaEbnJWpmqYvvjlf6eP9B2OM0AnG/Voj92/0EtnP2ppWFIA3WgpMpCXdZJZ+3pwU6XZsv1/Cd2+oNvWrSVoMHXOI6B3+U4JpPvU+EY51UT53WP2PP9Y91UStTG0v+A9JEIGC239tvkGmbfKn2kpab263GWFGXhEnQe1wanu/pRO8i49/L7bs3Y/QPG7vVexth+h639p03ttJeoU3uEM7nWmSpZfgbZM3hA3LGsRKaQyxIL8dwqz88sXes887euN2r6W13FEw1ysideRYXFojhfgb2Gz677KK1Qf5ULylVbJquHhdDM0syxZBrMI3DAV0SqBRFEs0wfh9Xv8C9kCeiT5Cnb2iTisatc4+FEC7W29UVoveVfOyKobbFfuSGOOzST1MiJRm7ZyPFd/CFhRhnQ0CTzbUgoZrKQJDwAmdnuY+1SEa03qlwO6cVOgc1yV52N2thYVv58RcMF2CIm4sp0CIlrk4j4CuYoE1JucBbAb8ny5lE7s5GXK2NA+ghwYYAEpMKw9Tnkir8XW1O9gQebiK8XOx6UCsKmlgaZpsEiaD3jOU3E+4JfwULJ/KhXMKheexGqJ3B57XIHZLy9d7L0zWOZ1EeaMvMp4dQkFVkWdAILXIPBlmZUSyIpPLVRkzFs5dAEjFcQK/tWItpSXXdjUlDyqDmuzbcrmmx3cRQnn7OWXMdAWPRIP1a2aiyBkuvNZXYwQtGANdfHThfnQ94/PP4S89dMdRwadQUlHYdFXRHI3OU9xM8dIzNrFslFzs875qbHkZLVKTlxB4NjKekiJTsoOX5ZSjaCa0dRskmRnBg5RzzkCHKkiyNexZE+cgQ50sWRfsWRAXIEOdLFkUHFER85ghzp4ohfcWSIHEGOdHFkWHFkhBxBjnRxZFRxZIwcQY50cWRccWSCHEGOdHFkkhbpWpBXFgnGr2loRav73MDZTcJ+WSashQQzl2XGALme5eVfeQfA+N5lQC10f+Ba91sNc+Dm9N94RQDLsz8pbggG/sidFBcEec2yXvNV1wOqdTnAE305EJ7qcgD9zP/Jz2CoHimCoXrkCIbqkSMYqkeOYKgeOYKheuQIhuqRIxiqR44gRzBUjxz5mUP1ZYRe3T8Xqv/vvYvv98bVq/h5RtQzy3rmOwPtJ34Ln+E7+Kf0Eu7P5iXwHXzcuDCwjxzBwD5yBAP7yBEM7GNgHzmCgX3kCAb2kSMY2EeOYGAfOYKB/UOB/Tye77R/o6f4HZ/zV38DUEsDBBQAAAAIAPxxXk8x5G8FJgEAADcDAAAQABQAd29yZC9oZWFkZXIxLnhtbAEAEAAAAAAAAAAAAAAAAAAAAAAApZPNTsQgEMfv+xQN9y1dY4whbfey0XhWH4CltCUWhgy01beXfseYmGa98DXMb2b+A+n5UzdRJ9EpMBk5xQmJpBFQKFNl5P3t6fhIzvkh7VldYBTuGscwI7X3llHqRC01dzFYaYKtBNTchy1WFMpSCXkB0WppPL1LkgeKsuE+xHG1so7MtN7uwRXI+5CSbiZSD1hYBCGdC6eXybgS9wB/Ehau5sqsmFOSkRYNmylHrQSCg9IfBWg2FcgGzuZx/yv06hQHp1mVMXgIeErGlW42LdwtgK2O15pbudGq/9GeEVq70LTYI6vm+NHaQSAbWn1VjfJfo7QLpvtL026TAnZoP01rgrc+y2CsSaQFe6kMIL82MiOhlSQPr94OA9I8peOajv8gP3wDUEsDBBQAAAAIAPxxXk8bVUJeJgEAADcDAAAQABQAd29yZC9mb290ZXIxLnhtbAEAEAAAAAAAAAAAAAAAAAAAAAAApZPNToQwEMfv+xSkdygYY0wD7GWj8aw+QLcUaKSdZlpA394CuxBjYsh66dd0fjPznzY/fuouGiQ6BaYgWZKSSBoBlTJNQd7fnuJHciwP+chqj1G4axzDgrTeW0apE63U3CVgpQm2GlBzH7bYUKhrJeQJRK+l8fQuTR8oyo77EMe1yjpyoY12D65CPoaUdLeQRsDKIgjpXDg9LcaVuAf4k3Dlaq7MisnSgvRo2IUSayUQHNQ+FqDZUiCbOJvH/a/Qq1MSnC6qzMFDwCydV7rbtHC3ALY6Xltu5UZr/kd7RujtlabFHlk1x4/eTgLZ0Oqz6pT/mqW9Yoa/NB02KWCH9su0JnjrswzGlkRasJfGAPJzJwsSWknK8OrtNCAtczqv6fwPysM3UEsDBBQAAAAIAPxxXk+sxqm2eQIAANEEAAARABQAd29yZC9zZXR0aW5ncy54bWwBABAAAAAAAAAAAAAAAAAAAAAAAI1Uz2sUMRS+969YctJDO9vtD2XptLSU0oNVYasX8ZCdyc6GzSQhyey6iJAiUhURD1patBcPXsSjOIMUwT9lR7zmXzDzI13bRelp8r7vvbyX7327axuPYtIYIiExoz5YXGiCBqIBCzGNfHBvf2f+JthYn1sbtSVSyoKyYQuobMeBD/pK8bbnyaCPYigXGEfUkj0mYqhsKCIvhmKQ8PmAxRwq3MUEq7HXajZXQX0N80EiaLu+Yj7GgWCS9VRR0ma9Hg5Q/XEVw/9VDGPi8kZXmW/ERMgFC5CU9m0xKWezU2MK1u2bhxiNGvYDiQ+4wFQBr4BjLAQTe1BEmErHNyuua2+0am6z20x1EpuX0HAXQYtdIXGHMTWTGGLJCRxvwWAQlVmdPuSopAQa4mJx96s5K7XtFoENrBwxokrWoZ10G5E6qCRQ5Y5dF9SDCVH7sNtRjLsRbrRqGiaK7Y55H1G7R0YvjYiGiG7S8E5YP3VWFDbYYSS8W2hou16iKbuFKdoSCA7kZq9SgMBiuF/pl99Hh8DlT/TxRH+4luu3Dx7n+nmuX+b6Va5f5/rN5NOzXB/n+ujn51yfmvSrSb+ZNDPpd5OemfSHyQ5M9tRkhyY7Mdl7k52as4+z7beQ1Qb9u//JRJ9ez/W7h09y/aIqr8w9PXWqH4qtoTBGPrhg/j0WouK6ROAZf55becGWeJXrS4ee919cKVp6F3oS0Snq0R7kvGrbjRZ9QHDUV+WylY1C64wy6EatmmuVXKviygAGgTWMza4PU6zlsL/ylhy2NMWWHbY8xVYctjLFVh22WmD9MUeCYDqwirhj5VJC2AiFu1N+Bqr1cH9O63N/AFBLAwQUAAAACAD8cV5P+S7/uO4AAACXAwAAHAAUAHdvcmQvX3JlbHMvZG9jdW1lbnQueG1sLnJlbHMBABAAAAAAAAAAAAAAAAAAAAAAAK2Tz4rCMBDG7z5FmLtNq6ssi6kXEbwu9QGy6fQPtklIxmV9e4NFrSBlDzl+k8z3+zJDNtu/vmO/6HxrtIAsSYGhVqZsdS3gWOznn7DNZ5tv7CSFK75prWehR3sBDZH94tyrBnvpE2NRh5PKuF5SkK7mVqqTrJEv0nTN3dgD8hdPdigFuEOZASsuFv/jbaqqVbgz6tyjpjcI7pEovMMHT+lqJAH3ShK8gL+PsIgZoTKaCvnT4TPDozQVYhl1DnTpcDyFm57Cf8TENyhLdE/8oLMp/iruDgyN+YOe5K9j8in0jvZ/k0PxkYG//K98dgVQSwMEFAAAAAgA/HFeT1hc8cqnAQAAvwcAABMAFABbQ29udGVudF9UeXBlc10ueG1sAQAQAAAAAAAAAAAAAAAAAAAAAAC1lctOwzAQRff9iihb1LiwQAi1ZcFjCSzKB7jxJDHED9lDCX/POKFdVE7Squ0mUWZ87h2PJ/L8oVF1sgHnpdGL9DqbpQno3Aipy0X6sXqZ3qUPy8l89WvBJ7RW+0VaIdp7xnxegeI+MxY0ZQrjFEf6dCWzPP/iJbCb2eyW5UYjaJxi0EiX8yco+HeNyXND4c6X8DR57NYFq0XKra1lzpHSLGRZlHNQ+wFwo8VeddP/yjIi2zW+ktZf9Tt8Wij3HKQKW/u0ZQ9idZwI8TixVjZKhHicKGURJUI8TmAPgb2EFcVAb0M2zimzGeAoK6GH3AyOQeQ0TVHIHITJvxUhGfFPjv/I3kY3tW9OcvDWARe+AkBVZ+07WL3RH+SkgOSdO3zlinQZMe/OWE/z7yBrjt3adlADPbUkBA4l7EZ10JGkjzfc2ymErgkQB3r/GCfYDj7VPKiRbw7e02FSp3cZxaUercMDInH+/HVslUdLKMh0xdc1nL+GnfR4H/C3hkt0odUdta/oVwF3fX7/TviAMzB4Ef9OeNQf6X6E7nl6Ea3M1pK19/Fy8gdQSwECPgAUAAAACAD8cV5PS1VW9NgAAAA9AgAACwAAAAAAAAAAAAAAAAAAAAAAX3JlbHMvLnJlbHNQSwECPgAUAAAACAD8cV5PBCHWFboAAAAbAQAAEQAAAAAAAAAAAAAAAAAVAQAAZG9jUHJvcHMvY29yZS54bWxQSwECPgAUAAAACAD8cV5P946UL4wAAADXAAAAEAAAAAAAAAAAAAAAAAASAgAAZG9jUHJvcHMvYXBwLnhtbFBLAQI+ABQAAAAIAPxxXk8VAJ8AWQIAAOgFAAARAAAAAAAAAAAAAAAAAOACAAB3b3JkL2RvY3VtZW50LnhtbFBLAQI+ABQAAAAIAPxxXk9EvFB6NAQAANYPAAAPAAAAAAAAAAAAAAAAAHwFAAB3b3JkL3N0eWxlcy54bWxQSwECPgAUAAAACAD8cV5P9CONi+8AAAC2AgAAEgAAAAAAAAAAAAAAAADxCQAAd29yZC9mb250VGFibGUueG1sUEsBAj4AFAAAAAgA/HFeT7WL3yYUBgAA8VUAABUAAAAAAAAAAAAAAAAAJAsAAHdvcmQvdGhlbWUvdGhlbWUxLnhtbFBLAQI+ABQAAAAIAPxxXk8x5G8FJgEAADcDAAAQAAAAAAAAAAAAAAAAAH8RAAB3b3JkL2hlYWRlcjEueG1sUEsBAj4AFAAAAAgA/HFeTxtVQl4mAQAANwMAABAAAAAAAAAAAAAAAAAA5xIAAHdvcmQvZm9vdGVyMS54bWxQSwECPgAUAAAACAD8cV5PrMaptnkCAADRBAAAEQAAAAAAAAAAAAAAAABPFAAAd29yZC9zZXR0aW5ncy54bWxQSwECPgAUAAAACAD8cV5P+S7/uO4AAACXAwAAHAAAAAAAAAAAAAAAAAALFwAAd29yZC9fcmVscy9kb2N1bWVudC54bWwucmVsc1BLAQI+ABQAAAAIAPxxXk9YXPHKpwEAAL8HAAATAAAAAAAAAAAAAAAAAEcYAABbQ29udGVudF9UeXBlc10ueG1sUEsFBgAAAAAMAAwA+wIAADMaAAAAAA==
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"url": "http://cdn7.okayapi.com/yesyesapi_20191030143422_b942b1ee452fe5c0ed6ee141eba55359.doc",
"id": "1899"
}
}
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作状态码,0成功,1失败 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.url | 字符串 | 成功上传时返回的图片URL,失败时为空 |
data.https_url | 字符串 | 成功上传时返回的HTTPS图片URL,失败或不支持HTTPS时为空 |
data.id | 字符串 | 成功上传时返回的文件ID,失败时为空 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://hn216.api.okayapi.com/api/App/CDN/UploadOffice
接口路径(旧):http://hn216.api.okayapi.com/?s=App.CDN.UploadOffice
接口描述: 上传 通过表单,上传Word文档、PPT演示文档或Excel表格等常用文件。上传后,可以在小白平台-数据-素材库查看已上传的文件。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
file | file | 必须 | 最大:2097152 | 待上传的Office文件,最大2M。上传的文件,不需要纳入签名。 | |
file_type | 字符串 | 可选 | 最大:80 | 文件分类,为空时取当前文件类型,可用于日后的文件整理和查询。例如:file_type=image/jpg,或:file=user。修改文件分类不会影响文件使用。 | |
upload_full_file_path | 字符串 | 可选 | 【仅限使用自己的七牛CDN时生效】用于指定上传图片文件的完整路径,支持目录设置和原始的文件名,例如:upload_full_file_path=images/123.jpg。为空时由系统自动生成随机文件名 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
请求:
{你的接口域名}/?s=App.CDN.UploadOffice&file={表单方式上传office文件}&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"url": "http://cdn7.okayapi.com/20180628223401_7f9597b6b9439d4fdafb6d0262cecbfc.docx"
},
"msg": ""
}
import yesapi from '../../utils/YesApi/yesapi.js';
在小程序中调用:
wx.chooseMessageFile({
count: 1,
success: function (res) {
console.log('选择的文件:', res)
yesapi.requestAppCDNUploadOffice(res.tempFiles[0].path, function (res) {
console.log('文件上传完毕:', res);
})
}
})
成功上传后控制台输出:
文件上传完毕: {"ret":200,"data":{"err_code":0,"err_msg":"","url":"http:\/\/cdn7.okayapi.com\/yesyesapi_20200321144014_9c05d71edd8fb845810287f9b687eb79.txt","id":"3178"},"msg":"V1.5.1 小白开放接口 App.CDN.UploadOffice"}
依赖的上传接口:
yesapi.requestAppCDNUploadOffice(filePath, onSuccess, onError)
JS SDK 下载:https://github.com/yesapicn/yesapi-wxmini-sdk
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作状态码,0成功,1失败 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.url | 字符串 | 成功上传时返回的文件URL,失败时为空 |
data.https_url | 字符串 | 成功上传时返回的HTTPS文件URL,失败或不支持HTTPS时为空 |
data.id | 字符串 | 成功上传时返回的文件ID,失败时为空 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://hn216.api.okayapi.com/api/App/CDN/Delete
接口路径(旧):http://hn216.api.okayapi.com/?s=App.CDN.Delete
接口描述: 删 根据URL,删除已经上传的图片/Office文件。注意,删除后因为有CDN缓存,文件成功删除会也会在短时间内访问到。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
url | 字符串 | 必须 | 待删除的图片/Office文件链接 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://hn216.api.okayapi.com/api/App/CDN/DeleteById
接口路径(旧):http://hn216.api.okayapi.com/?s=App.CDN.DeleteById
接口描述: 删 根据素材库的ID,删除已经上传的图片/Office文件。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
id | 整型 | 必须 | 最小:1 | 待删除的ID |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://hn216.api.okayapi.com/api/App/CDN/GetDocInfoById
接口路径(旧):http://hn216.api.okayapi.com/?s=App.CDN.GetDocInfoById
接口描述: 据素材库的ID,获取图片文档信息,包括上传时间、链接、文件名、大小等。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
id | 整型 | 必须 | 最小:1 | 素材库ID |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"info": {
"id": 2703,
"file_name": "WX20200107-145014.png",
"file_type": "image/png",
"file_size": 57633,
"add_time": "2020-01-07 14:50:28",
"file_url": "http://cdn7.okayapi.com/yesyesapi_20200107145027_4473f70ad6e3c65f5e476aa1344c9d46.png",
"is_deleted": 0,
"uuid": ""
}
},
"msg": "V1.4.11 小白开放接口 App.CDN.GetDocInfoById"
}
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作状态码,0成功,1文件不存在或已被删除 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.info | 对象 | 图片文档信息,不存在时为null |
data.info.id | 整型 | ID |
data.info.file_name | 字符串 | 文件图片名称 |
data.info.file_type | 字符串 | 文件分类,或文件类型 |
data.info.file_size | 整型 | 文件大小,单位:Byte |
data.info.add_time | 字符串 | 文件上传时间 |
data.info.file_url | 字符串 | 文件图片完整链接 |
data.info.https_url | 字符串 | 成功上传时返回的HTTPS URL,失败或不支持HTTPS时为空 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://hn216.api.okayapi.com/api/App/CDN/RecordList
接口路径(旧):http://hn216.api.okayapi.com/?s=App.CDN.RecordList
接口描述: 获取图片或文件列表,支持灵活的搜索和查询。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
select | 字符串用,分割 | 可选 | 需要返回的字段,多个字段用英文逗号分割,如:select=id,file_url,默认返回全部。 | ||
file_name | 字符串 | 可选 | 需要查询的文件名,支持模糊匹配和搜索。 | ||
file_type | 字符串用,分割 | 可选 | 需要搜索的文件分类,支持同时查询多个,多个分类使用英文逗号分割。为空时查全部。例如:file_type=aa,bb,cc | ||
order_type | 整型 | 可选 | 1 | 排序类型,默认order_type=1,表示按默认的顺序,即上传时间降序;order_type=2表示上传时间升序;order_type=3,按文件名降序,order_type=4,按文件名升序;order_type=5,按文件大小降序,order_type=6,按文件大小升序。 | |
page | 整型 | 可选 | 1 | 第几页 | |
perpage | 整型 | 可选 | 20 | 最大:10000 | 分页数量 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
请求:
{你的接口域名}/?s=App.CDN.RecordList&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"list": [
{
"id": "519",
"file_name": "dogstar.gif",
"file_type": "",
"file_size": "43",
"add_time": "2019-06-20 23:03:10",
"file_url": "http://cdn7.okayapi.com/yesyesapi_20190620230310_40185ff7ff4b11773a8f93c679629253.gif"
},
{
"id": "520",
"file_name": "dogstar.gif",
"file_type": "",
"file_size": "43",
"add_time": "2019-06-20 23:03:10",
"file_url": "http://cdn7.okayapi.com/yesyesapi_20190620230310_8b169ba40d4319bbd8f2b6787a7caeae.gif"
},
// ... ...
],
"total": 478
},
"msg": "小白开放接口:App.CDN.RecordList"
}
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.total | 整型 | 上传文件的总数量 |
data.list | 字符串 | 查询或搜索的上传文件列表 |
data.list[].id | 整型 | ID |
data.list[].file_name | 字符串 | 文件图片名称 |
data.list[].file_type | 字符串 | 文件分类,或文件类型 |
data.list[].file_size | 整型 | 文件大小,单位:Byte |
data.list[].add_time | 字符串 | 文件上传时间 |
data.list[].file_url | 字符串 | 文件图片完整链接 |
data.list[].https_url | 字符串 | 成功上传时返回的HTTPS URL,失败或不支持HTTPS时为空 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://hn216.api.okayapi.com/api/App/CDN/RecordFileTypeList
接口路径(旧):http://hn216.api.okayapi.com/?s=App.CDN.RecordFileTypeList
接口描述: 获取文件的文件类型列表,支持灵活的搜索和查询。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
|
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.list | 字符串 | 上传文件类型列表 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://hn216.api.okayapi.com/api/App/CDN/MultiDeleteIds
接口路径(旧):http://hn216.api.okayapi.com/?s=App.CDN.MultiDeleteIds
接口描述: 删 批量 根据多个ID,批量删除素材
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
ids | 字符串用,分割 | 必须 | 最小:1 | 待删除的素材库ID,多个用英文逗号分割,例如:ids=1,2,3,4,5 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
// 请求
{你的接口域名}{你的接口域名}/?s=App.CDN.MultiDeleteIds&return_data=0&ids=4501,4502,4503&app_key={你的app_key}&sign={动态签名}
// 返回
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"total": 3
},
"msg": "V3.3.0 YesApi App.CDN.MultiDeleteIds"
}
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.total | 整型 | 本次删除的数量 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://hn216.api.okayapi.com/api/App/CDN/MultiDeleteBetween
接口路径(旧):http://hn216.api.okayapi.com/?s=App.CDN.MultiDeleteBetween
接口描述: 删 批量 根据起始ID,批量删除某个区间的素材
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
start_id | 整型 | 必须 | 开始素材ID | ||
end_id | 整型 | 必须 | 结束素材ID |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.total | 整型 | 本次删除的数量 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://hn216.api.okayapi.com/api/App/CDN/DownloadImg
接口路径(旧):http://hn216.api.okayapi.com/?s=App.CDN.DownloadImg
接口描述: 下载 根据图片链接,下载图片。若图片链接不是https,可通过此接口进行下载。接口支持HTTPS,以便在需要HTTPS情况下进行中转,例如微信小程序内的图片下载。直接显示下载图片
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
url | 字符串 | 必须 | 待下载的图片链接,例如:http://cd8.okayapi.com/yesyesapi_20201101154254_424a4a8794fcc1f5c88e3434ff842ae7.png。注意,此参数需要进行url编码。 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://hn216.api.okayapi.com/api/App/CDN/MultiDeleteByFile
接口路径(旧):http://hn216.api.okayapi.com/?s=App.CDN.MultiDeleteByFile
接口描述: 删 批量 根据文件名称或文件类型,批量删除素材,同时还可以指定时间范围,每次最多批量删除1000张
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
file_name | 字符串 | 可选 | 待删除的文件名称,模糊匹配,不提供不生效 | ||
file_type | 字符串 | 可选 | 待删除的文件类型/文件分类,如:jpg,精确匹配,不提供不生效 | ||
start_time | 字符串 | 可选 | 文件上传的开始时间,不提供不生效 | ||
end_time | 字符串 | 可选 | 文件上传的结束时间,不提供不生效 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.total | 整型 | 本次删除的数量 |
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+万次