使用 Amazon Quick Sight APIs 內嵌 - Amazon Quick Suite

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

使用 Amazon Quick Sight APIs 內嵌

 適用於:企業版 
   目標對象:Amazon Quick Suite 開發人員 

只有幾個步驟涉及使用 Amazon Quick Sight APIs 內嵌分析的實際程序。

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

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

  • 若要為已註冊的使用者嵌入 ,請事先與他們共用 Amazon Quick Sight 資產。對於新的驗證使用者,請了解如何授予資產存取權。其中一種方法是將所有資產新增至 Amazon Quick Sight 資料夾。如果您偏好使用 Amazon Quick Sight API,請使用 DescribeDashboardPermissionsUpdateDashboardPermissions API 操作。如需詳細資訊,請參閱《Amazon Quick Suite API 參考》中的 DescribeDashboardPermissionsUpdateDashboardPermissions。如果您想要與命名空間或群組中的所有使用者共用儀表板,您可以與 namespacegroup 共用儀表板。

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

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

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

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

完成所有先決條件後,嵌入 Amazon Quick Sight 會涉及下列步驟,稍後會更詳細地說明這些步驟:

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

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

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