有道云笔记 API
  1. OAuth2.0授权说明
有道云笔记 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
    • 创建笔记
      POST
    • 查看笔记
      POST
    • 修改笔记
      POST
    • 移动笔记
      POST
    • 删除笔记
      POST
  • 分享操作API
    • 分享笔记链接
  • 附件操作API
    • 上传附件或图片
    • 下载附件/图片/图标
  1. OAuth2.0授权说明

OAuth 2.0授权接口说明

请求用户登陆授权#

URL: https://[baseURL]/oauth/authorize2
请求方式: GET
请求参数:
参数名称参数说明是否必需
client_id申请的consumerKey是
response_type当前只支持code是
redirect_uri授权成功之后的跳转地址,在申请consumerKey的时候会要求填入domains,只要该参数值属于所填的domains(没有domain的时候采用home page)中的任意一个即可。如果该应用没有domain信息,则该参数需要填固定的http://note.youdao.com/redirect 网址才能通过认证。是
state授权完成后会回传该参数是
display默认会根据userAgent进行自动适配,可选值web/mobile,用于适配pc或mobile设备否
返回结果:
当用户成功登录并授权成功后,通过redirect_uri的方式将code和state返回,否则返回出错信息。
备注:
请求成功后的跳转url格式如下:http://note.youdao.com/test?state=state&code=060148d3e406a80ac5f89e28f4ac633a

获取AccessToken#

URL: https://[baseURL]/oauth/access2
请求方式: GET
请求参数:
参数名称参数说明是否必需
client_id申请的consumerKey是
client_secret对应的consumerSecret是
grant_type当前只支持authorization_code是
redirect_uri授权成功之后的跳转地址,在申请consumerKey的时候会要求填入domains,只要该参数值属于所填的domains(没有domain的时候采用home page)中的任意一个即可。如果该应用没有domain信息,则该参数需要填固定的http://note.youdao.com/redirect 网址才能通过认证。是
code授权成功取得到的code是
返回结果:
调用成功返回access token,否则返回出错信息。
备注:
正常返回结果的格式如下:{"accessToken":"b43de33483491bc86090d6a707d6c3d3"}

OAuth1.0a的AccessToken置换成OAuth2.0的AccessToken#

URL: https://[baseURL]/oauth/access2
请求方式: GET
请求参数:
参数名称参数说明是否必需
client_id申请的consumerKey是
client_secret对应的consumerSecret是
tokenOAuth1.0a中授权成功后获取到的token是
token_secretOAuth1.0a中授权成功后获取到的token secret是
返回结果:
调用成功返回access token,否则返回出错信息。
备注:
该接口在调用成功之后会将对应的OAuth1.0a的token置为失效。 正常返回结果的格式如下: {"accessToken":"b43de33483491bc86090d6a707d6c3d3"}

通过OAuth2.0授权的token访问OpenAPI#

对于普通的post和get请求,只需要增加oauth_token参数即可,参数值为去得到的accessToken。
对于Content-Type为multipart/form-data的post请求,需要在访问中增加一个名为Authorization的header,格式为:OAuth oauth_token="%accessToken%",其中%accessToken%即为取到的accessToken(引号必需)。用OAuth2.0 协议访问 OpenAPI 时需要使用 https 协议。
上一页
OAuth 2.0授权流程
下一页
请求用户登陆授权
Built with