YesApi 接口文档

204 base64上传常用文件 App.CDN.UploadOfficeByBase64

接口路径(新):http://api.yesapi.cn/api/App/CDN/UploadOfficeByBase64

接口路径(旧):http://api.yesapi.cn/?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/css/js/stp/igs/dwg

接口标签:免费(每月最高10万次)付费(包月/按量/私服)验签

特别注意:当前 api.yesapi.cn 为临时接口测试域名!请先完成 绑定独立接口域名后 ,才能正式进行API调用。

接口流量
5
请求协议
HTTP/HTTPS
请求方式
GET/POST(推荐POST)
编码格式
UTF-8
返回格式
JSON

在线测试接口    收藏此接口    在线接口开发    接口请求日记


接口参数 若无特殊说明,接口参数同时支持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,欢迎使用小白开放接口!"}
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。为空时由系统自动生成随机文件名

在线测试

参数是否必填
s 固定
uuid 可选
token 可选
return_data 可选
file 必须
file_name 必须
file_type 可选
upload_full_file_path 可选

客户端请求示例

查看我的接口域名、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表示服务端异常,查看异常错误码
dataobject/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密钥字符串)

ret异常错误码

错误码错误类型错误描述信息解决方法
ret = 200成功请求成功
ret = 400客户端非法请求非法请求,参数错误1、根据接口文档的接口参数,提供正确的参数
ret = 401客户端非法请求用户未登录,或登录凭证已过期1、如果用户未注册,请先用注册接口;2、如果注册未登录或会话过期,请先用登录接口
ret = 402客户端非法请求IP已被黑名单拦截1、进入接口IP设置,移除IP黑名单设置
ret = 403客户端非法请求IP未命中白名单1、进入接口IP设置,添加IP白名单设置,或清空IP白名单设置
ret = 404客户端非法请求接口服务不存在1、查看小白接口大全,确保接口服务名称拼写正确
ret = 406客户端非法请求非法app_key,请核对你所在的接口域名1、在我的套餐查看并核对接口域名
ret = 407客户端非法请求当前应用已过期1、进行续费或续约,延长应用有效期
ret = 408客户端非法请求当前应用存在异常,已被封号1、联系在线客服人工处理(系统升级维护中,或 应用存在异常已被平台封号)
ret = 409客户端非法请求签名错误1、使用在线测试,校正签名;2、关闭特定或全部签名设置;3、如果过期,可以进行续约/升级
ret = 410客户端非法请求权限不足,非系统管理员1、应用权限不足,可联系在线客服咨询沟通
ret = 411客户端非法请求权限不足,应用管理员未登录1、请提供应用管理员的admin_uuid和admin_token参数后重试
ret = 412客户端非法请求权限不足,非应用管理员1、请在果创云把会员设置为管理员
ret = 413客户端非法请求本月接口流量超出,已被临时冻结1、开通接口流量叠加包,或升级套餐
ret = 414客户端非法请求并发过高1、请降低请求频率,检测是否有死循环调用,或是否被他人恶意使用。如果流量确实很大,可联系在线客服进行定制化或私有云部署。
ret = 415客户端非法请求接口已被开发者关闭1、接口已被开发者关闭,请进入果创云接口开关重新开启
ret = 416客户端非法请求权限不足,个人免费版套餐无法使用专业版接口1、请先升级终身会员/标准版/旗舰版/企业版
ret = 417客户端非法请求子应用异常,如:子应用签名错误/已过期/流量不足1、使用主账号在管理和配置 客户端/子应用
ret = 500小白接口异常如果出现此错误,请联系技术人员处理1、进入QQ交流群897815708,反馈问题;2、或者提交工单,一天内回复

常见问题FAQ

Q1 问:出现 414 Request-URI Too Large 时怎么解决?答:对于全部参数,改用POST方式传递,并且从GET链接里面去掉。

Q2 问:浏览器请求和在线测试接口正常,但本地程序无法正常获取接口结果答:需要注意UTF编码,以及存在中文和特殊字符时的URL编码。GET请求参数应统一进行URL编码后再请求,POST表单数据正常传递即可。

Q3 问:请求接口时提示JSON格式错误答:请先阅读,然后检测本地传递的参数是否符合JSON格式,使用JSON在线工具辅助检测,注意双引号和特殊符号。确认无误后再重新请求API接口。

Q4 问:出现 405 不允许跨域请求 时怎么办?答:可以追加GET参数 &yesapi_allow_origin=1,或参考用反向代理解决跨域问题等3种解决方案。

Q4 问:在wx内无法访问yesapi.cn或okayapi.com域名,怎么办?答:由于曾经短链跳转使用被wx误封域名,可以帮忙进行申诉。申诉后截图联系我们,获取15万次接口流量奖励。