使用 QuickSight API 嵌入 - Amazon QuickSight

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

使用 QuickSight API 嵌入

 適用於:企業版 
   目標受眾:Amazon QuickSight 開發者 

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

開始前,請確定您有下列項目:

  • 為您的應用程式使用的呼叫者身分設定必要的 IAM 許可,以使用 AWS SDK 進行 API 呼叫。例如,授予允許 quicksight:GenerateEmbedUrlForAnonymousUserquicksight:GenerateEmbedUrlForRegisteredUser 動作的許可。

  • 若要為已註冊使用者嵌入,請事先與他們共用 QuickSight 資產。對於新的驗證使用者,請了解如何授予資產存取權。執行此操作的一種方法是將所有資產添加到 QuickSight 文件夾中。如果您偏好使用 QuickSight API,請使用DescribeDashboardPermissionsUpdateDashboardPermissions API 作業。如需詳細資訊,請參閱 Amazon QuickSight API 參考資料UpdateDashboardPermissions中的DescribeDashboardPermissions或。如果您想要與命名空間或群組中的所有使用者共用儀表板,您可以與 namespacegroup 共用儀表板。

  • 如果您要嵌入儀表板,請確保具有要嵌入的儀表板的 ID。儀表板 ID 是儀表板 URL 中的代碼。您也可以從儀表板 URL 獲取它。

  • QuickSight 管理員必須明確啟用您計劃內嵌 QuickSight 分析的網域。您可以使用設定檔功能表中的「管理」 QuickSight、「網域和嵌入」來執行此操作,也可以使用GenerateEmbedUrlForAnonymousUserGenerateEmbedUrlForRegisteredUser API 呼叫的AllowedDomains參數。

    只有 QuickSight 管理員才能看到此選項。您也可以將子網域新增為域的一部分。如需詳細資訊,請參閱 允許在執行階段使用 QuickSight API 列出網域

    必須明確允許靜態允許清單 (例如開發、預備和生產) 中的所有域,且必須使用 HTTPS。新增至允許清單中的域可多達 100 個。您可以在執行階段使用 QuickSight API 作業新增網域。

完成所有先決條件之後,嵌入 QuickSight 包含下列步驟,稍後會詳細說明這些步驟:

  1. 對於身分驗證,請使用應用程式伺服器來驗證使用者。在伺服器中進行驗證後,使用您需要的 AWS SDK 產生嵌入式儀表板 URL。

  2. 在您的入口網站或應用程式中, QuickSight 使用產生的 URL 內嵌。若要簡化此程序,您可以使用 Amazon QuickSight 嵌入開發套件,可在 NPMJS 和. GitHub 此自訂 JavaScript SDK 旨在協助您有效地整合 QuickSight 至應用程式頁面、設定預設值、連接控制項、取得回呼,以及處理錯誤。

您可以使用 AWS CloudTrail 稽核記錄來取得內嵌儀表板的數量、內嵌體驗的使用者以及存取率的相關資訊。