View a markdown version of this page

Integração de ações do Atlassian Confluence Cloud - Amazon Quick
Antes de começarConfigurar o Atlassian Developer ConsolePrepare a autenticaçãoConfigure a integração no Amazon QuickAções disponíveisGerenciar e solucionar problemas

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Integração de ações do Atlassian Confluence Cloud

Use o conector de ação do Atlassian Confluence Cloud para criar, atualizar e gerenciar páginas e espaços do Confluence diretamente no Amazon Quick por meio de linguagem natural.

Para configurar essa integração, primeiro você cria um aplicativo OAuth 2.0 (3LO) no Atlassian Developer Console e configura suas permissões. Em seguida, você cria a integração no Amazon Quick e a conecta ao seu aplicativo Atlassian. Para obter informações sobre os métodos de autenticação compatíveis com o Amazon Quick, consulteMétodos de autenticação.

Antes de começar

Certifique-se de ter o seguinte antes de configurar a integração.

Configurar o Atlassian Developer Console

Se você planeja usar a autenticação de usuário (3LO), crie um aplicativo OAuth 2.0 no Atlassian Developer Console antes de configurar o Amazon Quick. Conclua todas as etapas a seguir antes de migrar para o console do Amazon Quick.

Se você planeja usar somente a autenticação de serviço (chave de API), pode pular esta seção e continuarPrepare a autenticação.

Para obter mais informações sobre aplicativos OAuth 2.0 (3LO), consulte Aplicativos OAuth 2.0 (3LO) na documentação do desenvolvedor da Atlassian.

Crie um OAuth aplicativo 2.0 (3LO)

O Amazon Quick usa um aplicativo Atlassian OAuth 2.0 (3LO) para se autenticar com seu produto Atlassian Cloud em nome de seus usuários. Crie esse aplicativo no Atlassian Developer Console antes de configurar o Amazon Quick.

  1. Abra o Atlassian Developer Console e faça login com sua conta Atlassian.

  2. Escolha Criar e, em seguida, escolha Integração OAuth 2.0.

  3. Em Nome, insira um nome descritivo para sua integração, por exemployour-app-name connector.

  4. Revise e aceite os termos para desenvolvedores da Atlassian.

  5. Escolha Criar.

Configurar permissões do

Depois de criar o aplicativo OAuth 2.0, adicione as permissões de API que o Amazon Quick precisa para interagir com seu produto Atlassian.

  1. No seu aplicativo no Atlassian Developer Console, escolha Permissões no painel de navegação à esquerda.

  2. Encontre a API para seu produto Atlassian (por exemplo, API Jira ou API Confluence) e escolha Adicionar. O botão muda para Configurar depois que a API é adicionada.

  3. Selecione Configurar. A página de escopos é aberta com as guias Escopos clássicos e Escopos granulares.

  4. Na guia Escopos clássicos, escolha Editar escopos. Selecione os escopos clássicos necessários e escolha Salvar.

  5. Escolha a guia Escopos granulares e, em seguida, escolha Editar escopos. Selecione os escopos granulares necessários e escolha Salvar.

Para os escopos específicos necessários para sua integração, consulte a seção de escopos a seguir.

Escopos necessários para o Confluence

Adicione os seguintes escopos ao seu aplicativo OAuth 2.0 para a integração de ações do Confluence Cloud.

Mira clássica

Na guia Escopos clássicos, escolha Editar escopos e selecione o escopo a seguir.

Integração de ações do Confluence — escopo clássico
Escopo Description
search:confluence Pesquise resumos de conteúdo e espaço do Confluence.

Escopos granulares

Escolha a guia Escopos granulares e, em seguida, escolha Editar escopos. Selecione os seguintes escopos.

Integração de ações do Confluence — escopos granulares
Escopo Description
read:page:confluence Visualize o conteúdo da página.
write:page:confluence Crie e atualize páginas.
read:space:confluence Acesse as informações do espaço.

Configurar autorização

Defina a URL de retorno de chamada para que a Atlassian possa redirecionar os usuários de volta para o Amazon Quick depois que eles autorizarem o aplicativo.

  1. No seu aplicativo no Atlassian Developer Console, escolha Autorização no painel de navegação à esquerda.

  2. Ao lado de OAuth 2.0 (3LO), escolha Adicionar.

  3. Em Callback URLs, insirahttps://region.quicksight.aws.amazon.com/sn/oauthcallback. regionSubstitua pela AWS região em que sua instância Amazon Quick está implantada, por exemplous-east-1.

  4. Escolha Salvar alterações.

Registre suas credenciais

Antes de sair do Atlassian Developer Console, confirme se você tem os seguintes valores. Você precisa deles para a configuração do Amazon Quick.

  1. No seu aplicativo no Atlassian Developer Console, escolha Configurações no painel de navegação à esquerda.

  2. Em Detalhes da autenticação, copie os valores do ID do cliente e do segredo.

Credenciais obrigatórias do Atlassian Developer Console
Valor Onde encontrá-lo
ID de cliente Página de configurações, em Detalhes de autenticação
Secret Página de configurações, em Detalhes de autenticação

Prepare a autenticação

Os conectores de ação do Confluence Cloud oferecem suporte a dois métodos de autenticação. Reúna as credenciais necessárias antes de configurar o Amazon Quick.

Autenticação de usuário (3LO)

Se você concluiu a configuração do Atlassian Developer Console na seção anterior, deverá ter os seguintes valores prontos. Digite-os ao configurar a integração no Amazon Quick.

  • URL base — o URL da instância do Confluence para chamadas de API. Esse não é o mesmo URL em que os usuários fazem login. É semelhante ao seguinte:https://api.atlassian.com/ex/confluence/yourInstanceId. Para encontrar o ID da sua instância, navegue atéhttps://your-domain.atlassian.net/_edge/tenant_info.

  • ID do cliente — Na página de configurações do seu aplicativo Atlassian OAuth .

  • Segredo do cliente — Na página de configurações do seu aplicativo Atlassian OAuth .

  • URL do token — https://auth.atlassian.com/oauth/token

  • URL de autorização — https://auth.atlassian.com/authorize

  • URL de redirecionamento — https://region.quicksight.aws.amazon.com/sn/oauthcallback

Autenticação de serviço (chave de API)

Reúna as seguintes informações do administrador do Confluence Cloud:

  • Chave de API — token da API do Confluence.

  • URL base — o URL da instância do Confluence para chamadas de API.

  • E-mail — E-mail da conta de usuário associada.

Configure a integração no Amazon Quick

Depois de preparar suas credenciais de autenticação, crie a integração no Amazon Quick.

  1. No console do Amazon Quick, escolha Integrações.

  2. Escolha a guia Ações.

  3. Em Configurar uma nova integração de aplicativos para ações, encontre o Atlassian Confluence Cloud e escolha o botão Adicionar (mais “+”).

  4. Na página Tipo de integração, selecione Executar ações no Atlassian Confluence Cloud e escolha Avançar.

  5. No formulário Criar integração, preencha os seguintes campos:

    • Nome — Nome descritivo para sua integração com o Confluence.

    • Descrição (opcional) — Notas sobre como essa conexão será usada.

    • Tipo de conexão — Escolha Rede pública.

  6. Em Configurações de autenticação, escolha seu método de autenticação e preencha os campos obrigatórios:

    1. Para autenticação do usuário, configure os seguintes campos:

      • URL base — o URL da instância do Confluence para chamadas de API, no formato. https://api.atlassian.com/ex/confluence/yourInstanceId Para encontrar o ID da sua instância, navegue atéhttps://your-domain.atlassian.net/_edge/tenant_info.

      • ID do cliente — ID do cliente na página de configurações do seu aplicativo Atlassian OAuth .

      • Segredo do cliente — Segredo da página de configurações do seu aplicativo Atlassian OAuth .

      • URL do token — https://auth.atlassian.com/oauth/token

      • URL de autorização — https://auth.atlassian.com/authorize

      • URL de redirecionamento — Esse campo é pré-preenchido com sua URL de retorno de chamada do Amazon Quick.

    2. Para autenticação de serviço, configure os seguintes campos:

      • Chave de API — token da API do Confluence.

      • URL base — o URL da instância do Confluence para chamadas de API.

      • E-mail — E-mail da conta de usuário associada.

  7. Escolha Criar e continuar.

  8. (Opcional) Na página Compartilhar integração, escolha os usuários com os quais compartilhar a integração.

Ações disponíveis

Depois de configurar a integração, as ações a seguir estarão disponíveis.

Ações disponíveis do Confluence Cloud
Ação Description
Criar página Crie uma nova página.
Obter páginas Veja todas as páginas.
Pesquisa Pesquise conteúdo usando CQL.
Página de atualização Atualize o conteúdo da página.

Gerenciar e solucionar problemas

Para editar, compartilhar ou excluir sua integração, consulteGerenciando integrações existentes.

Problemas de autenticação

  • Configuração incorreta do aplicativo — Verifique se o OAuth aplicativo no Atlassian Developer Console inclui os escopos necessários e se o URI de redirecionamento corresponde à sua configuração do Amazon Quick.

  • Token de API expirado — Se estiver usando a autenticação de serviço, verifique se o token de API não expirou e gere um novo, se necessário.

  • URL base incorreta — A URL base para chamadas de API não é a mesma que a URL de login do Confluence Cloud. Verifique se você está usando o formato de URL da API:https://api.atlassian.com/ex/confluence/yourInstanceId. Para encontrar o ID da sua instância, navegue atéhttps://your-domain.atlassian.net/_edge/tenant_info.

Mensagens de erro comuns

  • Access denied. You do not have permission to perform this action— O usuário autenticado não tem as permissões necessárias no Confluence Cloud. Entre em contato com seu administrador do Confluence Cloud para verificar e conceder as permissões apropriadas.

  • OAuth 2.0 authorization failed— Verifique se o ID do cliente, o segredo do cliente e OAuth os escopos estão configurados corretamente no Atlassian Developer Console e no Amazon Quick.