Étape 3 : Intégrer l’URL de la session de console - Amazon Quick Suite

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Étape 3 : Intégrer l’URL de la session de console

Important

Amazon Quick Sight propose des nouveautés en APIs matière d'intégration des analyses : GenerateEmbedUrlForAnonymousUser etGenerateEmbedUrlForRegisteredUser.

Vous pouvez toujours utiliser GetDashboardEmbedUrl et GetSessionEmbedUrl APIs pour intégrer des tableaux de bord et la console Amazon Quick Sight, mais ils ne contiennent pas les dernières fonctionnalités d'intégration. Pour découvrir l'expérience up-to-date d'intégration la plus récente, consultez la section Intégration des analyses Amazon Quick Sight dans vos applications.

Dans la section suivante, vous découvrirez comment utiliser le SDK d'intégration Amazon Quick Sight (JavaScript) pour intégrer l'URL de session de console de l'étape 3 dans la page de votre site Web ou de votre application. Le kit SDK vous permet d’effectuer les opérations suivantes :

  • Placer la session de console sur une page HTML.

  • Transmettre les paramètres à la session de console.

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

Appelez l’opération d’API GetSessionEmbedUrl 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 cette session de console à votre page Web à l'aide du SDK Amazon Quick Sight Embedding ou en ajoutant cette URL dans un iframe. Si vous définissez une hauteur et une largeur fixes (en pixels), Amazon Quick Sight les utilise et ne modifie pas votre visuel lorsque votre fenêtre est redimensionnée. Si vous définissez un pourcentage relatif de hauteur et de largeur, Amazon Quick Sight fournit une mise en page réactive qui est modifiée en fonction de l'évolution de la taille de votre fenêtre. En utilisant le SDK Amazon Quick Sight Embedding, vous pouvez également contrôler les paramètres au sein de la session de console et recevoir des rappels en termes de fin de chargement de page 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 SDK Amazon Quick Sight Embedding pour charger la session de console intégrée sur votre site Web à l'aide de. JavaScript Pour obtenir votre copie, effectuez l’une des actions suivantes :