Jira
Um serviço oferecido pela Pier Cloud que permite integrar a plataforma com a ferramenta Jira Cloud para envio de notificações com abertura de cards. De forma a fornecer visibilidade sobre os custos dos projetos, o uso de recursos, com direcionamento de iniciativas referentes as anomalias identificadas e alarmes acionados.
Conectando o Jira a Plataforma da Pier Cloud
PRE REQUISITO:
Uma conta ativa no Jira Cloud, com direitos administrativos.
Preferencialmente utilizar uma conta de usuário dedicado para essa integração, que possua endereço de email com as permissões necessárias para operações de API que deseja executar.
Mais abaixo iremos apresentar dicas para seleção do endereço de email apropriado e vantagens de criar uma conta de usuário dedicado para a integração com a nossa plataforma.
O projeto (board) no Jira que deseja receber as notificações, não deve possuir campos de preenchimento obrigatórios para abertura de cards. Caso seja necessário, nós recomendamos a criação de projeto dedicado para o recebimento das notificações, onde não existe a obrigatoriedade de preenchimento de nenhum campo.
Acesso à plataforma da Pier Cloud, com as permissões necessárias para configurar e gerenciar integrações.
No ambiente da Atlassian
Etapa 1: Gerar um token de API no Jira Cloud
Acesse sua conta do Jira Cloud através do link: https://id.atlassian.com/manage/api-tokens
Vá para Configurações da conta e selecione Segurança.
Em Tokens de API, clique em Criar um token de API:
Atribua um nome descritivo para fácil identificação da sua API Token
ex:
Integração Pier Cloud Notificações
Informe uma data de expiração, que não poderá exceder 1 ano.
Clique em Criar
Será apresentada a tela para Copiar o Token de API
Clique em Copiar e armazene o token em um local seguro
Por fim, clique em Concluído, para sair da tela.
Guarde o token em local seguro — ele não poderá ser visto novamente depois que você fechar a janela.
No Ambiente da Pier Cloud
Etapa 2: Criação do Segredo
Clicando no perfil do usuário, na opção “Configurações”, conforme ilustrado abaixo:

O sistema apresentará o menu lateral com algumas opções de configuração, onde deve ser selecionada a opção “Segredos”:

Ao clicar na opção Adicionar, o sistema irá apresentar a tela para criação do segredo, onde devem ser inseridas as seguintes informações:

Nome: Atribua um nome que identifique o segredo
Tipo: Selecione o tipo Jira Token
Email: O endereço de e-mail vinculado à sua conta Jira, utilizado para criação do token.
Jira API Token: Insira o token de API criado no ambiente da Atlassian no passo 6.
URL do servidor: A URL da sua instância específica do Jira Cloud. Copiar a URL até o .net, conforme exemplo abaixo, e colar aqui.
ex.:
https://seudominio.atlassian.net

Uma vez preenchida todas as informações, clique em Salvar e vamos continuar com a configuração da notificação.
Etapa 3: Cadastro de provedor em Notificações:
No menu laterial, selecione a funcionalidade de Notificações e clique no ícone "
", correspondente ao grupo de notificação desejado, para retornar ao cadastro do provedor Jira:

O sistema irá apresentar a tela contendo os provedores cadastrados e possibilitando a inclusão de novos ao clicar no botão "Adicionar":

O sistema irá apresentar a tela de cadastro do provedor, onde deveremos preencher os seguintes campos:

Selecione o tipo: Jira
Nome: Informar um nome que identifique o provedor
Configurações: Para o tipo de provedor Jira, será necessário preencher os seguintes campos adicionais:
ID ou Key do projeto: Informar o ID ou chave do projeto (board) que irá receber a notificação no Jira.
Normalmente essa chave corresponde a uma sigla atribuída ao projeto na sua criação, podendo ser identificada na configuração do projeto.
Tipo de issue: Informar o tipo de card que deve ser criado, conforme existente na abertura de um card no board do Jira. Escrever exatamente como estiver escrito no Jira.
Ex.: Bug
Selecione o segredo da sua Api Key: Nesse passo, iremos selecionar o segredo criado no passo 4.
Por fim, clique no botão Salvar e o está concluída a configuração das notificações para o Jira.
Como selecionar o Endereço de E-mail Apropriado do Jira?
Identificação: O endereço de e-mail do Jira é um identificador importante da sua conta de usuário no Jira Cloud, essencial para autenticar e autorizar a conexão entre a plataforma da Pier Cloud e o Jira.
Autenticação da API: Para requisições de API no Jira Cloud, como a criação de um issue é necessária autenticação para verificar a legitimidade e a autorização da solicitação. Normalmente, isso envolve o uso de um endereço de e-mail combinado com um token de API para autenticação básica no Jira Cloud.
Contexto da Integração: O e-mail escolhido determina a conta específica do Jira com a qual a plataforma irá interagir. Isso é importante, pois qualquer ação (como criar ou atualizar issues) executada pela plataforma será realizada com os privilégios e permissões da conta Jira associada.
Auditoria e Rastreabilidade: As ações executadas via API geralmente são registradas pelo Jira. O endereço de e-mail pode ser usado para identificar a conta envolvida nessas ações, auxiliando em trilhas de auditoria e no diagnóstico de problemas.
Garanta que você selecione um endereço de e-mail do Jira que possua as permissões adequadas necessárias para as operações de API que pretende executar. Por exemplo, se a sua integração tem como objetivo criar issues, a conta Jira vinculada ao e-mail deve ter as permissões necessárias para criar issues no projeto Jira designado.
Criar um usuário de serviço dedicado no Jira Cloud
Etapa 1: Criar uma nova conta de usuário
Acesse a seção de gerenciamento de usuários no Jira.
Crie um novo usuário, designado exclusivamente para a integração.
Forneça um nome claro, como
integration_service_user
, para fácil reconhecimento.
Etapa 2: Atribuir as permissões necessárias
Conceda ao novo usuário as permissões necessárias para tarefas como criação e gerenciamento de issues.
Atenção: evite conceder permissões administrativas, a menos que seja realmente necessário.
Vantagens de utilizar um usuário dedicado
Controle de Permissões: facilita o gerenciamento e auditoria de permissões, mantendo-as isoladas de contas de usuários reais.
Estabilidade e Continuidade: a integração não fica vinculada à conta de um colaborador específico, garantindo continuidade independentemente de mudanças na equipe.
Segurança Aprimorada: reduz os riscos de usar contas pessoais para integrações e ajuda a manter uma separação clara entre atividades de usuários e processos automatizados.
Trilhas de Auditoria: qualquer ação executada pela integração é atribuída ao usuário de serviço de integração, facilitando o rastreamento e a auditoria.
Pontos importantes a considerar
Manutenção Regular: como qualquer conta, garanta que as credenciais do usuário de serviço sejam gerenciadas com segurança e que suas permissões sejam revisadas regularmente para eventuais atualizações.
Last updated