View a markdown version of this page

智能表单集成 - Amazon Quick

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

智能表单集成

使用 Smartsheet 操作连接器通过自然语言直接在 Amazon Quick 中管理工作表、行、报告和搜索 Smartsheet 工作区。此集成使用 Smartsheet API。有关更多信息,请参阅 Smartsheet 文档中的 Smartsheet API 简介

设置此集成涉及两个步骤。首先,在 Smartsheet 中为所选的身份验证方法配置凭据。然后,你在 Amazon Quick 中创建集成并将其关联到你的 Smartsheet 账户。有关 Amazon Quick 支持的身份验证方法的信息,请参阅身份验证方法

先决条件

在设置集成之前,请确保满足以下要求:

配置智能表开发者工具

在配置 Amazon Quick 之前,请在 Smartsheet 中设置凭证。您完成的步骤取决于您计划使用的身份验证方法。Amazon Quick 支持 Smartsheet 两种身份验证方法。有关这些方法的更多信息,请参阅身份验证方法

有关 Smartsheet OAuth 的更多信息,请参阅 Smartsheet API 文档中的 OAuth

注册开发者工具并创建开发者个人资料

  1. 前往开发者工具注册页面,注册要用于应用程序的 Smartsheet 帐户。有关更多信息,请参阅 Smartsheet API 文档中的注册开发者工具

  2. 在 Smartsheet 激活开发者工具后,登录 Smartsheet 应用程序并在左下角选择你的账户图标,然后选择开发者工具。

  3. 选择 “创建开发者个人资料”,然后输入配置文件名称。有关更多信息,请参阅 Smartsheet API 文档中的创建您的开发者个人资料

提示

Smartsheet 建议使用 OAuth 应用程序的专用服务帐户,而不是个人帐户。

注册 OAuth 应用程序

  1. 在 Smartsheet 开发者工具中,选择创建新应用程序

  2. 填写表格:

    • 应用程序名称-用于向用户标识您的应用程序的名称。

    • 应用程序描述-对集成的简要描述。

    • 应用程序网址-启动您的应用程序的网址或登录页面。

    • 应用程序 contact/support-Support 联系信息。

    • 应用程序重定向网址https://{region}.quicksight.aws.amazon.com/sn/oauthcallback

      {region}替换为您 AWS 所在的地区(例如,us-east-1)。

  3. 选择保存。Smartsheet 生成应用程序客户端 ID应用程序密钥

  4. 复制 “客户端 ID” 和 “客户机密钥” 值。当你在 Amazon Quick 中配置集成时,你需要这些。

有关更多信息,请参阅 Smarts heet API 文档中的注册应用程序。

生成 API 访问令牌(仅限服务身份验证)

如果您计划使用服务身份验证而不是 OAuth,请生成 API 访问令牌。您必须有商业或企业计划才能生成代币。有关更多信息,请参阅 Smarts heet 帮助中心中的生成 API 访问令牌

  1. 在 Smartsheet 应用程序中,选择左侧导航栏底部的账户(个人资料图片),然后选择个人设置

  2. 选择 “API 访问权限” 选项卡,然后选择 “生成新的访问令牌”。

  3. 命名令牌并选择 OK。立即复制代币值——这是唯一一次可见的代币值。

重要

安全地存储您的访问令牌。任何拥有该令牌的人都可以访问令牌所有者有权访问的所有 Smartsheet 数据。不要向版本控制系统提交令牌。有关存储令牌的最佳实践,请参阅 Smartsheet API 文档中的身份验证

OAuth 访问权限范围

配置用户身份验证 (OAuth) 时,集成会向 Smartsheet 请求以下访问范围。这些作用域决定了集成可以代表经过身份验证的用户做什么。如果您改用服务身份验证(API 密钥),则集成将使用令牌所有者的全部权限,并且范围不适用。有关更多信息,请参阅 Smartsheet API 文档中的访问范围

Smartsheet OAuth 访问范围
Scope 说明
READ_SHEETS 阅读所有工作表数据,包括附件、讨论和单元格数据。
WRITE_SHEETS 插入和修改工作表数据,包括附件、讨论和单元格数据。
注意

访问范围不会覆盖现有的共享权限。例如,拥有WRITE_SHEETS作用域不允许集成更新用户只有查看者级别访问权限的工作表。有关更多信息,请参阅 Smartsheet API 文档中的资源访问权限级别

在 Amazon Quick 中设置集成

完成 Smartsheet 开发者工具配置后,在 Amazon Quick 中创建集成。

  1. 在 Amazon Quick 控制台中,选择连接器

  2. 选择 “为你的团队创建” 选项卡。

  3. 找到并选择 Smartsheet。

  4. 输入集成详细信息:

    • 名称 — Smartsheet 集成的描述性名称。

    • 描述(可选)-集成的目的。

  5. 选择您的连接类型并填写连接设置。有关这些身份验证方法的更多信息,请参阅身份验证方法

    1. 要进行用户身份验证 (OAuth),请使用您的 Smartsheet 开发者工具应用程序注册中的客户端 ID 和客户端密钥。配置以下字段:

      • 基本网址https://api.smartsheet.com/2.0

      • 客户端 ID — 来自你的 Smartsheet 开发者工具应用程序注册的应用程序客户端 ID。

      • 客户密钥 — 来自你的 Smartsheet 开发者工具应用程序注册的应用程序密钥。

      • 代币网址https://api.smartsheet.com/2.0/token

      • 身份验证网址 — https://app.smartsheet.com/b/authorize

      • 重定向网址https://{region}.quicksight.aws.amazon.com/sn/oauthcallback

    2. 对于服务身份验证(API 密钥),请使用 Smartsheet 个人设置中的 API 访问令牌。配置以下字段:

      • API 密钥 — 根据您的个人设置生成的 Smartsheet API 访问令牌。

      • 基本网址https://api.smartsheet.com/2.0

      • 电子邮件-与生成令牌的 Smartsheet 账户关联的电子邮件地址。

  6. 选择创建并继续

  7. 选择要与之共享集成的用户。

  8. 选择下一步

要进行用户身份验证,请转到连接器 > 您的 Smartsheet 连接器名称,然后选择登录以完成 OAuth 授权流程。在 Smartsheet 同意窗口中,选择 “允许” 以授予访问权限。

重要

使用服务身份验证,所有操作都使用 API 令牌所有者的权限运行。任何有权访问此集成的 Amazon Quick 用户都可以对令牌所有者可以访问的所有 Smartsheet 资源执行操作。根据贵组织的安全要求适当确定令牌权限的范围。

注意

如果你使用 Smartsheet Gov、Smartsheet Regions Europe 或 Smartsheet Regions Australions,请

智能表单区域基础网址
环境 基本网址
Smartsheet https://api.smartsheet.com/2.0
Smartsheet https://api.smartsheetgov.com/2.0
欧洲智能表单区域 https://api.smartsheet.eu/2.0
澳大利亚Smartsheet地区 https://api.smartsheet.au/2.0

有关更多信息,请参阅 Smartsheet API 文档中的基本 URL

可用操作

设置集成后,可以执行以下操作。

智能表单可用操作
类别 处理建议 说明
Search 列表搜寻 在用户可以访问的所有工作表中搜索指定文本。
工作表 列表工作表 列出经过身份验证的用户可以访问的所有工作表。
工作表 获取工作表 根据工作表 ID 获取工作表及其数据。
Reports 列出报告 列出用户可以访问的所有报告。
Reports 查看报告 根据报告 ID 获取报告详细信息。

管理和故障排除

要编辑、共享或删除您的集成,请参阅管理现有集成

身份验证问题

  • OAuth 授权失败 — 验证客户端 ID 和客户端密钥是否与 Smartsheet 开发者工具应用程序注册中的值相匹配。确认 Smartsheet 中的重定向网址与您的 Amazon Quick 配置中的网址完全匹配。有关 OAuth 错误类型的列表,请参阅 Smartsheet API 文档中的 OAuth 错误类型

  • 开发者工具不可用 — 确认您的 Smartsheet 账户已激活开发者工具。免费账户不支持开发者工具。如果您的请求被拒绝,请联系您的 Smartsheet 客户成功经理。

  • API 密钥身份验证失败 — 确认访问令牌未被撤销。您可以在 Smartsheet 应用程序的 “个人设置” > “API 访问权限” 中管理令牌。有关更多信息,请参阅 Smarts heet 帮助中心中的生成 API 访问令牌

  • 访问令牌已过期 — OAuth 访问令牌将在大约 7 天后过期。Amazon Quick 会自动处理令牌刷新。如果您遇到持续的令牌错误,请注销并从集成设置中重新登录。有关更多信息,请参阅 Smartsheet API 文档中的进行 API 调用

常见错误消息

  • 操作会返回权限错误-验证经过身份验证的用户在目标工作表上是否具有所需的共享权限。OAuth 作用域不会覆盖共享级别的访问控制。有关更多信息,请参阅 Smartsheet API 文档中的资源访问权限级别

  • 未找到工作表-验证工作表 ID 是否正确,以及经过身份验证的用户是否至少拥有工作表的查看者访问权限。

  • API 速率限制错误 — Smartsheet API 强制执行速率限制。有关更多信息,请参阅 Smartsheet API 文档中的限制