Incrustación con las API QuickSight - Amazon QuickSight

Importante: hemos rediseñado el espacio de trabajo de QuickSight análisis de Amazon. Es posible que encuentres capturas de pantalla o textos procedimentales que no reflejen el nuevo aspecto de la QuickSight consola. Estamos en proceso de actualizar las capturas de pantalla y los textos procedimentales.

Para buscar características o elementos, utilice la barra de búsqueda rápida.

Para obtener más información sobre QuickSight el nuevo aspecto, consulta Introducir una nueva experiencia de análisis en Amazon QuickSight.

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.

Incrustación con las API QuickSight

 Se aplica a: Enterprise Edition 
   Público objetivo: QuickSight desarrolladores de Amazon 

El proceso real de integración de los análisis mediante las QuickSight API solo implica unos pocos pasos.

Antes de empezar, asegúrate de tener preparados los siguientes elementos:

  • Configure los permisos de IAM necesarios para la identidad de la persona que llama utilizada por su aplicación, que utilizará el AWS SDK para realizar llamadas a la API. Por ejemplo, conceda permiso para permitir la acción quicksight:GenerateEmbedUrlForAnonymousUser o quicksight:GenerateEmbedUrlForRegisteredUser.

  • Para incluir a los usuarios registrados, comparte los QuickSight activos con ellos de antemano. Para los nuevos usuarios que se están autenticando, infórmese sobre cómo conceder acceso a los activos. Una forma de hacerlo consiste en añadir todos los activos a una QuickSight carpeta. Si prefieres usar la QuickSight API, usa las operaciones DescribeDashboardPermissions y UpdateDashboardPermissions API. Para obtener más información, consulta DescribeDashboardPermissionso consulta UpdateDashboardPermissionsla Amazon QuickSight API Reference. Si desea compartir el panel con todos los usuarios de un espacio de nombres o grupo, puede compartir el panel con namespace o group.

  • Si va a integrar paneles, asegúrese de tener el ID de los paneles que desea integrar. El ID del panel es el código en la URL del panel. También puede obtenerlo desde la URL del panel.

  • QuickSight El administrador debe habilitar de forma explícita los dominios en los que planea incrustar sus QuickSight análisis. Para ello, utilice las opciones Administrar QuickSight, Dominios e Incrustación del menú del perfil, o bien utilice el AllowedDomains parámetro de una GenerateEmbedUrlForAnonymousUser llamada a la GenerateEmbedUrlForRegisteredUser API.

    Esta opción solo está visible para QuickSight los administradores. También puede agregar subdominios como parte de un dominio. Para obtener más información, consulte Permite publicar dominios en tiempo de ejecución con la QuickSight API.

    Todos los dominios de su lista estática de permitidos (como desarrollo, almacenamiento provisional y producción) deben estar explícitamente permitidos, y deben usar HTTPS. Puede agregar hasta 100 dominios a la lista de permitidos. Puede añadir dominios en tiempo de ejecución con las operaciones QuickSight de la API.

Una vez cumplidos todos los requisitos previos, la incrustación QuickSight implica los siguientes pasos, que se explican con mayor detalle más adelante:

  1. Para la autenticación, utilice el servidor de aplicaciones para autenticar al usuario. Tras la autenticación en el servidor, genere la URL del panel de control integrado con el AWS SDK que necesite.

  2. En su portal web o aplicación, QuickSight insértelo utilizando la URL generada. Para simplificar este proceso, puede utilizar el SDK de Amazon QuickSight Embedding, disponible en NPMJS y. GitHub Este JavaScript SDK personalizado está diseñado para ayudarlo a QuickSight integrarse de manera eficiente en las páginas de su aplicación, establecer los valores predeterminados, conectar los controles, recibir llamadas y gestionar los errores.

Puede utilizar los registros de AWS CloudTrail auditoría para obtener información sobre la cantidad de paneles integrados, los usuarios de una experiencia integrada y las tasas de acceso.

Temas