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

# 嵌入 Amazon Quick Sight API
<a name="embedded-analytics-api"></a>


|  | 
| --- |
|  适用于：企业版  | 


|  | 
| --- |
|    目标受众：Amazon Quick 开发者  | 

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

开始之前，请确保下列事项已准备就绪：
+ 为将使用 AWS 软件开发工具包进行 API 调用的应用程序使用的来电者身份设置所需的 IAM 权限。例如，授予允许 `quicksight:GenerateEmbedUrlForAnonymousUser` 或 `quicksight:GenerateEmbedUrlForRegisteredUser` 操作的权限。
+ 要为注册用户嵌入，请事先与他们共享 Amazon Quick Sight 资产。对于新的身份验证用户，请知晓如何授予对资产的访问权限。一种方法是将所有资产添加到 Amazon Quick Sight 文件夹。如果您更喜欢使用 Amazon Quick Sight API，请使用`DescribeDashboardPermissions`和 `UpdateDashboardPermissions` API 操作。有关更多信息，请参阅 *Amazon Quick API 参考[UpdateDashboardPermissions](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateDashboardPermissions.html)*中的[DescribeDashboardPermissions](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeDashboardPermissions.html)或。如果您想与命名空间或用户组中的所有用户共享控制面板，则可以与 `namespace` 或 `group` 共享控制面板。
+ 如果您要嵌入控制面板，请确保拥有要嵌入的控制面板 ID。控制面板 ID 是控制面板 URL 中的代码。您也可以从控制面板 URL 中获得该信息。
+ Amazon Quick Sight 管理员必须明确启用您计划在其中嵌入 Amazon Quick Sight 分析的域名。您可以使用个人资料菜单中的 “**管理 Amazon Quick Sight**、**域名和嵌入**” 来执行此操作，也可以使用`GenerateEmbedUrlForAnonymousUser`或 `GenerateEmbedUrlForRegisteredUser` API 调用的`AllowedDomains`参数。

  此选项仅对 Amazon Quick Sight 管理员可见。您也可以将子域添加为域的一部分。有关更多信息，请参阅 [允许在运行时使用 Amazon Quick API 上架域名](manage-domains.md#embedding-run-time)。

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

在完成所有先决条件后，嵌入 Amazon Quick Sight 涉及以下步骤，稍后将详细介绍这些步骤：

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

1. 在您的门户网站或应用程序中，使用生成的 URL 嵌入 Amazon Quick Sight。为了简化此过程，你可以使用 [NPMJS 上提供的 Amazon Quick Sight Embedding Sight Embeddin](https://www.npmjs.com/package/amazon-quicksight-embedding-sdk) g S [GitHub](https://github.com/awslabs/amazon-quicksight-embedding-sdk) 此自定义 JavaScript SDK 旨在帮助您高效地将 Amazon Quick Sight 集成到应用程序页面、设置默认值、连接控件、获取回调和处理错误。

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

**Topics**
+ [将 Amazon Quick Sight 仪表板嵌入亚马逊快速视图 API](embedding-dashboards.md)
+ [使用 Amazon Quick Sight API 嵌入亚马逊 Quick Sight 视觉效果](embedding-visuals.md)
+ [为注册用户嵌入 Amazon Quick Sight 控制台的全部功能](embedded-analytics-full-console-for-authenticated-users.md)
+ [在 Amazon Quick Sight 生成问答体验中嵌入 Amazon Q](embedding-gen-bi.md)
+ [嵌入 Amazon Quick Sight Q 搜索栏（经典版）](embedding-quicksight-q.md)
+ [使用 GetDashboardEmbedURL 和 GetSessionEmbedURL API 操作嵌入分析](embedded-analytics-deprecated.md)