使用 Amazon QuickSight API 進行嵌入 - Amazon QuickSight

使用 Amazon QuickSight API 進行嵌入

 適用於：企業版本 
   目標受眾：Amazon QuickSight 開發人員 

使用 QuickSight API 嵌入分析的實際過程中只涉及幾個步驟。

開始前，請確定您有下列項目：

  • 為您的應用程式使用的發起人身分設定必要的 IAM 許可，以使用 AWS 開發套件 進行 API 呼叫。例如，授予允許 quicksight:GenerateEmbedUrlForAnonymousUser 或 quicksight:GenerateEmbedUrlForRegisteredUser 動作的許可。

  • 若要為已註冊使用者進行嵌入，請事先與他們共用 QuickSight 資產。對於新的驗證使用者，請了解如何授予資產存取權。執行此動作的一個方式是將所有資產新增至 QuickSight 資料夾。如果您偏好使用 QuickSight，請使用 DescribeDashboardPermissions 和 UpdateDashboardPermissions API 操作。如需詳細資訊，請參閱《Amazon QuickSight API 參考》中的 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 開發套件產生內嵌式儀表板 URL。

  2. 在您的 Web 入口網站或應用程式中，使用產生的 URL 嵌入 QuickSight。若要簡化此程序，您可以使用 Amazon QuickSight 嵌入開發套件，該開發套件可在 NPMJS 和 GitHub 上找到。這個自訂的 JavaScript 開發套件旨在讓您有效率地將 QuickSight 儀表板整合到應用程式中、設定預設值、連接控制項、取得回呼及處理錯誤。

您可以使用 AWS CloudTrail 稽核日誌，以取得有關內嵌式儀表板數量、內嵌體驗的使用者以及存取率等資訊。

主題