APICloud数据云API文档.docVIP

REST API 详解 Restful API可以让您用任何可以发送 http 请求的设备来与 API Cloud 进行交互, 您可以使用 Restful API 做以下事情, 例如: 一个移动网站可以通过 Javascript 来获取 API Cloud 上的数据. 一个网站可以展示来自 API Cloud 的数据。 您可以上传大量的数据, 之后可以被一个移动 app 读取。 使用任何语言写的程序都可以操作 API Cloud 上的数据。 如果您不再需要使用 API Cloud，您可以导出您所有的数据。 API 版本 1.0 版本：2014年9月15日发布。 快速参考 所有的API访问都是通过HTTP进行的。相关API访问需要在/mcm/api?下。 对象 URL HTTP 功能 /mcm/api/className POST 创建对象 /mcm/api/className/objectId GET 获取对象 /mcm/api/className/objectId PUT 更新对象 /mcm/api/className GET 查询对象 /mcm/api/className/objectId DELETE 删除对象 用户 URL HTTP 功能 /mcm/api/user/ POST 新增用户 /mcm/api/user/login GET 登录 /mcm/api/user/logout GET 登出 /mcm/api/user/verifyEmail POST 发送验证邮件 /mcm/api/user/resetRequest POST 密码重置 /mcm/api/user/objectId GET 获取用户 /mcm/api/user/objectId PUT 更改用户信息 /mcm/api/user/objectId DELETE 删除用户 角色 URL HTTP 功能 /mcm/api/role POST 创建角色 /mcm/api/role/objectId GET 获取角色 /mcm/api/role/objectId PUT 更新角色 /mcm/api/role/objectId DELETE 删除角色 请求验证 当调用 APICloud 云开发接口时，我们需要对头部信息中X-APICloud-AppKey 进行验证，X-APICloud-AppKey 的生成规则如下： your app key = SHA1（你的应用ID + UZ + 你的应用KEY +UZ + 当前时间毫秒数）.当前时间毫秒数 例如：你的应用ID是A6968565094002，而你的应用KEY是62FB16B2-0ED6-B460-1F60-EB61954C823B，则你在请求头部信息X-APICloud-AppKey中设置的值应为 A6968565094002+’UZ’+62FB16B2-0ED6-B460-1F60-EB61954C823B+’UZ’+当前时间毫秒数组合字符串后通过SHA1加密后返回的字符串＋.当前时间毫秒数。 示例代码如下： var now = Date.now(); var appKey = sha1(“A6968565094002+”UZ”+” 62FB16B2-0ED6-B460-1F60-EB61954C823B”+UZ+now)+”.”+now 请求格式 对于POST和PUT请求，请求的主体必须是 JSON 格式，而且 HTTP header 的 Content-Type 需要设置为 application/json。 用户验证是通过 HTTP header 来进行的。X-APICloud-AppId头标明正在运行的是哪个App程序，而X-APICloud-AppKey头用来授权鉴定终端。 对于 Javascript 使用，API Cloud 支持跨域资源共享，所以您可以将这些 header 同 XMLHttpRequest 一同使用。 响应格式 对于所有的请求的响应格式都是一个 JSON 对象。 一个请求是否成功是由 HTTP 状态码标明的。一个 2XX 的状态码表示成功，而一个 4XX 表示请求失败。当一个请求失败时响应的主体仍然是一个 JSON 对象，但是总是会包含 code。 您可以用它们来进行调试。 对象 对象格式 通过 REST API 保存数据需要将对象的数据通过 JSON 来编码。 这个数据是无模式化的（Schema Free），这意味着您不需要提前标注每个对象上有那些 key。您只需要随意设置 key-value 对就可以， 后端会存储它的。举个例子，假设您准备设置一个公司信息。一个简单的对象可能包含： { name: API Clou