Incorporação com as APIs do Amazon QuickSight - Amazon QuickSight

Incorporação com as APIs do Amazon QuickSight

 Aplica-se a: Enterprise Edition 
   Público-alvo: desenvolvedores do Amazon QuickSight 

Existem apenas algumas etapas envolvidas no processo real de incorporação de analytics usando as APIs do QuickSight.

Antes de começar, certifique-se de ter os seguintes itens em vigor:

  • Configure as permissões obrigatórias do IAM para a identidade do chamador utilizada pela aplicação que usará o AWS SDK para efetuar chamadas de API. Por exemplo, conceda permissão para possibilitar a ação quicksight:GenerateEmbedUrlForAnonymousUser ou quicksight:GenerateEmbedUrlForRegisteredUser.

  • Para realizar a incorporação para usuários registrados, compartilhe ativos do QuickSight com eles com antecedência. Para novos usuários autenticados, saiba como conceder acesso aos ativos. Uma maneira de fazer isso é ao adicionar todos os ativos em uma pasta do QuickSight. Se preferir usar a API do QuickSight, use as operações de API DescribeDashboardPermissions e UpdateDashboardPermissions. Para obter mais informações, consulte DescribeDashboardPermissions ou UpdateDashboardPermissions na referência de APIs do Amazon QuickSight. Se desejar compartilhar o painel com todos os usuários em um namespace ou em um grupo, você poderá compartilhar o painel com namespace ou com group.

  • Se você estiver realizando a incorporação de painéis, certifique-se de ter o ID dos painéis que deseja incorporar. O ID do painel corresponde ao código no URL do painel. Também é possível obtê-lo no URL do painel.

  • Um administrador do QuickSight deve habilitar explicitamente os domínios nos quais você planeja incorporar o analytics do QuickSight. Você pode fazer isso ao usar Gerenciar QuickSight, Domínios e incorporação no menu de perfil ou ao usar o parâmetro AllowedDomains de uma chamada de API GenerateEmbedUrlForAnonymousUser ou GenerateEmbedUrlForRegisteredUser.

    Esta opção é visível somente para administradores do QuickSight. Você também pode adicionar subdomínios como parte de um domínio. Para ter mais informações, consulte Domínios da lista de permissões no runtime com a API do QuickSight.

    Todos os domínios na sua lista de permissões estáticas (como desenvolvimento, preparação e produção) devem ser permitidos explicitamente e devem usar HTTPS. Você pode adicionar até cem domínios à lista de permissões. Você pode adicionar domínios no runtime com operações de API do QuickSight.

Depois que todos os pré-requisitos forem concluídos, a incorporação do QuickSight envolve as seguintes etapas, que serão explicadas com mais detalhes posteriormente:

  1. Para a autenticação, use o servidor de aplicações para autenticar o usuário. Após a autenticação em seu servidor, gere o URL do painel incorporado usando o AWS SDK necessário.

  2. Em seu portal da Web ou em sua aplicação, incorpore o QuickSight usando o URL gerado. Para simplificar esse processo, você pode usar o SDK de incorporação do Amazon QuickSight, disponível no NPMJS e no GitHub. Este SDK em JavaScript personalizado foi projetado para ajudar você a integrar com eficiência o QuickSight às páginas da aplicação, definir padrões, conectar controles, obter retornos de chamada e lidar com erros.

Você pode usar os logs de auditoria do AWS CloudTrail para obter informações sobre o número de painéis incorporados, de usuários de uma experiência incorporada e de taxas de acesso.

Tópicos