使用 Amazon QuickSight API 嵌入 - Amazon QuickSight

使用 Amazon QuickSight API 嵌入

 适用于：企业版 
   目标受众：Amazon QuickSight 开发人员 

使用 QuickSight API 嵌入分析的实际过程只涉及几个步骤。

开始之前，请确保下列事项已准备就绪：

  • 为会使用 AWS SDK 进行 API 调用的应用程序使用的调用者身份设置所需的 IAM 权限。例如，授予允许 quicksight:GenerateEmbedUrlForAnonymousUser 或 quicksight:GenerateEmbedUrlForRegisteredUser 操作的权限。

  • 要为注册用户进行嵌入，请事先与他们共享 QuickSight 资产。对于新的身份验证用户，请知晓如何授予对资产的访问权限。执行此操作的一种方法是将所有资源添加到 QuickSight 文件夹。如果您更喜欢使用 QuickSight API，请使用 DescribeDashboardPermissions 和 UpdateDashboardPermissions API 操作。有关更多信息，请参阅《Amazon QuickSight API Reference》中的 DescribeDashboardPermissions 或 UpdateDashboardPermissions。如果您想与命名空间或用户组中的所有用户共享控制面板，则可以与 namespace 或 group 共享控制面板。

  • 如果您要嵌入控制面板，请确保拥有要嵌入的控制面板 ID。控制面板 ID 是控制面板 URL 中的代码。您也可以从控制面板 URL 中获得该信息。

  • QuickSight 管理员必须显式启用您计划在其中嵌入 QuickSight 分析的域。您可以使用配置文件菜单中的管理 QuickSight、域和嵌入来执行此操作，也可以使用 GenerateEmbedUrlForAnonymousUser 或 GenerateEmbedUrlForRegisteredUser API 调用的 AllowedDomains 参数。

    此选项只对 QuickSight 管理员可见。您也可以将子域添加为域的一部分。有关更多信息，请参阅 允许在运行时使用 QuickSight API 列出域。

    必须显式允许静态允许列表中的所有域（如开发、暂存和生产），并且这些域必须使用 HTTPS。最多可以向允许列表添加 100 个域。您可以使用 QuickSight API 操作在运行时系统中添加域。

完成所有先决条件后，稍后将对嵌入 QuickSight 涉及的以下步骤进行详细说明：

  1. 对于身份验证，请使用您的应用程序服务器对用户进行身份验证。在服务器中进行身份验证后，使用所需的 AWS SDK 生成嵌入式控制面板 URL。

  2. 在您的 Web 门户或应用程序中，使用生成的 URL 嵌入 QuickSight。为了简化此过程，您可以使用 NPMJS 和 GitHub 上提供的 Amazon QuickSight Embedding SDK。该自定义的 JavaScript 开发工具包旨在让您高效地将 QuickSight 集成到应用程序页面、设置默认值、连接控件、获取回调以及处理错误。

您可以使用 AWS CloudTrail 审计日志获取有关嵌入式控制面板的数量、嵌入式体验的用户以及访问率的信息。

主题