Amazon QuickSight API를 사용한 임베딩
적용 대상: Enterprise Edition |
대상 사용자: Amazon QuickSight 개발자 |
QuickSight API를 사용한 임베디드 분석의 실제 프로세스는 몇 단계만 거치면 됩니다.
시작하기 전에 다음 도구가 있는지 확인하세요.
-
AWS SDK를 사용하여 API 호출을 수행할 애플리케이션에서 사용하는 호출자 자격 증명에 필요한 IAM 권한을 설정합니다. 예를 들어,
quicksight:GenerateEmbedUrlForAnonymousUser
또는quicksight:GenerateEmbedUrlForRegisteredUser
작업을 허용할 권한을 부여합니다. -
등록된 사용자를 위해 임베드하려면 QuickSight 자산을 미리 공유하세요. 신규 인증 사용자의 경우 자산에 대한 액세스 권한을 부여하는 방법을 숙지하세요. 이를 수행하는 한 가지 방법은 QuickSight 폴더에 모든 자산을 추가하는 것입니다. QuickSight API를 사용하려면
DescribeDashboardPermissions
및UpdateDashboardPermissions
API 작업을 사용하세요. 자세한 내용은 Amazon QuickSight API 참조의 DescribeDashboardPermissions 또는 UpdateDashboardPermissions을 참조하세요. 네임스페이스 또는 그룹의 모든 사용자와 대시보드를 공유하려는 경우, 대시보드를namespace
또는group
와(과) 공유할 수 있습니다. -
대시보드를 임베딩하는 경우, 포함하려는 대시보드의 ID가 있어야 합니다. 대시보드 ID는 대시보드 URL의 코드입니다. 대시보드 URL에서도 가져올 수 있습니다.
-
QuickSight 관리자는 QuickSight 분석을 임베드하려는 도메인을 명시적으로 활성화해야 합니다. 프로필 메뉴에서 QuickSight 관리, 도메인 및 임베딩 관리를 사용하거나
GenerateEmbedUrlForAnonymousUser
또는GenerateEmbedUrlForRegisteredUser
API 호출의AllowedDomains
파라미터를 사용하여 이 작업을 수행할 수 있습니다.이 옵션은 QuickSight 관리자만 볼 수 있습니다. 하위 도메인을 도메인의 일부로 추가할 수도 있습니다. 자세한 내용은 QuickSight API를 사용하여 런타임 시 도메인 목록 등록 허용 단원을 참조하십시오.
정적 허용 목록의 모든 도메인(예: 개발, 스테이징, 프로덕션)이 명시적으로 허용되고 HTTPS를 사용해야 합니다. 최대 100개의 도메인을 허용 목록에 추가할 수 있습니다. QuickSight API 작업을 사용하여 런타임에 도메인을 추가할 수 있습니다.
모든 사전 요구 사항을 완료한 후 QuickSight를 포함하려면 다음 단계를 거쳐야 하며, 보다 자세한 내용은 나중에 설명이 나옵니다.
-
인증을 위해서는 애플리케이션 서버를 사용하여 사용자를 인증하세요. 서버에서 인증한 후, 필요한 AWS SDK를 사용하여 임베디드 대시보드 URL을 생성하세요.
-
웹 포털 또는 애플리케이션에서 생성된 URL을 사용하여 QuickSight를 임베드하세요. 이 프로세스를 단순화하기 위해 NPMJS
및 GitHub 에서 제공되는 Amazon QuickSight 임베딩 SDK를 사용할 수 있습니다. 이 사용자 지정 JavaScript SDK는 QuickSight를 애플리케이션 페이지에 효과적으로 통합하고, 기본값을 설정하고, 컨트롤을 연결하고, 오류를 처리할 수 있도록 돕기 위해 설계되었습니다.
AWS CloudTrail 감사 로그를 사용하여 임베디드 대시보드 수, 임베디드 경험 사용자 수 및 액세스 비율에 대한 정보를 가져올 수 있습니다.