Webex Events API 入门
list-menu反馈?
API 的作用以及如何开始

如果您的团队中有知道如何使用 GraphQL API 的开发人员,那么 Webex Events API 可以成为您通向强大的事件和产品设置和管理自动化、第三方平台集成、强大的多事件数据仪表板等的门户。

Webex Events API 可以做什么

简而言之,API 是一种编程接口,开发人员可以使用它从在线平台获取数据或将数据放入在线平台(在本例中为 Webex Events)。

该 API 的功能可以简化为四个基本概念:

  • 创建以前不存在的东西,例如出席者、会话或整个活动。

  • 更新 API 可以用来创建的任何内容,以及其他一些内容。 例如,该 API 可用于创建新的与会者,然后编辑该与会者的姓名、电子邮件、状态、群组、电话号码和社交帐户。

  • 阅读有关 API 可用于创建或编辑的任何内容的信息,以及一些它不能创建或编辑的内容的信息。

  • 删除 API 可以用来创建的任何内容,但有一些例外。

在阅读本文的 “与开发人员合作” 部分时,请记住这些概念。

如何开始

1. 获取 API 访问权限

如果您是已经激活了 Webex 活动的Webex Suite企业协议(套件 EA)客户,您将自动获得对 Webex 活动 API 的访问权限! 对于所有其他客户,请联系您的 Webex Events 联系人或我们的支持团队,了解如何访问 API。

2. 创建 API 密钥

现在,您需要创建一个新的 API 密钥供开发人员使用。 当您有权访问 API 时,Webex 活动平台的 “组织设置” 页面中会添加一个新选项卡。 以下是访问新选项卡和创建第一个密钥的方法:

请记住,只有组织管理员才能访问 API 页面。

  1. 在 Webex Events 平台的任何地方,单击屏幕右上角的个人资料图片,然后从下拉列表中选择组织设置。

  2. 在组织设置页面上,单击左侧菜单中的 API 选项卡。 这将带您进入 API 控制面板,您可以在其中查看 API 使用情况、导出使用日志、管理密钥和访问我们的 API 文档。

  3. 单击 “创建密钥”。

  4. 在 “创建新密钥” 模式中,输入 API 密钥的标签,说明其用途。

  5. API 版本下拉列表已经选择了当前版本,因此只需单击 “保存” 即可。 这揭示了 API 密钥。

  6. 单击密钥旁边的 “复制” 按钮,然后将密钥粘贴到安全的文档中,以确保它不会丢失。

警告!这是唯一一次可以访问完整的 API 密钥。关闭模态后,无法再次读取完整密钥。

  1. 复制并保存密钥后,单击 “关闭” 按钮。

在大多数情况下,您只需要一个 API 密钥。 但是,在你与多个团队合作的情况下,你可能需要为每个团队创建一个密钥。 与您的开发人员讨论您的具体用例,找出最佳解决方案。

3. 邀请开发者访问 API

当您创建第一个 API 密钥时,系统会自动在 Webex 活动平台中创建新的 API 团队。 为您的开发人员提供试用 Webex 活动 API 的权限就像邀请他们加入该 API 团队一样简单。 按照我们关于管理团队、成员和积分的文章中的说明来了解如何操作。

请记住,API 沙箱是 Webex 活动平台的单独版本,专为测试而设计。 这意味着,API 沙盒团队的所有新成员都必须创建一个新的平台账户才能使用沙箱,即使他们已经拥有平台账户或使用组织的 SSO 登录也是如此。

您的 API 团队成员无法像组织者那样访问 Webex 活动平台的其余部分。 取而代之的是,API 团队成员可以访问 API “沙箱”,在不影响现实世界数据的情况下测试他们正在构建的内容。 如果您希望开发者也能在 Webex Events 平台中访问您的部分或全部真实活动和应用程序,请邀请他们加入相关的非 API 团队。

4. 善待你的开发者

这一点至关重要,因此我们迈出了整整一步。😉

“罗马不是一天建成的”,也不是一个很好的API集成。 成为开发者的好朋友,让他们有足够的时间来快速了解 Webex Events API,然后再期望他们提供集成。 他们会很感激没有受到压力。

我们建议您至少在需要进行集成之前至少六个月开始与开发人员进行对话。继续阅读以学习如何准备和进行这些对话。

与开发人员合作

在您邀请开发人员加入 Webex Events 沙盒团队后,您的第一个问题可能是:“构建集成需要多长时间?”回答这个问题取决于许多因素,包括你与多少开发人员合作,他们需要多少时间来进行集成,集成的复杂程度等等。

只有您的开发人员才能告诉您设置集成需要多长时间,并且只有在完成几个关键步骤之后:

  1. 首先,阅读以下章节,了解 API 可以做什么。 这将帮助您了解可能发生的事情,这样您就可以与开发人员清楚地传达您的需求。

  2. 与您的开发人员会面,与他们分享我们的 API 文档,并讨论您的需求。 他们将能够就他们能为你做什么和不能做什么提供基本反馈。 但是,在熟悉 Webex 事件 API 之前,他们无法为您提供具体的时间表。

  3. 让您的开发人员有时间熟悉 API。 让自己能够回答有关您的活动、数据、Webex Events 平台和其他任何内容的概念性或实践问题。

API 能做什么

该 API 有两个基本功能:

  • 读取-从 Webex Events 获取数据,以便您可以对其进行检查或将其拉入其他系统。

  • 更新-将数据放入 Webex Events 以创建新项目或同步来自其他平台的数据,例如与会者。 任何更改 Webex 活动平台中某些内容的内容都是更新。

团队和组织

  • 创建、更新、读取和删除团队和团队成员

事件

  • 更新、克隆和读取。 无法使用 API 创建或删除事件。

与会者

  • 创建、更新、读取、分配会话、分配到群组和删除社交账户信息(电话号码、社交账户账号等)。 尽管可以屏蔽与会者,但无法将其删除。

问题

  • 创建、更新、读取和删除

提示:在 API 中,问题被称为 “自定义字段”

群组

  • 创建、更新、读取和删除独占群组和非独占群组

会话

  • 创建、更新、读取和删除

位置

  • 创建、更新、读取和删除

提示:在 API 中,位置被称为 “区域”。

品牌应用程序

  • 阅读品牌应用程序的名称、状态和指定活动的名称

活动应用程序

  • 阅读基础知识、外观和Web App设置以及视频中心录制文件信息

  • 创建、更新、读取和删除以下活动应用程序功能及其项目(如果适用):

    • 议程

    • 赞助商

    • 扬声器

    • 参展商

    • 直播

    • 与会者

    • 自定义清单

    • 单件物品

    • 网页链接

    • 网络清单

    • 我的二维码

请记住,您必须手动添加和配置上面未列出的任何活动应用程序功能。

提示:在 API 中,功能被称为 “组件”。

注册

  • 阅读基础知识、外观和设置信息,包括结账设置

  • 创建、读取、更新和删除票证、表单、问题、促销代码

  • 创建、读取和更新订单

  • 发送订单和票证确认电子邮件

  • 将支票或发票订单标记为已付款

  • 更新订单购买者信息

  • 取消门票并退款

  • 创建、读取、更新、删除、暂停和恢复促销代码

  • 创建、读取、更新和删除税费

提示:在 API 中,问题被称为 “自定义字段”。

现场

  • 阅读和更新基础知识和现场应用程序信息

线索检索和实时显示

  • 阅读该产品是处于活动状态还是已在活动中发布

你需要知道的事

  • 该 API 不能用于创建活动或激活活动中的任何产品,例如活动应用程序和现场。 在开发人员使用 API 修改活动之前,您必须激活您打算使用的每种产品并填写每种产品的基本必填信息。

  • 我们偶尔会发布经过改进和修复的新版本的 API。 我们将继续支持旧版本,让每个人都能过渡到新版本。 我们将通过电子邮件发送有关新版本、即将到来的旧版本弃用日期和官方弃用的更新。

  • 为了防止滥用,对API请求进行了计量和限制。

  • 还为 Suite 客户提供社区支持。

这篇文章对您有帮助吗?
这篇文章对您有帮助吗?