Intégration à l'aide des API Amazon QuickSight - Amazon QuickSight

Intégration à l'aide des API Amazon QuickSight

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

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

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

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

  • Pour intégrer des utilisateurs enregistrés, partagez au préalable des ressources QuickSight avec eux. Pour les nouveaux utilisateurs authentifiés, vous devez savoir comment accorder l'accès aux ressources. Pour ce faire, vous pouvez ajouter toutes les ressources dans un dossier QuickSight. Si vous préférez utiliser l'API QuickSight, utilisez les opérations d'API DescribeDashboardPermissions et UpdateDashboardPermissions. Pour plus d'informations, consultez DescribeDashboardPermissions (français non garanti) ou UpdateDashboardPermissions (français non garanti) dans la Référence d'API Amazon QuickSight (français non garanti). 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 administrateur QuickSight doit activer explicitement les domaines dans lesquels vous prévoyez d'intégrer vos analyses QuickSight. Vous pouvez le faire en utilisant les sections Gérer QuickSight, Domaines et intégration du menu de profil, ou vous pouvez utiliser le paramètre AllowedDomains d'un appel d'API GenerateEmbedUrlForAnonymousUser ou GenerateEmbedUrlForRegisteredUser.

    Cette option est visible uniquement par les administrateurs QuickSight. Vous pouvez également ajouter des sous-domaines dans le cadre d'un domaine. Pour de plus amples informations, consultez Autorisation de répertorier les domaines au moment de l'exécution à l'aide de l'API QuickSight.

    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 lors de l'exécution grâce aux opérations d'API QuickSight.

Une fois toutes les conditions préalables remplies, l'intégration QuickSight implique de suivre 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 kit SDK AWS dont vous avez besoin.

  2. Dans votre portail web ou votre application, intégrez QuickSight à l'aide de l'URL générée. Pour simplifier ce processus, vous pouvez utiliser le kit SDK d'intégration Amazon QuickSight, disponible sur NPMJS et GitHub. Ce kit SDK JavaScript personnalisé vous permet d'intégrer efficacement QuickSight dans vos pages d'application, de définir des valeurs par défaut, de connecter les contrôles et de gérer les erreurs.

Vous pouvez utiliser les journaux d'audit AWS CloudTrail 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