通过阅读本文,您可以了解到服务端互动白板SDK的集成及使用方法。
前提条件
您已经完成创建及配置应用。具体操作,请参见创建及配置应用。
操作步骤
- 获取AccessKey并赋予互动白板资源权限。说明 由于主账号AccessKey泄露会威胁您所有资源的安全,因此出于安全考虑,需要创建一个子账号(RAM用户)并获取子账号的AccessKey,同时赋予白板资源使用权限。
- 登录RAM控制台。
- 在左侧导航栏选择人员管理 > 用户,进入用户页面。
- 单击创建用户,填写用户账号信息,选中编程访问创建用户。说明 创建成功后请及时保存 AccessKey信息(AccessKeyId和AccessKeySecret),页面关闭后将无法再次获取。
- 在左侧导航栏选择权限管理 > 权限策略管理,进入权限策略管理界面。
- 单击创建权限策略,输入策略名称,选中脚本配置,输入如下策略内容。
{ "Statement": [ { "Effect": "Allow", "Action": "rtc-white-board:*", "Resource": "*" } ], "Version": "1" }
- 重新返回用户页面。在用户登录名称/显示名称列表下,单击目标RAM子账户,进入管理页面。
- 单击权限管理,单击添加权限。
- 选择自定义策略,将创建的互动白板自定义权限策略加入,单击确定完成授权。
- 集成互动白板服务端SDK。
以Java语言和SDK 2.0.2版本为例,通过Maven方式集成互动白板SDK,需在配置文件pom.xml中加入如下依赖:
<dependency> <groupId>com.aliyun</groupId> <artifactId>tea-openapi</artifactId> <version>0.0.13</version> </dependency> <dependency> <groupId>com.aliyun</groupId> <artifactId>rtc_white_board20201214</artifactId> <version>2.0.2</version> </dependency>
更多SDK版本及语言的集成方式,请参见互动白板服务端SDK。
- 接口及示例说明。
此处以Java SDK调用创建白板文档API为例:
import com.aliyun.rtc_white_board20201214.Client; import com.aliyun.rtc_white_board20201214.models.*; import com.aliyun.teaopenapi.models.Config; public class Test { public static void main(String[] args){ // API Config Config config = new Config(); config.accessKeyId = "yourAccessKeyId"; config.accessKeySecret = "yourAccessKeySecret"; config.regionId = "cn-shanghai"; config.endpoint = "rtc-white-board.cn-shanghai.aliyuncs.com"; // Input Parameters String appID = "********" // 控制台开通服务,8位小写字母加数字 String userId = "123456"; // 1~9位的纯数字 String requestId = ""; CreateWhiteBoardResponseBody body = null; try { Client client = new Client(config); CreateWhiteBoardRequest createWhiteBoardRequest = new CreateWhiteBoardRequest(); createWhiteBoardRequest.setAppID(appID); createWhiteBoardRequest.setUserId(userId); CreateWhiteBoardResponse response = client.createWhiteBoard(createWhiteBoardRequest); // API自动生成的请求ID,建议接入方保留,用于错误上报等 requestId = body.getRequestId(); if(response.getBody().getResponseSuccess()){ // 创建成功,获取返回体 body = response.getBody(); }else{ // 创建失败,获取错误信息 // String errorCode = response.getBody().errorCode // String errorMsg = response.getBody().errorMsg } } catch (Exception e) { // 异常处理 e.printStackTrace(); } } }
当顺序调用
createWhiteBoard
和openWhiteBoard
创建并打开白板文档时,如果成功获取到供客户端SDK使用白板连接信息,表示服务端集成成功。更多接口描述及示例,请参见API概览和互动白板OpenAPI。
在文档使用中是否遇到以下问题
更多建议
匿名提交