有道云笔记 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
      • 上传附件或图片
      • 下载附件/图片/图标

    数据模型

    目前有道云笔记的数据模型包括用户、笔记本、笔记以及附件四部分,下面将对它们分别进行说明:

    用户#

    每一个有道云笔记的账号(目前我们使用网易通行证作为账号,但是以后将允许使用其它网站的开放认证账号,例如新浪微博账号,人人网账号)都在系统中对应着一份用户信息,包括该用户邮箱、笔记总空间、当前使用空间、默认笔记本、在线时间、注册时间以及上次修改时间等一系列信息。

    笔记本#

    用户通过笔记本对所有笔记进行组织管理,每一篇笔记必须属于某一个笔记本,同时为了方便用户的区分与定位,每个笔记本也必须具有唯一的名字。目前有道云笔记仅支持一层笔记本结构,而不支持笔记本的多层嵌套。
    对于同一篇笔记,可以在两个笔记本之间进行转移,但是却不允许出现在两个笔记本中。此外,每个用户在任何时候都有一个笔记本被标记为默认笔记本,如果一个笔记在创建时没有特别指明笔记本,它将被放入默认笔记本中。删除一个笔记本将删除该笔记本下的所有笔记。
    虽然有道云笔记的客户端同时提供了同步笔记本与本地笔记本两种类型,但是由于本地笔记本仅存储在用户的本机而没有上传至服务器,因此开放API只能创建或者访问用户同步笔记本中的笔记。

    笔记#

    一篇笔记由一段超文本以及相关联的附件(例如图片、文本、PPT、PDF等)所组成,其中超文本的内容按照一种标记语言的格式进行存储,每个附件所在的位置都对应着一个tag,包含着该附件路径,从而可以根据该信息找到对应附件的数据。同时,每个笔记还包含一些属性信息,例如题目、作者、来源URL以及创建修改时间等,这些信息可以用来对笔记进行查找、过滤以及排序。
    当一个笔记被删除时,它将被放入回收站,回收站中的笔记在一定的时间内仍然可以访问(Open API不可以访问删除的笔记),但是不可以进行编辑,如果没有进行恢复,回收站的笔记将在一定的时间后(目前为两个月)被清除。
    笔记标记语言格式的详细说明见附录A。

    附件#

    笔记附件是附属于笔记的二进制数据,无法脱离笔记单独存在,因此如果仅上传附件而不添加相应的笔记,则该附件会被定期的空间回收所删除。笔记附件类似于邮件的附件,但是与邮件的附件不同的是,笔记的附件没有与笔记的内容进行整体编码,而只是在笔记内容超文本的对应位置放置了一个tag,附件的数据则单独进行存储。因此如果将附件tag在两个笔记之间进行拷贝,这两个笔记将共享同一个附件,而对附件的修改也将同时反映在两个笔记之中。不过目前我们尚不提供附件修改的API,还不存在这样的问题。随着API的完善,以后将提供类似的API,因此如果第三方应用希望避免这种情况,需要自行对附件拷贝进行处理。另一方面,如果共享附件的两篇笔记中有一篇笔记被删除,不会对另外一篇笔记及其附件造成影响。
    目前笔记的附件支持除了exe、com、cmd、bat、sys以外的所有文件格式,大小限制为100MB。
    上一页
    概述
    下一页
    授权机制
    Built with