Étape 3 : Intégrer l'URL du tableau de bord - Amazon QuickSight

Étape 3 : Intégrer l'URL du tableau de bord

Important

Amazon QuickSight propose de nouvelles API pour l'intégration des analyses : GenerateEmbedUrlForAnonymousUser et GenerateEmbedUrlForRegisteredUser.

Vous pouvez toujours utiliser les API GetDashboardEmbedUrl et GetSessionEmbedUrl pour intégrer des tableaux de bord et la console QuickSight, mais elles ne contiennent pas les dernières fonctionnalités d'intégration. Pour obtenir la dernière mise à jour de l'expérience d'intégration, consultez la rubrique Intégration de l'analyse QuickSight dans vos applications.

Dans la section suivante, vous découvrirez comment utiliser le kit SDK d'intégration Amazon QuickSight (JavaScript) pour intégrer l'URL du tableau de bord de l'étape 3 sur votre site web ou sur votre page d'application. Le kit SDK vous permet d'effectuer les opérations suivantes :

  • Insérer le tableau de bord sur une page HTML.

  • Transmettre les paramètres au tableau de bord.

  • Gérer les états d'erreurs avec des messages personnalisés pour votre application.

Appelez l'opération d'API GetDashboardEmbedUrl pour obtenir l'URL que vous pouvez intégrer dans votre application. Cette URL est valable pendant 5 minutes et la session qui en résulte est valide pendant 10 heures. L'opération d'API fournit l'URL avec un auth_code qui permet une session à connexion unique.

Voici un exemple de réponse de get-dashboard-embed-url.

//The URL returned is over 900 characters. For this example, we've shortened the string for
//readability and added ellipsis to indicate that it's incomplete.
{
     "Status": "200",
     "EmbedUrl": "https: //dashboards.example.com/embed/620bef10822743fab329fb3751187d2d...",
     "RequestId": "7bee030e-f191-45c4-97fe-d9faf0e03713"
}

Intégrez ce tableau de bord dans votre page web en utilisant le kit SDK d'intégration QuickSight (français non garanti) ou en ajoutant cette URL dans un iframe. Si vous définissez une hauteur et une largeur fixes (en pixels), QuickSight utilise ces valeurs et ne change pas votre représentation visuelle pendant le redimensionnement de votre fenêtre. Si vous définissez un pourcentage relatif pour la hauteur et la largeur, QuickSight génère une présentation réactive, qui change en fonction du redimensionnement de votre fenêtre. En utilisant le kit SDK d'intégration Amazon QuickSight, vous pouvez également contrôler les paramètres dans le tableau de bord et recevoir des rappels en termes de chargement des pages et d'erreurs.

L'exemple suivant montre comment utiliser l'URL générée. Ce code est généré sur votre serveur d'applications.

<!DOCTYPE html>
<html>

<head>
    <title>Basic Embed</title>

    <script src="./quicksight-embedding-js-sdk.min.js"></script>
    <script type="text/javascript">
        var dashboard;

        function embedDashboard() {
            var containerDiv = document.getElementById("embeddingContainer");
            var options = {
                // replace this dummy url with the one generated via embedding API
                url: "https://us-east-1.quicksight.aws.amazon.com/sn/dashboards/dashboardId?isauthcode=true&identityprovider=quicksight&code=authcode",  
                container: containerDiv,
                scrolling: "no",
                height: "700px",
                width: "1000px",
                footerPaddingEnabled: true
            };
            dashboard = QuickSightEmbedding.embedDashboard(options);
        }
    </script>
</head>

<body onload="embedDashboard()">
    <div id="embeddingContainer"></div>
</body>

</html>

Pour que cet exemple fonctionne, assurez-vous d'utiliser le kit SDK d'intégration Amazon QuickSight pour charger le tableau de bord intégré sur votre site web à l'aide de JavaScript. Pour obtenir votre copie, effectuez l'une des actions suivantes :