有道云笔记 API
  1. 附件操作API
有道云笔记 API
  • 概述
  • 数据模型
  • 授权机制
  • 申请Consumer Key
  • 附录A:有道云笔记内容格式
  • 附录B:错误码及错误信息说明
  • 附录C: OAuth开源类库及有道云笔记SDK
  • 附录D: OAuth签名方法
  • OAuth1.0a授权说明
    • 授权流程
    • 授权请求说明
    • 请求request_token
      GET
    • 请求用户登录授权
      GET
    • 请求Access Token
      GET
  • OAuth2.0授权说明
    • OAuth 2.0授权流程
    • OAuth 2.0授权接口说明
    • 请求用户登陆授权
      GET
    • 获取AccessToken
      GET
    • OAuth1.0a的AccessToken置换成OAuth2.0的AccessToken
      GET
  • 用户操作API
    • 查看用户信息
      GET
  • 笔记本操作API
    • 查看用户全部笔记本
      POST
    • 列出笔记本下的笔记
      POST
    • 创建笔记本
      POST
    • 删除笔记本
      POST
  • 笔记操作API
    • 创建笔记
    • 查看笔记
    • 修改笔记
    • 移动笔记
    • 删除笔记
  • 分享操作API
    • 分享笔记链接
  • 附件操作API
    • 上传附件或图片
      POST
    • 下载附件/图片/图标
      GET
  1. 附件操作API

上传附件或图片

POST
/yws/open/resource/upload.json
l **是否需要用户认证:**是 (关于登录授权,参见OAuth1.0a授权说明)
l **返回结果:**操作成功时http状态为200,对于图片,返回该图片的链接URL,对于普通附件,服务器会为该附件生成一个图标文件,因此返回结果包括该附件对应的链接URL以及图标的URL;失败时http状态为500并返回错误码和错误信息,详见附录B。
需要注意的是,在附件上传完成后,使用者应该紧接着更新对应的笔记,否则不被任何笔记引用的附件将被定期的空间回收所删除。
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'http:///yws/open/resource/upload.json?oauth_token=' \
--header 'oauth_callback;' \
--header 'oauth_consumer_key;' \
--header 'oauth_signature_method;' \
--header 'oauth_verifier;' \
--header 'oauth_timestamp;' \
--header 'oauth_nonce;' \
--header 'oauth_version;' \
--header 'oauth_signature;'
响应示例响应示例
200 - 图片附件
{
  "url": "http://baseURL/yws/open/resource/28/d83f547f3055"
}

请求参数

Query 参数
oauth_token
string 
必需
请求request_token时返回的oauth_token
Header 参数
oauth_callback
string 
必需
(适用于OAuth 1.0a)回调url,该url可以为oob,代表不回调。另外url还可以跟其他参数
默认值:
{{oauth_callback}}
oauth_consumer_key
string 
必需
(适用于OAuth 1.0a)第三方应用的Consumer Key
默认值:
{{oauth_consumer_key}}
oauth_signature_method
string 
必需
(适用于OAuth 1.0a)签名方法,支持HMAC-SHA1
默认值:
{{oauth_signature_method}}
oauth_verifier
string 
必需
(适用于OAuth 1.0a)用户授权后得到的oauth_verifier,或者是授权页面显示的授权码
默认值:
{{oauth_verifier}}
oauth_timestamp
string 
必需
(适用于OAuth 1.0a)时间戳,当前时间,单位毫秒
默认值:
{% mock 'timestamp' , 'ms' %}
oauth_nonce
string 
必需
(适用于OAuth 1.0a)随机串,为了防止重放攻击,5分钟内同一用户同一应用同一时间发来的请求中oauth_nonce应不同
默认值:
{{oauth_nonce}}
oauth_version
string 
必需
(适用于OAuth 1.0a)1.0
默认值:
1.0
oauth_signature
string 
必需
(适用于OAuth 1.0a)使用consumerSecret + ’&’ + oauth_token_secret(该secret为请求request_token时返回的oauth_token_secret,即Request Token Secret)字串作为key, 而签名的内容是除oauth_signature以外的请求url内容,计算签名完毕后,使用base64编码具体签名方法见附录D
默认值:
{{oauth_signature}}
Body 参数multipart/form-data
file
file 
可选
上传的附件文件(包括附件的文件名、类型、大小、数据等),(数据类型)Multipart File/(限制)附件大小限制25M

返回响应

🟢200成功
application/json
Body
url
string 
链接URL
必需
src
string 
图标URL
必需
🔴500操作失败
上一页
分享笔记链接
下一页
下载附件/图片/图标
Built with