Primeiros passos com a integração da Apigee e o Cloud Pub/Sub

Esta é a documentação da Apigee X.
Veja a documentação da Apigee Edge.

Neste tutorial, mostramos como criar uma integração de amostra usando a integração da Apigee e o gatilho do Cloud Pub/Sub. As etapas abaixo descrevem como configurar o gatilho do Cloud Pub/Sub, as tarefas, as variáveis e os mapeamentos de dados necessários para executar uma integração completa. Neste tutorial, você criará um tópico do Pub/Sub, criará uma integração com um acionador do Cloud Pub/Sub para ouvir o tópico do Pub/Sub, usar o mapeamento de dados para transformar mensagens do Pub/Sub e enviar um e-mail, tudo isso no designer de integração.

Antes de começar

Antes de iniciar o tutorial, siga estas etapas:

  • Confirme as credenciais de login e os detalhes da organização da Apigee. Essas informações são necessárias para acessar o recurso de integração no designer.
  • Crie um novo tópico do Cloud Pub/Sub. Neste tutorial, imagine que você tem um tópico do Pub/Sub que recebe leituras de temperatura em graus Kelvin de um dispositivo IOT. Não é necessário ter o tópico conectado a um dispositivo. Neste tutorial, você testará a capacidade da integração de detectar o tópico e realizar tarefas quando acionada.

    Para criar um tópico de amostra para os fins deste tutorial:

    1. Acesse a página de tópicos do Pub/Sub no Console do Cloud

      Acesse a página de tópicos do Cloud Pub/Sub.

    2. Clique em Criar um tópico
    3. No campo ID do tópico, forneça um nome de tópico exclusivo. Neste tutorial, insira temperaturesensor
    4. Clique em Save.

Criar uma nova integração

Para criar uma nova integração, execute as seguintes etapas:

  1. Acesse a IU da Apigee e faça login.
  2. Selecione a organização usando o menu suspenso no canto superior esquerdo da IU.
  3. Clique em Desenvolver > Integrações.
  4. Clique em CRIAR NOVA.
  5. Digite um nome e uma descrição na caixa de diálogo Criar integração. Por exemplo, my-test-integration.
  6. Selecione uma Região para a integração na lista de regiões compatíveis.
  7. Clique em Criar para abrir o designer de integração.

Adicionar um gatilho do Cloud Pub/Sub

Para adicionar um gatilho do Cloud Pub/Sub à integração, siga as etapas abaixo:
  1. No designer de integração, clique em + Adicionar uma tarefa/gatilho para ver a tarefa e acionar a caixa de diálogo de seleção.
  2. Clique em Acionadores para visualizar os acionadores disponíveis.
  3. Arraste o elemento Gatilho do Cloud Pub/Sub para o designer.

Configurar um gatilho do Cloud Pub/Sub

Clique no elemento Cloud Pub/Sub Trigger no designer de integração para visualizar o painel de configuração do acionador.

Especifique o tópico que o gatilho ouvirá no campo Tópico do Pub/Sub no seguinte formato: em que:

  • PROJECT_ID é o projeto do Google Cloud em que o tópico foi criado;
  • TOPIC_ID é o ID do tópico do Cloud Pub/Sub que você criou em Antes de começar.
projects/PROJECT_ID/topics/TOPIC_ID

Por exemplo, se seu projeto for denominado my-project e você nomeou seu tópico temperaturesensor, digite:

projects/my-project/topics/temperaturesensor

Para ver todos os tópicos disponíveis no seu projeto do Google Cloud, consulte a coluna Nome do tópico em Tópicos.

O painel de configuração preencherá automaticamente o campo Saída do acionador com uma variável para armazenar a mensagem do Pub/Sub, conforme mostrado abaixo:

imagem da variável de saída do acionador

Configurar a tarefa "Mapeamento de dados"

Para configurar a tarefa Mapeamento de dados:

  1. Selecione Adicionar uma tarefa/gatilho > Tarefas para exibir uma lista de tarefas disponíveis.
  2. Arraste o elemento Mapeamento de dados para o designer de integração.
  3. Clique na tarefa Mapeamento de dados no designer para abrir o painel de configuração da tarefa.
  4. Clique em Abrir editor de mapeamento de dados.

    O Editor de mapeamento de dados permite mapear variáveis de entrada para as variáveis de saída desejadas, usando as funções de transformação disponíveis. A saída é disponibilizada como uma variável para qualquer outra tarefa ou gatilho de integração. Para mais detalhes sobre como transmitir dados como variáveis, consulte Como usar variáveis na integração da Apigee.

    Para este tutorial, siga estas etapas para criar um mapeamento usando CloudPubSubMessage como entrada:

    1. Arraste o ícone CloudPubSubMessage da lista Variáveis no lado esquerdo do editor para o primeiro campo Input.
    2. Clique em + Adicionar função no chip CloudPubSubMessage para ver a lista suspensa de funções disponíveis.
    3. Clique em TO_DOUBLE() para converter o valor JSON de CloudPubSubMessage em um tipo de dados double.
    4. Clique em + para encadear uma função de mapeamento adicional.
    5. Clique em SUBTRACT na lista suspensa e insira um parâmetro de 273.15 para converter a temperatura de Kelvin em graus Celsius.
    6. Clique no primeiro campo na coluna Saída para criar uma nova variável que armazene o valor dos dados transformados. Preencha os seguintes campos:
      • Nome: insira TemperatureInCelsius.
      • Marque a opção Usar como saída da integração.
      • Clique em Criar para criar a variável e fechar o painel. A nova variável Temperatura em Celsius será exibida na lista Variáveis à esquerda do editor de mapeamento de dados.
    7. Arraste o chip Temperatura em Celsius da lista Variáveispara o segundo campo na coluna Entrada.
    8. Clique em + Adicionar função no chip Temperatura em Celsius para visualizar a lista suspensa de funções disponíveis.
    9. Clique em TO_STRING() para transformar o tipo de dados da variável de double para string.
    10. Clique no segundo campo na coluna Saída para criar uma nova variável que armazene o valor dos dados transformados. Preencha os seguintes campos:
      • Nome: insira TemperatureInCelsiusString.
      • Ter um valor padrão em branco significa... Selecione String vazia.
      • Marque a opção Usar como saída da integração.
      • Clique em Criar para criar a variável e fechar o painel. A nova variável será exibida na lista Variáveis à esquerda do editor de mapeamento de dados.
    11. O mapeamento concluído será exibido como mostrado na figura abaixo:

      imagem do mapeamento de dados e variáveis concluídas

    12. Clique no X no editor de mapeamento de dados, salve o mapeamento e feche o editor.
  5. Adicione uma conexão de borda do elemento Cloud Pub/Sub Trigger ao elemento Mapeamento de dados passando o mouse sobre um ponto de controle no Cloud Pub/Sub Trigger e, em seguida, clicar e arrastar uma linha para um ponto de controle no elemento de tarefa Mapeamento de dados. A borda indica o fluxo de controle da tarefa Acionador do Cloud Pub/Sub para a tarefa Mapeamento de dados.

Configurar a tarefa "Enviar e-mail"

Para configurar a tarefa Enviar e-mail, siga estas etapas:

  1. Selecione Adicionar uma tarefa/gatilho > Tarefas no designer de integração para exibir a lista de tarefas disponíveis.

    Nesta etapa, use a tarefa Send email.

  2. Arraste o elemento Enviar e-mail para o designer de integração.
  3. Clique no elemento Enviar e-mail no designer para abrir o painel de configuração da tarefa. Defina as seguintes propriedades:
    • Destinatários: digite seu endereço de e-mail. Você usará esse e-mail para confirmar a conclusão da integração.
    • Assunto: insira Temperature in Celsius.
    • Corpo do e-mail: selecione a variável TemperatureInCelsiusString criada anteriormente na tarefa Mapeamento de dados.
    • As opções restantes podem ser deixadas na configuração padrão.
    As alterações feitas nas propriedades são salvas automaticamente.
  4. Adicione uma conexão de borda pelo elemento Mapeamento de dados ao elemento Enviar e-mail passando o cursor sobre um ponto de controle no elemento Mapeamento de dados. Em seguida, clique e arraste uma linha para um ponto de controle no elemento da tarefa Enviar e-mail. Os pontos de controle e a linha de borda ficarão amarelos. A borda indica o fluxo de controle da tarefa Mapeamento de dados para a tarefa Enviar e-mail.

    Após a conclusão dessa etapa, a integração estará completa e aparecerá como mostrado na figura abaixo:

    imagem de gatilho de integração e tarefas

Testar a integração

Para testar a nova integração:

  1. Clique no botão Publicar na barra de ferramentas do designer de integração.
  2. Acesse a página de tópicos do Pub/Sub no Console do Cloud

    Acesse a página de tópicos do Cloud Pub/Sub.

  3. Pesquise e selecione o tópico temperaturesensor criado em uma etapa anterior.
  4. Na página de detalhes do tópico, clique em + Publicar mensagem para abrir o painel de configuração Publicar mensagem.
  5. No campo Corpo da mensagem, digite 307.15. A criação dessa mensagem simula a publicação de uma leitura de temperatura em Kelvin recebida pelo Pub/Sub de um dispositivo IOT.
  6. Clique em Publicar para publicar a mensagem no tópico e acionar a integração.

Após a conclusão, a integração enviará um e-mail com a temperatura da Kelvin convertida em graus Celsius para o endereço de e-mail especificado na tarefa Send Email. Confirme o recebimento da mensagem no seu cliente de e-mail.

O e-mail enviado pela integração deverá ter um corpo de mensagem com o valor 34.

Além de verificar o conteúdo do e-mail, é possível inspecionar os registros para visualizar o status e o payload de uma determinada integração. Para ver os registros:

  1. Clique em Registros na barra de ferramentas do designer de integração.
  2. Na página Execution Logs, você pode ver detalhes sobre cada tentativa de executar uma integração. Cada entrada inclui detalhes para a tentativa de execução, incluindo:
    • Nome da integração
    • ID da execução
    • Status
    • Horário de início
    • Duração
    • ID de integração
    • ID de acionamento
  3. Clique na seta de expansão (>) ao lado da integração executada para exibir uma lista expandida de tarefas e variáveis na integração, além do status da tarefa e dos payloads da variável, conforme mostrado na figura abaixo:

    imagem de registros de integração

Parabéns! Você concluiu a configuração e a implantação de uma integração com a Apigee e um gatilho do Cloud Pub/Sub.

A seguir