Incrustación con las API de Amazon QuickSight - Amazon QuickSight

Incrustación con las API de Amazon QuickSight

 Se aplica a: Enterprise Edition 
   Público al que va dirigido: desarrolladores de Amazon QuickSight 

Solo hay unos pocos pasos involucrados en el proceso real de integrar análisis mediante las API de QuickSight.

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 SDK de AWS para realizar llamadas a la API. Por ejemplo, conceda permiso para permitir la acción quicksight:GenerateEmbedUrlForAnonymousUser o quicksight:GenerateEmbedUrlForRegisteredUser.

  • Para que los usuarios registrados puedan integrar, comparta los activos de QuickSight 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 agregar todos los activos a una carpeta de QuickSight. Si prefiere utilizar la API de QuickSight, utilice las operaciones de la API DescribeDashboardPermissions y UpdateDashboardPermissions. Para obtener más información, consulte DescribeDashboardPermissions o UpdateDashboardPermissions en la referencia de la API de Amazon QuickSight. 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.

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

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

    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 de la API de QuickSight.

Una vez cumplidos todos los requisitos previos, la integración de 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 integrado con el SDK de AWS que necesite.

  2. En su aplicación o portal web, integre QuickSight mediante la URL generada. Para simplificar este proceso, puede emplear el SDK de integración de Amazon QuickSight, disponible en NPMJS y GitHub. Este SDK JavaScript personalizado está diseñado para ayudarle a integrar de forma eficaz QuickSight en las páginas de su aplicación, establecer valores predeterminados, conectar controles, obtener retrollamadas y resolver errores.

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

Temas