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 à Amazon QuickSight APIs
S'applique à : édition Enterprise |
Public cible : QuickSight développeurs Amazon |
Le processus proprement dit d'intégration des analyses à l'aide du QuickSight APIs.
Avant de commencer, assurez-vous de d'avoir mis en place les éléments suivants :
-
Configurez les IAM autorisations requises pour l'identité de l'appelant utilisée par votre application qui utilisera le AWS SDK pour passer des API appels. Par exemple, accordez l'autorisation à l'action
quicksight:GenerateEmbedUrlForAnonymousUser
ouquicksight: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 le QuickSight API, utilisez les
UpdateDashboardPermissions
API opérationsDescribeDashboardPermissions
et. 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 avecnamespace
ougroup
. -
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 contenu dans le tableau URL de bord. Vous pouvez également l'obtenir depuis le tableau de bordURL.
-
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'unGenerateEmbedUrlForRegisteredUser
API appelGenerateEmbedUrlForAnonymousUser
ou.Cette option n'est visible que par les QuickSight administrateurs. Vous pouvez également ajouter des sous-domaines dans le cadre d'un domaine. Pour de plus amples informations, veuillez consulter Autoriser la mise en vente de domaines au moment de l'exécution avec QuickSight API.
Tous les domaines de votre liste d'autorisations statique (tels que le développement, la mise en scène et la production) doivent être explicitement autorisés, et ils doivent être utilisésHTTPS. Vous pouvez ajouter jusqu'à 100 domaines à la liste d'autorisation. Vous pouvez ajouter des domaines lors de l'exécution avec QuickSight API des opérations.
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 :
-
Pour l'authentification, utilisez votre serveur d'applications pour authentifier l'utilisateur. Après l'authentification sur votre serveur, générez le tableau de bord intégré URL à l'aide de AWS SDK ce dont vous avez besoin.
-
Dans votre portail Web ou votre application, intégrez-les à QuickSight l'aide des données généréesURL. Pour simplifier ce processus, vous pouvez utiliser Amazon QuickSight EmbeddingSDK, disponible sur NPMJS
et GitHub . Cette personnalisation JavaScript SDK est conçue 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
- Intégrer les QuickSight tableaux de bord Amazon à QuickSight API
- Intégrer les QuickSight visuels d'Amazon à QuickSight APIs
- Intégration de toutes les fonctionnalités de la QuickSight console Amazon pour les utilisateurs enregistrés
- Intégrer Amazon Q à une expérience QuickSight générative de questions-réponses
- Intégration de la barre de recherche Amazon QuickSight Q (classique)
- Intégration des analyses à l'aide des opérations d'API GetDashboardEmbedURL et GetSessionEmbedURL