Criar conector de aplicativos

Este artigo contém os seguintes tópicos:

Conector de aplicativos

O botão Novo conector do aplicativo ajuda a criar e gerenciar seus conectores de aplicativos. O conector de aplicativos oferece suporte a aplicativos com base na nuvem e no local. Cada conector executa várias operações. As operações descrevem a lista de APIs REST, HTTP expostas pelo sistema remoto. Cada operação é identificada por um terminal do URL, parâmetros de entrada e parâmetros de saída. Essas operações podem ser usadas em processos ou fluxos de trabalho. Durante o processo de automatizar os fluxos de trabalho e adicionar conectores para executar operações, é necessário configurar as credenciais do conector. Na guia Credenciais, é possível definir as credenciais que cada conector necessita para se conectar aos sistemas externos. Para obter mais informações sobre como configurar as credenciais do conector, consulte Credenciais do conector.

Você pode ir até essa guia clicando em ESPAÇOS DE TRABALHO, AUTOMAÇÃO, Centro de automação, Biblioteca de conectores, Novo conector do aplicativo.

O processo de criação de um conector de aplicativo consiste nas seguintes etapas:

Compreender a API do aplicativo de destino para o qual deseja criar um conector de aplicativo
Definir um conector de aplicativos
Configurar parâmetros de autenticação e validar
Configurar uma ou mais operações do conector
Usar conectores de aplicativos em fluxos de trabalho

Essas etapas são descritas em detalhes nos tópicos a seguir.

Compreender a API do aplicativo de destino para o qual deseja criar um conector de aplicativos

A primeira etapa para definir um conector de aplicativos é compreender a API do aplicativo de destino para o qual deseja criar um conector de aplicativos. São necessárias as seguintes informações:

URL da API – O URL do aplicativo de destino.
Tipo de autenticação – Os tipos de autenticação suportados são Básica, Nenhuma e Avançada.
Operações – As operações descrevem a lista de chamadas de API do aplicativo remoto. Cada operação é identificada por um terminal do URL, parâmetros de entrada e de saída.

Definir um conector de aplicativos

Configure as propriedades básicas de seu conector de aplicativos.
Siga estas etapas:

Vá para ESPAÇOS DE TRABALHO, AUTOMAÇÃO, Centro de automação, Biblioteca de conectores.
Clique em Novo conector do aplicativo.
Forneça os detalhes básicos sobre o conector na seção Propriedades básicas. Os detalhes básicos incluem o seguinte:
- O nome do conector de aplicativos.
- A versão da API. Um conector de aplicativos foi criado para uma versão da API específica que será publicada pelo aplicativo de destino. Os parâmetros de entrada/saída e as operações podem ser alterados em versões da API. Se tiver vários conectores para o mesmo aplicativo em versões diferentes, você pode usar esse campo.
- A descrição do conector explica o que o conector faz.
- O tipo de conector. Seu conector pode estar disponível na nuvem ou no local.
- O URL base do conector. Esse URL é usado pelo ServiceAide Cloud Service Management para se conectar ao serviço. Selecione o tipo de autenticação de usuário que deseja usar para seu conector. O ServiceAide Cloud Service Management oferece suporte à autenticação básica e à avançada.
- O formata da API. Os formatos de solicitação/resposta da API REST (tipo de conteúdo) podem ser JSON ou XML.
Configure as operações do conector.
Clique em Salvar.

Configurar parâmetros de autenticação e validar

O ServiceAide Cloud Service Management oferece suporte à autenticação Básica e Avançada e Nenhuma. Todas as chamadas de rest de HTTP requerem autenticação. Depois de preencher as propriedades básicas, é possível configurar os parâmetros de autenticação para o seu conector.

Autenticação básica: uma técnica de autenticação simples que é suportada por HTTP. A autenticação básica requer o nome de usuário e a senha.
Nenhuma: a autenticação não é necessária.
Autenticação avançada: a autenticação avançada é usada com aplicativos que têm o gerenciamento de sessões com base em token. Neste modelo, o usuário final obtém primeiro um token de sessão fazendo logon no aplicativo e, em seguida, usa esse token de sessão para acessar outros recursos nesse aplicativo. É importante usar o mesmo parâmetro de token de segurança na autenticação e em operações subsequentes para garantir que ambos estejam na mesma sessão. É possível consultar o Rally Connector para compreender como especificar a autenticação avançada.

- Definir parâmetros de autenticação não cria as credenciais. As credenciais podem ser adicionadas na guia Biblioteca de conectores ou no Editor de fluxo de trabalho. A validação dos parâmetros de autenticação resulta na criação das primeiras credenciais. É possível usar as primeiras credenciais para todas as operações subsequentes durante a definição. Essa credencial também pode ser usada durante a execução do fluxo de trabalho.

- Depois que um conector for salvo, seu tipo de autenticação não pode ser alterado.

Siga estas etapas:

Vá para ESPAÇOS DE TRABALHO, AUTOMAÇÃO, Centro de automação, Biblioteca de conectores.
Clique em Novo conector do aplicativo.
Selecione o tipo de autenticação de usuário que você deseja usar para o conector.
Clique no link Exibir o resultado do teste e selecionar parâmetros.
Uma janela pop-up aparece exibindo uma resposta da chamada de autenticação no formato JSON/XML.
Selecione o token a partir da saída da resposta para passar os parâmetros para a próxima chamada de operação. Clique em Selecionar parâmetros.
A sequência de caracteres de análise aparece automaticamente na caixa de texto como um parâmetro de saída na guia Parâmetros de saída.
Selecione os parâmetros que o conector passa da chamada de autenticação para as próximas chamadas da operação.
Observação: você pode fornecer um nome amigável para esse parâmetro na caixa Nome para identificar que pode ser usado em chamadas de operações subsequentes.
Clique em Salvar.
(Opcional) Clique em Validar.
Em caso de autenticação básica, a validação será automática se o nome de usuário e a senha forem especificados com precisão.
Em caso de autenticação avançada, uma janela pop-up aparece exibindo a saída de resposta JSON/XML. É exibido um botão Aceitar e Rejeitar. Clique em Aceitar. O status muda para Validado.
(Opcional) Clique em Usar autenticação básica se uma autenticação avançada também precisar de autenticação básica.
(Opcional) Clique em Enviar cookies se uma autenticação avançada precisar enviar cookies.

Configurar uma ou mais operações do conector

Defina as operações que o conector pode executar. As operações descrevem a lista de chamadas da API no aplicativo remoto. Cada operação é identificada por um terminal do URL, parâmetros de entrada e de saída. Essas operações podem ser usadas em processos ou fluxos de trabalho.

Siga estas etapas:

Vá para ESPAÇOS DE TRABALHO, AUTOMAÇÃO, Centro de automação, Biblioteca de conectores, Novo conector do aplicativo.
Clique em Nova operação.
Uma nova operação é adicionada no painel esquerdo. Você pode definir as propriedades da operação no painel direito. Um nome padrão é automaticamente atribuído à operação. É possível editar esse nome no campo Nome da operação.
Forneça uma descrição da operação no campo Descrição.
Forneça o Sub URL da operação. Cada API ReST é identificada usando um URI exclusivo. Esse URI é capturado como Sub URL. Exemplo: /ReST/v1_1/templates
Selecione o método HTTP que a operação chama. Exemplo: GET, POST, PUT e DELETE.
Clique em Avançar.
Defina os parâmetros de entrada e saída para as operações.
1. Parâmetros de entrada: fornecem as chaves necessárias pela API. Forneça os valores para o parâmetro de consulta de URL e o campo de cabeçalho HTTP. Selecione como os dados no corpo HTTP devem ser tratados. Na lista suspensa Corpo, selecione Dados do formulário ou Dados brutos.
  Cada parâmetro do URL possui três campos. Os dois primeiros campos capturam a chave, os pares de valor de um parâmetro do URL e o terceiro campo serve para fornecer o nome legível do usuário da chave. Esse valor é usado quando o campo for exibido na solicitação de serviço. Clique em + para adicionar mais parâmetros.
  - Selecione Dados do formulário e digite a Chave, o Valor e o Nome identificável pelo usuário, no formulário de carga de valor da chave.
  - Selecione Dados brutos e digite as informações de carga JSON/XML.
  - Forneça todos os valores de teste da API na caixa de texto Valor. O valor no Nome identificável pelo usuário cria um parâmetro de entrada para o conector. O parâmetro de entrada é exibido no mapeamento de dados. Forneça o parâmetro do URL real ou a chave do cabeçalho na caixa de texto Cabeçalho ou Parâmetro do URL.
  - Para personalizar o conteúdo do URL de subdirecionamento ou da carga e criar os valores do parâmetro de entrada que são fornecidos no momento da criação do fluxo de trabalho, use o formato {{VARIABLE_NAME:VALUE}}
2. Parâmetros de saída: fornece as chaves e os valores para a saída da operação.
  - - Clique em Exibir o resultado do teste e selecionar parâmetros de XML/JSON. Você receberá uma resposta em formato de árvore. Você pode usar essa resposta para criar parâmetros de saída expandindo a árvore e selecionando um valor.
    - Cada parâmetro de saída tem um Nome para identificar, que pode ser um nome definido pelo usuário para essa operação do conector. Você pode usar esse nome definido pelo usuário em um fluxo de trabalho se precisar enviar uma saída de etapa como entrada para a outra etapa.
A qualquer momento, clique em Salvar para salvar apenas os detalhes de sua operação. Para salvar o novo conector, clique em Salvar na parte superior da página. Clique em Avançar para ir para a próxima guia. Clique em Redefinir para limpar todos os detalhes.
Adicione mais operações conforme necessário.
Clique em Salvar na parte superior da página

Observação: valide a operação antes de salvar. Clique em Validar para ver uma janela pop-up com a resposta de saída e um botão Aceitar e Rejeitar. Clique em Aceitar e o status muda para Validado.

O conector de aplicativos é salvo e adicionado à lista de conectores, na guia Disponível na Biblioteca de conectores. Agora, é possível usar esse conector e criar fluxos de trabalho. Para obter mais informações, consulte Como criar um fluxo de trabalho. O fluxo de trabalho criado agora pode ser vinculado a um fluxo de processo no criador de processos. Para obter mais informações, consulte Etapas de automação de uso.

Usar conectores de aplicativos em fluxos de trabalho de automação

É possível usar o conector de aplicativos para automatizar tarefas como parte da criação do fluxo de trabalho de automação e durante a criação de um fluxo de processo no Criador de processos.

Exemplos de uso do conector de aplicativos em fluxos de trabalho de automação (uso repetitivo ad hoc)

A equipe de suporte de TI recebe uma solicitação de reparo de um laptop

Use um fluxo de trabalho de automação que consulta o serviço Dell para obter os detalhes da garantia e envia as informações por email para o pessoal de suporte de TI.
O pessoal de suporte pode decidir enviá-lo para reparo ou sugerir a compra de um novo.

Exemplos de uso do conector de aplicativos em fluxos de processo (processo de processamento do ticket)

Uma vez que o ticket é recebido, o analista pode acionar a etapa de automação para consultar o serviço Dell e atualizar os detalhes da garantia no ticket.
O ticket pode ser fechado com um sugestão para comprar um novo laptop.
O ticket pode ser fechado, após terem sido feitos os reparos.