Intégration avec les API QuickSight - Amazon QuickSight

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.

Intégration avec les API QuickSight

 S'applique à : édition Enterprise 
   Public cible : QuickSight développeurs Amazon 

Le processus réel d'intégration des analyses à l'aide des QuickSight API ne comporte que quelques étapes.

Avant de commencer, assurez-vous de d'avoir mis en place les éléments suivants :

  • Configurez les autorisations IAM requises pour l'identité de l'appelant utilisée par votre application qui utilisera le AWS SDK pour effectuer des appels d'API. Par exemple, accordez l'autorisation à l'action quicksight:GenerateEmbedUrlForAnonymousUser ou quicksight:GenerateEmbedUrlForRegisteredUser.

  • Pour intégrer un compte pour les utilisateurs enregistrés, partagez les QuickSight ressources avec eux au préalable. Pour les nouveaux utilisateurs authentifiés, vous devez savoir comment accorder l'accès aux ressources. Pour ce faire, vous pouvez ajouter tous les actifs QuickSight dans un dossier. Si vous préférez utiliser l' QuickSight API, utilisez les opérations DescribeDashboardPermissions et UpdateDashboardPermissions API. Pour plus d'informations, consultez DescribeDashboardPermissionsou consultez UpdateDashboardPermissionsle Amazon QuickSight API Reference. Si vous souhaitez partager le tableau de bord avec tous les utilisateurs d'un espace de noms ou d'un groupe, vous pouvez partager le tableau de bord avec namespace ou group.

  • Si vous intégrez des tableaux de bord, assurez-vous de disposer de l'ID des tableaux de bord que vous souhaitez intégrer. L'ID du tableau de bord est le code figurant dans l'URL du tableau de bord. Vous pouvez également l'obtenir à partir de l'URL du tableau de bord.

  • Un QuickSight administrateur doit activer explicitement les domaines dans lesquels vous prévoyez d'intégrer vos QuickSight analyses. Vous pouvez le faire en utilisant les options Gérer QuickSight, Domaines et Intégration dans le menu du profil, ou vous pouvez utiliser le AllowedDomains paramètre d'un appel d'GenerateEmbedUrlForRegisteredUserAPI GenerateEmbedUrlForAnonymousUser ou d'API.

    Cette option n'est visible que par les QuickSight administrateurs. Vous pouvez également ajouter des sous-domaines dans le cadre d'un domaine. Pour plus d’informations, consultez Autoriser l'affichage des domaines au moment de l'exécution avec l' QuickSight API.

    Tous les domaines figurant sur votre liste d'autorisation statique (par exemple, développement, phase intermédiaire et production) doivent être explicitement autorisés, et ils doivent utiliser HTTPS. Vous pouvez ajouter jusqu'à 100 domaines à la liste d'autorisation. Vous pouvez ajouter des domaines au moment de l'exécution grâce aux opérations d' QuickSightAPI.

Une fois toutes les conditions requises remplies, l'intégration QuickSight implique les étapes suivantes, qui sont expliquées plus en détail ultérieurement :

  1. Pour l'authentification, utilisez votre serveur d'applications pour authentifier l'utilisateur. Après l'authentification sur votre serveur, générez l'URL du tableau de bord intégré à l'aide du AWS SDK dont vous avez besoin.

  2. Dans votre portail Web ou votre application, intégrez-le à QuickSight l'aide de l'URL générée. Pour simplifier ce processus, vous pouvez utiliser le SDK Amazon QuickSight Embedding, disponible sur NPMJS et. GitHub Ce JavaScript SDK personnalisé est conçu pour vous aider à QuickSight intégrer efficacement les pages de votre application, à définir les valeurs par défaut, à connecter les commandes, à obtenir des rappels et à gérer les erreurs.

Vous pouvez utiliser les journaux AWS CloudTrail d'audit pour obtenir des informations sur le nombre de tableaux de bord intégrés, les utilisateurs d'une expérience intégrée et les taux d'accès.

Rubriques