Paso 3: integración de la URL de la sesión de consola - Amazon Quick Suite

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Paso 3: integración de la URL de la sesión de consola

importante

Amazon Quick Sight tiene novedades APIs para incorporar análisis: GenerateEmbedUrlForAnonymousUser yGenerateEmbedUrlForRegisteredUser.

Puede seguir utilizando GetDashboardEmbedUrl y GetSessionEmbedUrl APIs para incrustar paneles y la consola Amazon Quick Sight, pero no incluyen las capacidades de incrustación más recientes. Para obtener la experiencia de up-to-date incrustación más reciente, consulte Incrustar los análisis de Amazon Quick Sight en sus aplicaciones.

En la siguiente sección, encontrará información sobre cómo puede utilizar el SDK de incrustación de Amazon Quick Sight (JavaScript) para incrustar la URL de la sesión de la consola del paso 3 en su sitio web o página de aplicación. Con el SDK, puede hacer lo siguiente:

  • Coloque la sesión de consola en una página HTML.

  • Pase los parámetros a la sesión de consola.

  • Resolver los estados de error con mensajes que se personalizan en su aplicación.

Llamar a la operación de la API GetSessionEmbedUrl para obtener la dirección URL que puede integrar en la aplicación. Esta URL es válida durante 5 minutos, y la sesión resultante es válida durante 10 horas. La operación de la API proporciona la URL con un auth_code que permite una sesión con inicio único.

El siguiente es un ejemplo de respuesta 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"
}

Inserte esta sesión de consola en su página web mediante el SDK de incrustación de Amazon Quick Sight o añadiendo esta URL a un iframe. Si estableces un número fijo de altura y anchura (en píxeles), Amazon Quick Sight los usará y no cambiará la imagen a medida que la ventana cambie de tamaño. Si establece un porcentaje relativo de altura y anchura, Amazon Quick Sight proporciona un diseño adaptable que se modifica a medida que cambia el tamaño de la ventana. Al utilizar el SDK de incrustación de Amazon Quick Sight, también puede controlar los parámetros de la sesión de consola y recibir llamadas en función de la finalización de la carga de la página y de los errores.

En el siguiente ejemplo, se muestra cómo utilizar la URL generada. Este código se genera en el servidor de aplicaciones.

<!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>

Para que este ejemplo funcione, asegúrese de utilizar el SDK de incrustación de Amazon Quick Sight para cargar la sesión de consola integrada en su sitio web utilizando JavaScript. Para obtener su copia, siga uno de estos pasos: