Einbetten von Visualisierungen mit den Amazon QuickSight-APIs - Amazon QuickSight

Einbetten von Visualisierungen mit den Amazon QuickSight-APIs

 Gilt für: Enterprise Edition 
   Zielgruppe: Amazon QuickSight-Entwickler 

Der eigentliche Prozess der Einbettung von Analysen mithilfe der QuickSight-APIs umfasst nur wenige Schritte.

Stellen Sie vor dem Beginn sicher, dass Sie über die folgenden Tools bereit haben:

  • Richten Sie die erforderlichen IAM-Berechtigungen für die Anruferidentität ein, die von Ihrer Anwendung verwendet wird, die das AWS-SDK für API-Aufrufe verwendet. Erteilen Sie beispielsweise die Erlaubnis, die Aktion quicksight:GenerateEmbedUrlForAnonymousUser oder quicksight:GenerateEmbedUrlForRegisteredUser zuzulassen.

  • Um sie für registrierte Benutzer einzubetten, teilen Sie ihnen zuvor QuickSight-Ressourcen mit. Neue Benutzer, die sich authentifizieren, sollten wissen, wie sie Zugriff auf die Ressourcen gewähren können. Eine Möglichkeit, dies zu tun, besteht darin, alle Ressourcen zu einem QuickSight-Ordner hinzuzufügen. Wenn Sie die QuickSight-API bevorzugen, verwenden Sie die DescribeDashboardPermissions- und UpdateDashboardPermissions-API-Operationen. Weitere Informationen finden Sie unter DescribeDashboardPermissions oder UpdateDashboardPermissions in der Amazon QuickSight-API-Referenz. Wenn Sie das Dashboard mit allen Benutzern in einem Namespace oder einer Gruppe teilen möchten, können Sie das Dashboard mit namespace oder group teilen.

  • Wenn Sie Dashboards einbetten, stellen Sie sicher, dass Sie die ID der Dashboards haben, die Sie einbetten möchten. Die Dashboard-ID ist der Code in der URL des Dashboards. Sie können ihn auch über die Dashboard-URL abrufen.

  • Ein QuickSight-Administrator muss Domains, in die Sie Ihre QuickSight-Analysen einbetten möchten, explizit aktivieren. Sie können dies tun, indem Sie die Option QuickSight verwalten, Domains und Embedding im Profilmenü verwenden, oder Sie können den AllowedDomains-Parameter eines GenerateEmbedUrlForAnonymousUser- oder GenerateEmbedUrlForRegisteredUser-API-Aufrufs verwenden.

    Diese Option ist nur für QuickSight-Administratoren sichtbar. Sie können auch Subdomains als Teil einer Domain hinzufügen. Weitere Informationen finden Sie unter Erlauben Sie das Auflisten von Domains zur Laufzeit mit der QuickSight-API.

    Alle Domains in Ihrer statischen Zulassungsliste (z. B. Entwicklung, Staging und Produktion) müssen explizit zugelassen sein und HTTPS verwenden. Sie können der Liste der zulässigen Domains bis zu 100 Domains hinzufügen. Sie können Domains zur Laufzeit mit QuickSight-API-Operationen hinzufügen.

Nachdem alle Voraussetzungen erfüllt sind, umfasst das Einbetten von QuickSight die folgenden Schritte, die später näher erläutert werden:

  1. Verwenden Sie zur Authentifizierung Ihren Anwendungsserver, um den Benutzer zu authentifizieren. Generieren Sie nach der Authentifizierung auf Ihrem Server die eingebettete Dashboard-URL mit dem AWS-SDK, das Sie benötigen.

  2. Betten Sie QuickSight mithilfe der generierten URL in Ihr Webportal oder Ihre Anwendung ein. Zur Vereinfachung dieses Prozesses können Sie das Amazon QuickSight Embedding SDK, verfügbar auf NPMJS und GitHub, verwenden. Dieses angepasste JavaScript-SDK hilft Ihnen QuickSight effizient in Ihre Anwendungsseiten zu integrieren, Standardwerte einzurichten, Steuerelemente zu verbinden, Callbacks zu erhalten und mit Fehlern umzugehen.

Sie können AWS CloudTrail-Audit-Protokolle verwenden, um Informationen über die Anzahl an eingebetteten Dashboards, Benutzer von Einbettungen und Zugriffsraten zu erhalten.

Themen