实验 - 使用思科 Spark(RESTful API 实验 ) 目标 RESTful API 可通过 HTTP 动词进行交互 通过使用 HTTP 动词 ( 例如 GET PUT POST 和 DELETE), 应用可以轻松地与其他应用和 Web 服务 ( 特别是云服务 ) 通信 思科 Spark 是一种云服务, 提供持久聊天 基于会议室的协作 WebRTC 视频会议, 等等 开发人员可以创建通过 Spark REST API 将特定解决方案与 Spark 集成的代码 这可能包括根据常见应用 / 程序中发生的真实事件, 实现 Spark 消息自动化 第 1 部分 : 下载并运行 Postman 第 2 部分 : 注册 / 登录思科 Spark 并在其中创建会议室 第 3 部分 : 探索面向开发人员的 Spark 第 4 部分 : 使用 Postman 来构建 POST 请求 背景 / 场景 此章向学生介绍计算机程序和代码的价值 每台计算机都需要程序来提供功能和执行特定任务 程序建立在代码的基础上, 会编写代码的人变得越来越重要 随着用户越来越关注下载和使用移动应用和 Web 应用, 软件和 API 变得越来越重要 这些应用要获得采用并取得成功, 就必须与其他应用相互集成并提供实时内容与功能 在此实验中, 我们将使用 HTTP 客户端工具 Postman, 进行 REST API 调用 所需资源 接入互联网的 PC 或移动设备 思科 Spark 帐户 Postman 应用 第 1 部分 : 下载 Postman( 如有必要 ) 为了完成此实验, 必须在计算机上安装 Postman 应用 Postman 可以为 API 开发提供很多方面的支持并且可用于 Mac Windows Linux 或 Chrome 第 1 步 : 打开浏览器并访问位于以下 URL 上的 Postmen 主页 : https://getpostman.com a. 点击适用于您的计算机的下载项 b. 将可执行文件保存至您的计算机 第 2 步 : 运行 Postman: a. 下载完成之后 双击文件以运行 Postman b. 屏幕上的说明可能会要求您创建 / 注册帐户 您不一定要这么做 c. 点击链接以访问 Postman 应用 2017 思科和 / 或其附属公司 版权所有 本文档所含内容为思科公开发布的信息 第 1 页, 共 11 页
第 2 部分 : 注册 / 登录思科 Spark 并在其中创建会议室 在您的计算机上下载并成功部署 Postman 之后, 您可以使用思科 Spark 来创建一个会议室并注册用户 后面会用到此环境 第 1 步 : 打开浏览器并访问位于以下 URL 上的思科 Spark 主页 : https://web.ciscospark.com/signin a. 输入您将用于登录或注册思科 Spark 的邮箱地址, 然后点击继续 b. 如果您输入一个尚未用于思科 Spark 的新邮箱地址, 系统会要求您验证该地址 请检查您的邮件并执行相应的步骤, 创建 Spark 密码并验证您的帐户 c. 如果您输入一个尚未用于思科 Spark 的新邮箱地址, 系统会要求您创建一个简档名称 使用您的名字, 然后点击下一步 2017 思科和 / 或其附属公司 版权所有 本文档所含内容为思科公开发布的信息 第 2 页, 共 11 页
d. 下一页可能会要求您建立团队, 您可以点击 暂时不, 因为我们此时还不需要团队 e. 下一页可能会要求您邀请成员加入, 我们将在下一步中手动执行此操作 点击 暂时跳过 2017 思科和 / 或其附属公司 版权所有 本文档所含内容为思科公开发布的信息 第 3 页, 共 11 页
第 2 步 : 在思科 Spark 中创建一间会议室 : a. 从思科 Spark 的主页, 点击最近菜单并选择全部选项 c. 在最近 / 全部菜单上点击 + 按钮邀请成员开始新的对话 为了创建会议室, 您需要邀请两人或更多人加入对话 为此, 您需要提供一个人的姓名或邮箱地址 如果此人拥有思科 Spark 帐户, 列表上应显示其姓名 如果此人没有思科 Spark 帐户, 您需要提供其邮箱地址 d. 对于演示, 您可以使用以下两个邮箱地址 : sqtest-ciscospark-travis@squared.example.com 和 sqtest-ciscospark-sheyda@squared.example.com e. 添加这两名参与者之后, 请点击带有开始聊天! 标题的按钮 您刚刚已在思科 Spark 中创建一间新会议室 2017 思科和 / 或其附属公司 版权所有 本文档所含内容为思科公开发布的信息 第 4 页, 共 11 页
f. 点击参与者姓名旁边的钢笔图标, 将此会议室重命名为更有意义的名称 将名称改为营销创意 g. 使用页面右上角的添加人员图标, 向会议室添加新用户 添加用户 : sqtest-dereksmalls@example.cisco.com 第 3 部分 : 了解面向开发人员的 Spark Spark 用户体验的重点是持续性协作会议室, 各组用户可以在其中通过即时消息 语音 视频或共享文件进行相互交流 我们将首先使用 developer.ciscospark.com UI, 然后运行 Postman 以查询 Spark API 的 /rooms REST 资源, 获取关于成员所属的现有 Spark 会议室的完整列表 : 第 1 步 : 打开浏览器并访问以下 URL: https://developer.ciscospark.com/resource-rooms.html 注意此处提供的可用方法 我们将使用 GET https://api.ciscospark.com/v1/rooms API 资源来检索与帐户关联的会议室列表 : 2017 思科和 / 或其附属公司 版权所有 本文档所含内容为思科公开发布的信息 第 5 页, 共 11 页
a. 从可用的选项中, 点击 GET https://api.ciscospark.com/v1/rooms: 除了检索会议室列表,POST 方法还会为开发人员提供什么功能? b. 如果您未注册, 您将看到一条通知消息 : 如果您未登录, 请点击 登录 如果系统要求, 请输入您之前使用的 Spark 凭证 c. 我们一起了解一下各个部分, 以便理解其用途 请求报头包含报头部分中将传递至 API 服务器的信息 我们可以看到, 内容类型 设置为 application/json; charset=utf-8, 并且授权密钥的值以 Bearer 开头, 后接访问令牌 2017 思科和 / 或其附属公司 版权所有 本文档所含内容为思科公开发布的信息 第 6 页, 共 11 页
查询参数用于查询关于特定值的信息 如果查询参数为必填项, 则必填列将会显示一个复选框 最后部分包括您在运行特定 API 调用时可能会接收的各个响应代码的详细说明 d. 当您准备就绪之后, 请点击运行按钮 在页面右侧, 您将看到 Spark 的响应 通读此响应代码 2017 思科和 / 或其附属公司 版权所有 本文档所含内容为思科公开发布的信息 第 7 页, 共 11 页
我们的帐户有两间会议室与之关联 响应 窗口右上角的 200/ 成功是什么意思? 响应代码 403 是什么意思? 第 4 部分 : 使用 Postman 来构建 POST 请求 使用 Postman 应用, 我们可以从 Spark 应用外部创建一个新的 Spark 会议室 这可以说明利用 RESTful API 并将应用与其他 Web 服务集成的强大之处和作用 创建 Spark 会议室就是一个例子 第 1 步 : 检索 Spark API 访问令牌 此令牌是一个永久开发人员令牌, 可用于在研究和开发期间访问 Spark API a. 打开浏览器并访问以下 URL: https://developer.ciscospark.com b. 点击右上角您的 简档 图片 2017 思科和 / 或其附属公司 版权所有 本文档所含内容为思科公开发布的信息 第 8 页, 共 11 页
c. 点击复制, 将您的访问令牌复制到剪贴板上 第 2 步 : 访问我们在实验的第 1 部分下载并打开的 Postman 应用 a. 找到并打开作为 REST 客户端的 Postman 应用 ( 如有必要, 请点击 重置 按钮, 清除之前输入的任何数据 ) b. 从请求方法下拉框, 选择 POST c. 在被标记为 输入请求 URL 的字段, 键入 https://api.ciscospark.com/v1/rooms 这是 API 的 /rooms 资源的 URL d. 选择报头选项卡 e. 在被标记为密钥的字段, 键入 Authorization f. 在被标记为值的字段, 键入 Bearer {access token} 将 {access token} 替换成您的 Spark API 访问令牌 注意 Bearer 和访问令牌之间要留空格 2017 思科和 / 或其附属公司 版权所有 本文档所含内容为思科公开发布的信息 第 9 页, 共 11 页
g. 在单独的报头行中, 在密钥字段将内容类型指定为密钥名称, 将此值设置为 application/json; charset=utf-8 现在, 报头 选项卡应显示如下 : h. 选择正文选项卡 i. 选择原始数据 这表示您将以纯文本的形式键入请求的正文 j. 选择 JSON 这表示此纯文本将采用 JSON 格式 2017 思科和 / 或其附属公司 版权所有 本文档所含内容为思科公开发布的信息 第 10 页, 共 11 页
k. 键入请求的正文 :{"title" : "Spark API via Postman"} l. 点击发送 查看 Postman 应用底部 响应返回关于新会议室的信息, 其标题为 Spark API via Postman 第 3 步 : 确认已通过您的 Web 浏览器创建此新会议室 : a. 导航至 https://web.ciscospark.com/ 并登录 b. 您应该会在可用会议室列表中看到此新会议室 恭喜! 您已为进行团队协作创建一间新会议室 2017 思科和 / 或其附属公司 版权所有 本文档所含内容为思科公开发布的信息 第 11 页, 共 11 页