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

    附录B:错误码及错误信息说明

    同理,当Open API的请求在执行时出现任何异常或错误时,系统将返回Http 500,应用程序可以根据此判断请求是否成功执行。当应用程序在进行OAuth认证,或者未经认证便调用Open API时,系统会返回OAuth错误信息,OAuth的错误码与错误信息将以json的格式进行返回,各个错误码及错误信息说明如下:
    错误码错误描述及可能原因
    1001token_rejected:consumer没有找到,consumerKey错误, consumer没有创建,或者request token或者access token 不存在于server中,或者没有获得授权的token,或者token过期
    1002parameter_rejected:这个会返回具体原因key是oauth_parameters_rejected, value是一个parameter列表
    1003version_rejected:OAuth版本号不是1.0
    1004timestamp_refused:timestamp 非5分钟内
    1005nonce_used:5分钟内该nonce被使用
    1006parameter_absent:有些参数没有发送给server
    1007signature_invalid:oauth签名异常,可能原因没有签名,签名方法和签名不一致等
    1008signature_method_rejected:oauth server没有提供该签名方法
    1009access_state_error:获取token时状态混乱,详细的信息会告知当前的状态 [AUTHORIZED | REQUEST | ACCESS | INVALID]
    1010consumer_rejected:该consumer在server中不存在,或者被禁掉。或者consumerKey改变,但是还没有反应到server的数据库中。
    1011accessor_rejected:由token得到的accessor构造异常,或者accessor中缺失某些属性,或者转换失败
    1012callback_error:request token传来的callback和以后的callback不一致。
    1013callback_domain_error:当限定callback后,发来的callback与原设置的callback的域不相同
    1014verifier_error:Verifier不一致错误
    1015permission_denied:无授权的token,或者授权后没有获取过access token
    同理,当Open API的请求在后台执行出现异常或错误时,系统也将同时错误码与错误信息以json的格式一同返回,应用程序可以根据错误码得到相应的原因,常见的错误码说明如下:
    错误码错误描述及可能原因
    206UNKNOWN_URI:错误的URI请求
    207AUTHENTICATION_FAILURE:用户认证错误
    209RESOURCE_NOT_EXIST:请求的资源(笔记本、笔记、附件等)不存在
    210USER_SPACE_FULL:用户空间已满
    214INVALID_PARAMETER:错误的传入参数,必须的参数为空等
    220USER_NOT_EXISTS:用户不存在
    221USER_ALREADY_EXISTS:用户已经存在,不能重复注册
    225PARENT_NOT_EXIST:笔记本尚不存在,不能在该笔记本下创建笔记
    231RESOURCE_ALREADY_EXIST:该笔记或者附件已经存在,不能重复创建
    304NOTE_ALREADY_DELETED:笔记已经被删除
    307INVALID_APPLICATION:无效的第三方应用,未经过用户授权或者授权失败便通过OpenAPI访问用户数据.这个一般是使用测试环境得到了access_token,利用该access_token访问了线上环境。这两套环境是独立的。Access_token不能共用。
    但是如果第三方应用未经过用户授权
    **示例:**当查看笔记路径错误时
    {
    "error" : "209",
    "message" : " Required note does not exist, path=/5AB0C6B33BD12/FE89D12134E"
    }

    Oauth 2.0错误说明#

    当Open API的请求在执行时出现任何异常或错误时,系统将返回Http 500,应用程序可以根据此判断请求是否成功执行。当应用程序在进行OAuth 2.0认证,或者未经认证便调用Open API时,系统会返回OAuth错误信息,OAuth的错误码与错误信息将以json的格式进行返回,各个错误码及错误信息说明如下:
    错误码错误描述及可能原因
    1200empty_clientId:请求参数中缺少了client_id参数 Key
    1201empty_clientSecret:请求参数中缺少了clientSecret参数
    1202client_id_miss_match:输入的client_id与期望值不一致
    1203expire_authorization_code:授权code已过期
    1204unsupported_response_type:不支持的response_type类型
    1205invalid_authorization_code:授权code无效
    1206redirectUri_has_fragment:redirect_uri中含有”#”
    1207invalid_redirectUri:redirect_uri不匹配
    1208empty_redirectUri:redirect_uri为空
    1209unauthorized_client:用户未对该应用授权
    1210unsupported_grant_type:不支持的grant_type类型
    1211unsupported_response_type:不支持的response_type类型
    1212empty_state:需要传入state参数
    1213token_secret_missing:通过OAuth 1.0a的access_token置换成OAuth 2.0可用的时候需要token_secret参数#”
    1214token_secret_miss_match:token_secret不匹配
    1215client_secret_miss_match:client_secret不匹配
    上一页
    附录A:有道云笔记内容格式
    下一页
    附录C: OAuth开源类库及有道云笔记SDK
    Built with