有道云笔记OpenAPI说明文档.PDF

有道云笔记Open API 说明文档 版本 作者 概要 日期 0.1 李崇欣 起始版本，网易内部API 说明 2011-9-13 0.2 李崇欣 反馈修订并添加API 使用示例 2011-9-16 0.3 陈超 修改安全机制模块，添加OAuth 认证 2011-11-17 0.4 李崇欣 API 接口修改 2011-12-7 0.4.4 李崇欣 添加User 接口及每个应用的默认笔记本 2012-5-29 概述 有道云笔记旨在以云存储技术帮助用户建立一个可以轻松访问、安全存储的 云笔记空间，解决了个人资料和信息跨平台跨地点的管理问题，目前已经提供了 桌面版、网页版以及部分手机型号的版本。但是用户对笔记的需求不仅仅局限于 这几种情形，对于很多非笔记应用，用户仍然可能有跨平台跨设备的存储需求。 通过开放的API ，第三方应用只需要进行简单的开发，就可以通过标准的web 协 议对有道云笔记的数据进行安全的访问与修改，而不需要搭设和维护运存储服 务，这大大降低了第三方的开发与运营成本，从而将更多的精力专注于应用本身。 本文档从技术角度对有道云笔记的开放API 进行说明，从而方便开发者的理 解和使用。 数据模型 目前有道云笔记的数据模型包括用户、笔记本、笔记以及附件四部分，下面 将对它们分别进行说明： 用户 每一个有道云笔记的账号（目前我们使用网易通行证作为账号，但是以后将 允许使用其它网站的开放认证账号，例如新浪微博账号，人人网账号）都在系统 中对应着一份用户信息，包括该用户邮箱、笔记总空间、当前使用空间、默认笔 记本、在线时间以及注册时间上次修改时间等一系列信息。 笔记本 用户通过笔记本对所有笔记进行组织管理，每一篇笔记必须属于某一个笔记 本，同时为了方便用户的区分与定位，每个笔记本也必须具有唯一的名字。目前 有道云笔记仅支持一层笔记本结构，而不支持笔记本的多层嵌套。 对于同一篇笔记，可以在两个笔记本之间进行转移，但是却不允许出现在两 个笔记本中。此外，每个用户在任何时候都有一个笔记本被标记为默认笔记本， 如果一个笔记在创建时没有特别指明笔记本，它将被放入默认笔记本中。删除一 个笔记本将删除该笔记本下的所有笔记。 虽然有道云笔记的客户端同时提供了同步笔记本与本地笔记本两种类型，但 是由于本地笔记本仅存储在用户的本机而没有上传至服务器，因此开放API 只能 创建或者访问用户同步笔记本中的笔记。 笔记 一篇笔记由一段超文本以及相关联的附件 （例如图片、文本、PPT、PDF 等） 所组成，其中超文本的内容按照一种标记语言的格式进行存储，每个附件所在的 位置都对应着一个tag ，包含着该附件路径，从而可以根据该信息找到对应附件 的数据。同时，每个笔记还包含一些属性信息，例如题目、作者、来源URL 以及 创建修改时间等，这些信息可以用来对笔记进行查找、过滤以及排序。 当一个笔记被删除时，它将被放入回收站，回收站中的笔记在一定的时间内 仍然可以访问 （Open API 不可以访问删除的笔记），但是不可以进行编辑，如果 没有进行恢复，回收站的笔记将在一定的时间后（目前为两个月）被清除。 笔记标记语言格式的详细说明见附录A 。 附件 笔记附件是附属于笔记的二进制数据，无法脱离笔记单独存在，因此如果仅 上传附件而不添加相应的笔记，则该附件会被定期的空间回收所删除。笔记附件 类似于邮件的附件，但是与邮件的附件不同的是，笔记的附件没有与笔记的内容 进行整体编码，而只是在笔记内容超文本的对应位置放置了一个tag ，附件的数 据则单独进行存储。因此如果将附件tag 在两个笔记之间进行拷贝，这两个笔记 将共享同一个附件，而对附件的修改也将同时反映在两个笔记之中。不过目前我 们尚不提供附件修改的API ，还不存在这样的问题。随着API 的晚上，以后将提 供类似的API ，因此如果第三方应用希