跳转到主要内容
所有收藏整合与合作
Webex Events API 入门
Webex Events API 入门

API 的作用以及如何开始使用

Daniel Murphey avatar
作者：Daniel Murphey
超过 4 个月前更新

这篇文章是使用机器翻译从英文翻译而来的。

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

Webex Events API 可以做什么

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

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

  • 创建一些以前不存在的东西，例如与会者、会议或整个事件。

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

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

  • 删除可以使用 API 创建的所有内容，但有一些例外。

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

如何开始

1. 获取 API 访问权限

如果您是已激活Webex Events的 Webex Suite Enterprise Agreement (Suite EA) 客户，您将自动获得Webex Events API 的访问权限！对于所有其他客户，请与您的Webex Events联系人或我们的支持团队联系，了解如何访问 API。

2. 创建 API 密钥

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

💡 请记住，只有组织管理员可以访问 API 页面。

  1. 在Webex Events平台的任何位置，单击屏幕右上角的个人资料图像，然后从下拉菜单中选择组织设置。

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

  3. 单击创建密钥。

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

  5. API 版本下拉菜单中已经选择了当前版本，因此只需单击“保存”即可。这将显示 API 密钥。

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

    ⚠️警告！这是唯一可以访问完整 API 密钥的时间。关闭模式后，将无法再次读取完整密钥。

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

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

3. 邀请开发者访问 API

当您创建第一个 API 密钥时， Webex Events平台中会自动创建一个新的 API 团队。让您的开发人员可以试用Webex Events API 就像邀请他们加入该 API 团队一样简单。请按照我们关于管理团队、成员和积分的文章中的说明了解如何操作。

💡 请记住，API 沙盒是专为测试而制作的Webex Events平台的独立版本。这意味着 API 沙盒团队的所有新成员都必须创建一个新的平台帐户才能使用沙盒，即使他们已经拥有平台帐户或使用其组织的 SSO 登录。

API 团队中的人员无法像组织者那样访问Webex Events平台的其余部分。相反，API 团队成员可以访问 API“沙盒”，他们可以在其中测试他们正在构建的内容，而不会影响实际数据。如果您希望开发人员也可以访问Webex Events平台中的部分或全部实际活动和应用程序，请邀请他们加入相关的非 API 团队。

4. 准备活动

由于 API 无法激活活动中的任何产品（例如Event App和Onsite），因此您必须激活您打算在活动中使用的每个产品，并填写所需的基本信息。

与开发人员合作

您必须与开发人员进行清晰的沟通，以便他们能够构建您所需的内容。这意味着您需要知道 API 可以访问Webex Events平台的哪些部分。继续阅读以了解 API 可以访问和控制的确切内容，以及一些帮助您与开发人员“使用相同语言”的提示。

当您熟悉基本功能后，您可以开始与开发人员讨论使用 API 构建工具和自动化。

团队和组织

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

活动

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

出席者

  • 创建、更新、阅读、分配至会议、分配至群组以及删除社交帐户信息（电话号码、社交帐户名称等）。无法删除与会者，但可以屏蔽他们。

问题

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

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

群组

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

会议

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

位置

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

提示：在 API 中，位置被称为“区域”。

Branded Apps

  • 读取Branded App的名称、状态和分配的事件的名称

Event App

  • 阅读基本信息、外观和 Web 应用程序设置以及Video Center录制信息

  • 创建、更新、读取和删除以下Event App功能及其项目（如适用）：

    • 议程

    • 赞助商

    • 演讲嘉宾

    • 参展商

    • 现场直播

    • 出席者

    • 自定义列表

    • 单品

    • 网站链接

    • 网站列表

    • 我的二维码

💡请记住，您必须手动添加和配置上面未列出的任何Event App功能。

提示：在 API 中，功能被称为“组件”。

登记

  • 阅读基本信息、外观信息和设置信息，包括结账设置

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

  • 创建、读取和更新订单

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

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

  • 更新订单购买者信息

  • 取消和退票

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

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

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

Onsite

  • 阅读并更新基础知识和Onsite App信息

Lead Retrieval和Live Display

  • 了解该产品是否处于活动状态或已发布在活动中

需要了解的事情

  • 我们会不时发布新版本的 API，进行改进和修复。我们将继续支持旧版本，以便每个人都能过渡到新版本。我们将通过电子邮件发送有关新版本、即将到来的旧版本弃用日期以及官方弃用内容的更新。

  • API 请求受到计量和限制，以防止滥用。

  • Suite 客户还享受社区支持。

这是否解答了您的问题？