中国电信天翼云能力开放开发指南 v1.0

《中国电信天翼云能力开放开发指南 v1.0》由会员分享，可在线阅读，更多相关《中国电信天翼云能力开放开发指南 v1.0（34页珍藏版）》请在金锄头文库上搜索。

1、 中国电信中国电信 天翼云能力开放开发指南天翼云能力开放开发指南 版本 v1 0 中中国电信国电信股股份有限份有限公公司司 20132013 1212 中国电信天翼云能力开放接口规范 I 目目 录录 1 概述 1 1 1 什么是天翼云能力开放平台 1 1 2 天翼云能力开放平台核心能力 1 1 3 成功案例 2 2 新手指南 3 2 1 如何成为开发者 3 2 2 如何创建应用和管理应用 5 2 3 应用如何接入能力开放平台 8 2 3 1 开发流程与技术指南 8 2 3 2 新资讯的获取与联系方式 10 3 OAuth2 授权 11 3 1 天翼云能力开放平台下的授权流程 11 3 2 接口

2、文档 12 3 2 1 用户申请授权认证 open oauth2 authorize action 12 3 2 2 获取 access token open oauth2 accessToken action 14 3 3 应用签名生成算法 17 4 天翼云能力开放平台的主要功能 18 4 1 用户信息管理 19 4 2 文件管理 19 4 2 1 获取文件夹列表功能 20 4 2 2 获取文件夹信息功能 20 4 2 3 获取文件信息功能 20 4 2 4 创建文件夹功能 21 4 2 5 上传并创建文件 一次性 PUT 上传 22 4 2 6 文件上传 断点续传 22 4 2 7 文件搜

3、索功能 26 4 2 8 获取下载地址功能 26 4 2 9 重命名管理功能 27 4 2 10 复制文件功能 27 4 2 11 移动管理功能 28 4 2 12 删除管理功能 29 4 3 分享服务 29 5 常见问题及解决办法 30 5 1 应用创建与信息维护 30 5 2 应用开发问题 30 6 文档修订历史 32 中国电信天翼云能力开放接口规范 1 1 概述 1 1 什么是天翼云能力开放平台 中国电信天翼云基于 开放 创新 共赢 的理念 通过标准的数据接口与授权形式 为合作伙伴提供中国电信云存储业务的优质内容与能力 庞大且真实的用户资源 运营商级 的云存储服务能力 将帮助亿万用户体验

4、到开发者的产品 并实现有效的用户群转化 目前 具备移动客户端 网站 互联网电视等多挣应用合作类型 通过天翼云能力开放平台 您可 以获得应用中心以及更多电信渠道推荐的机会 为开发者提供可持续发展的流量以及用户增 长模式 实现双方共赢 1 2 天翼云能力开放平台核心能力 中国电信天翼云能力开放接口规范 2 1 3 成功案例 中国电信天翼云能力开放接口规范 3 2 新手指南 让你的应用在中国电信天翼云能力开放平台上运营 需要通过以下几个步骤 注册成为开发者 创建应用 提交审核 开发测试 上线 产品优化 运营 2 1 如何成为开发者 在天翼云能力开放的登录页面 点击 登陆 通过天翼帐号登录 如果未注册

5、天翼帐 号 点击下图中的 注册 前往相应页面完成天翼帐号的注册 点击 应用管理 注册成为一名开发者 开发者分为个人开发者和企业开发者两种 不同类型开发者填写信息 签署合约均不同 请根据实际情况选择您要注册的开发者类型 中国电信天翼云能力开放接口规范 4 此信息一经确认 将与您的天翼帐号绑定 不可修改 请您慎重选择 个人开发者个人开发者注册信息注册信息 所填信息包括 姓名 联系地址 手机号码 电子邮箱 请您如实填写 以便于我们和 您及时沟通联系 企业开发者企业开发者注册信息注册信息 所填信息包括 公司全称 营业执照号码 公司地址 联系人 手机号码 电子邮箱 请您如实填写 以便于我们和您及时沟通联

6、系 中国电信天翼云能力开放接口规范 5 填写完以上用户者资料 并通过邮箱进行验证 成为天翼云能力开放平台认证的开发者 2 2 如何创建应用和管理应用 完成邮箱验证之后 点击 创建应用 即可通过资料的填写进行应用的创建 在填写 应用创建资料的时候 需要注意应用分类要慎重填写 应用创建后不再支持应用分类的修改 中国电信天翼云能力开放接口规范 6 应用创建完成后 开发者可以对已创建的应用进行编辑 在提交审核之前 开发者必须 补充填写信息 应用介绍 应用网址 应用 ICON 应用介绍图片 当开发对应用信息进行 编辑时 已审核的应用 变更资料需重新审核 应用管理 为应用的创建和运营提供了良好的平台 通过

7、 我的应用 开发者可以对 已创建的应用进行管理 应用统计 让开发者对所创建应用的用户访问量一目了然 中国电信天翼云能力开放接口规范 7 在应用管理中 开发者可以在 高级信息 栏目中 设置授权回调页和重置 App Secret 其中 授权回调页 是用授权您的应用后 开放平台要回调的地址 如果应用绑定了域名 该域名下的回调地址都有效 如果您的应用还未通过审核 不能大范围推广 你可以设置测试账号来测试尚在开发中 的应用 您可以添加 20 个测试账号 来测试所开发的应用 中国电信天翼云能力开放接口规范 8 如果开发者的应用不再使用 也可以删除应用 2 3 应用如何接入能力开放平台 2 3 1 开发流程

8、与技术指南 本节主要介绍基于天翼云能力开放平台开发的基本流程 以及开发者 用户 第三方应 用 REST API 及天翼云能力开放平台之间的交互关系 基于天翼云能力开放平台的基本开发流程包括 1 注册天翼云账号 2 登录天翼云能力开放平台 注册成为天翼云开发者 3 创建应用 获得应用 ID App Key 和 App Secret 4 添加测试账号 开发应用 5 提交审核 6 发布应用 7 应用的维护和运营 中国电信天翼云能力开放接口规范 9 创建应用 获取应用ID app Key及 app Secret 提交审核 审核是否通过 开始 是否拥有天翼云账号 注册成为天翼 云用户 登陆能力开放平台

9、注册成为开发者 否 发布应用 是 已应用的资 料修改 应用的维护和运营 添加测试账号 开发应用 图 2 1 天翼云能力开放平台的基本开发流程 在开发者创建一个应用时 会自动生成唯一的 App Key 和 App Secret App Key 是应用唯 一的识别标志 天翼云能力开放平台通过 App Key 鉴别应用的身份 App Secret 是给应用分 配的密钥 开发者需要妥善保存这个密钥 从而保证应用来源的可靠性 防止被伪造 你可 通过这两个数据进行相关的技术开发工作 开发者社区开放 API 接口统一采用 HTTP 风格 如无特殊说明 所有接口均采用 HTTP 协议方式 以下技术资源将会有助

10、于开发者的应用开发 OAuth2 授权 简单安全的授权验证机制 为开发者提供安全的身份验证和用户授权 统一规范说明 提供一套标准的天翼云能力开放接口规范 对其相关参数 响应和错误码进行相关定义 REST API 按照 Rest API 规范为开发者提供 Rest 风格的 HTTP 服务端接口 常见问题及解决办法 提供开发中的常见问题及解决办法 为开发者提供参考 下图介绍了开发者 用户 第三方应用 REST API 及天翼云能力开放平台之间的交互关 中国电信天翼云能力开放接口规范 10 系 图 2 2 开发者 用户 第三方应用 REST API 及天翼云能力开放平台之间的交互关系图 2 3 2

11、新资讯的获取与联系方式 API 更新 功能发布 政策发布更新 功能发布 政策发布 更新 更新 天翼云能力开放平台开发文档下载地址 try Mac mac Mac getInstance HmacSHA1 SecretKeySpec spec new SecretKeySpec key getBytes HmacSHA1 mac init spec byteHMAC mac doFinal data getBytes catch InvalidKeyException e e printStackTrace catch NoSuchAlgorithmException ignore should

12、 never happen return ByteFormat toHex byteHMAC 示例 receive the uploading data 4 如果文件数据为空 调用 uploadFileData action 接口上传文件数据则会返回如下错误 信息 InternalError uploadData2Csrp sessionKey ea459e7e d7ec 4e8c 9d7a edb05c83c908 uploadFileId 344196154 userId 129315631 readSize 1 uploadedSize 0 fileRealSize 79832705 b

13、yteArray length 0 readSize is smaller than the fileRealSize discard the content 5 文件上传时 响应的错误码列表 错误码 描述 HTTP 状态码 FileAlreadyExists 文件或文件夹已存在 400 Bad Request FileNotFound 文件或文件夹不存在 400 Bad Request FileTooLarge 上传文件超过最大限制 400 Bad Request InsufficientStorageSpace 剩余存储空间不足 400 Bad Request InternalError

14、内部错误 500 Internal Server Error InvalidArgument 非法参数 400 Bad Request ParentNotFolder 父文件夹类型不正确 400 Bad Request PermissionDenied 访问权限不足 400 Bad Request ServiceNotOpen 云存储服务尚未开通 400 Bad Request UnknownError 未知错误 400 Bad Request UploadFileAccessViolation 上传文件访问冲突 400 Bad Request UploadFileNotFound 上传文件不

15、存在 400 Bad Request UploadFileSaveFailed 上传文件保存至云存储失败 400 Bad Request UploadFileVerifyFailed 上传文件校验失败 400 Bad Request 4 2 7 文件搜索功能 根据搜索条件获取指定的文件夹下符合搜索条件的文件或文件夹列表 该功能支持模糊 搜索 通过 searchFiles action 接口中参数的设定可以对搜索条件进行限定 4 2 8 获取下载地址功能 获取指定文件下载地址支持获取单个文件的下载地址或获取批量文件下载地址 分别由 以下两个接口实现 中国电信天翼云能力开放接口规范 27 getF

16、ileDownloadUrl action 获取指定文件下载地址 batchGetFileDownloadUrl action 批量获取文件下载地址如果 对接口的请求参数中的 short 字段为 true 时获取短地址格式下载 URL 为空或 false 时 获取原始下载 URL 在调用这两个接口之前 需要先获取文件的 ID fileId 开发者可以 根据具体情况使用以下三个接口 获取 fileId listFiles action 获取文件列表 getFileInfo action 获取文件信息 getFolderInfo action 获取文件夹信息 4 2 9 重命名管理功能 重命名管理功能支持文件和文件夹的重命名 分别由以下两个接口实现 renameFolder action 重命名文件夹 renameFile action 重命名文件 在调用这个两个接口之前 需要先获取要重命名的文件夹 ID folderId 或文件 ID fileId 从而完成指定文件夹或文件的重命名 4 2 10 复制文件功能 复制文件功能只支持文件的复制 不支持文件夹的复制 调用 copyFile ac