Primeiros passos com a integração da Apigee

Você está vendo a documentação da Apigee X.
Veja a documentação da Apigee Edge.

Neste guia de início rápido, mostramos como criar uma integração de amostra usando a integração da Apigee. As etapas abaixo descrevem como configurar o gatilho, as tarefas, as bordas, as variáveis e os mapeamentos de dados necessários para executar uma integração completa. Neste guia de início rápido, você recupera uma lista de produtos de um endpoint de URL, transforma os dados em um formato utilizável e envia a lista resultante em um e-mail, tudo no designer de integração.

Antes de começar

Antes de começar o início rápido, 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 da Apigee no designer.

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.

Configurar um gatilho

Os acionadores são necessários para iniciar a sequência de tarefas que compõem uma integração. Qualquer gatilho disponível pode ser usado para iniciar uma integração. Para usar o guia de início rápido, use o Gatilho de API.

Para configurar o acionador de API, faça o seguinte:

  1. No designer de integração, selecione Adicionar uma tarefa/gatilho > Gatilhos para exibir uma lista de gatilhos disponíveis.
  2. Arraste o elemento Gatilho da API para o designer de integração.
  3. Clique no elemento Gatilho da API no designer para abrir o painel de configuração do gatilho.
  4. A integração com a Apigee preenche automaticamente o Rótulo, o nome do gatilho e o código do acionador da Apigee. O Id do gatilho é gerado por máquina e não é possível editar o valor. No entanto, é possível editar o valor das propriedades Rótulo e Nome do gatilho.

    As alterações nas propriedades são salvas automaticamente.

Adicionar e configurar tarefas

Uma tarefa é um conjunto executável de etapas que pode assumir variáveis como entradas e gerar variáveis como saídas. Assim como os gatilhos, qualquer tarefa disponível pode ser usada em uma integração. Neste guia de início rápido, usamos as tarefas Call REST Endpoint, Mapeamento de dados e Enviar e-mail. Os detalhes de configuração de cada tarefa são descritos nas etapas abaixo.

Configurar a tarefa Call REST Endpoint

Para configurar a tarefa Call REST Endpoint:

  1. Selecione Adicionar uma tarefa/gatilho > Tarefas para exibir uma lista de tarefas disponíveis.
  2. Arraste o elemento Call REST Endpoint para o designer de integração.
  3. Clique no elemento Call REST Endpoint no designer para abrir o painel de configuração da tarefa. Defina as seguintes propriedades:
    • Rótulo: insira um nome personalizado para a tarefa. Por exemplo, insira Call REST Endpoint Task.
    • Autenticação: para este guia de início rápido, um perfil de autenticação não é necessário. Para mais informações sobre como usar perfis de autenticação para outros casos de uso, consulte Criar perfis de autenticação na integração da Apigee.
    • TASK INPUT: insira os detalhes para chamar o endpoint REST. As informações inseridas aqui são usadas como entrada para a tarefa Call REST Endpoint. Digite as seguintes informações:
      • Endpoint base URL: digite https://apigee-pm4-prod.apigee.net/v1/hipsters/products. Esse endpoint retorna uma matriz de objetos de produto, cada um com um id, name, description, picture, price e uma matriz de categories.
      • Método HTTP: selecione GET usando a lista suspensa.
      • Cabeçalhos HTTP adicionais: insira qualquer cabeçalho adicional necessário para acessar o endpoint. Neste guia de início rápido:
        • Insira x-apikey no campo Chave do cabeçalho HTTP.
        • Insira H7WpkpvdCAC2jSffbmKpQLVduxC6nOO9 no campo valor.
    • TASK OUTPUT: aqui, a integração da Apigee preenche três variáveis para reter a saída de dados de resposta de chamada do endpoint REST:
      • responseHeader(Call REST Endpoint): essa variável contém os dados do cabeçalho de resposta associados à tarefa Call REST Endpoint. Os dados variáveis são do tipo String (STR).
      • responseBody(Call REST Endpoint): essa variável contém os dados do corpo de resposta associados à tarefa Call REST Endpoint. Os dados variáveis são do tipo String (STR).
      • responseStatus(Call REST Endpoint): essa variável contém os dados de status da resposta associados à tarefa Call REST Endpoint. Os dados variáveis são do tipo String (STR).
    • Veja os detalhes de cada variável clicando no nome dela no painel de configuração da tarefa. Para este guia de início rápido, mantenha os valores padrão para cada uma dessas variáveis.
    • Os campos restantes precisam conter os seguintes valores padrão:
      • Follow redirects: True
      • Throw error: False
      • Tentar novamente em caso de falha
        • Quando a integração é executada de maneira síncrona: None
        • Quando a integração é executada de maneira assíncrona: None

    As alterações nas propriedades são salvas automaticamente.

    A configuração concluída precisa corresponder à figura abaixo:

    Chamar o gatilho do endpoint REST

  4. Adicione uma conexão de borda do elemento API Trigger ao elemento Call REST Endpoint passando o cursor sobre um ponto de controle no elemento API Trigger. Depois, clique e arraste uma linha para um ponto de controle no elemento de tarefa Call REST Endpoint. Os pontos de controle e a linha de borda ficarão amarelos, conforme mostrado na imagem abaixo:

    designer de integração mostrando a conexão de borda

    A borda indica o fluxo de controle do Gatilho de API para a tarefa Call REST Endpoint.

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 guia de início rápido, siga estas etapas para criar um mapeamento usando responseBody(Call REST Endpoint) como entrada:

    1. Arraste o ícone responseBody da lista Variáveis no lado esquerdo do editor para o primeiro campo Entrada.
    2. Clique em + Adicionar função no ícone responseBody para visualizar a lista suspensa de funções disponíveis.
    3. É possível aplicar várias funções de mapeamento de dados para transformar os dados na variável de entrada. Nesse caso, é possível converter o payload em JSON e depois iterar na matriz de resposta para obter a lista de nomes de produtos necessária para as notificações por e-mail. Clique no símbolo + Adicionar função na variável responseBody para abrir a lista de funções disponíveis. Use as seguintes funções:
      • Selecione TO_JSON() para converter a string responseBody em JSON.
      • Clique no símbolo + Adicionar função no ícone de variável responseBody novamente para selecionar e encadear a GET_PROPERTY() função. Essa função extrairá uma propriedade do payload JSON. Transmita a propriedade products.name como o parâmetro para esta função. Com isso, será retornada uma lista APENAS com nomes de produtos, sem outras informações do produto. Sua função será semelhante a esta:
        responseBody(Call REST Endpoint).TO_JSON().GET_PROPERTY(products.name)
      • Se você precisar remover ou excluir uma função, clique no símbolo -. Isso removerá a função adicionada recentemente.
    4. 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 JSONProdNameList.
      • Tipo de dado: JSON
      • 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 JSONProdNameList será exibida na lista Variáveis à esquerda do editor de mapeamento de dados.
    5. No Editor de mapeamento de dados, clique no X para salvar o mapeamento e fechar o editor.
    6. O mapeamento concluído será exibido como mostrado na figura abaixo:

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

  5. Adicione uma conexão de borda do elemento Call REST Endpoint ao elemento Mapeamento de dados passando o cursor sobre um ponto de controle no elemento Call REST Endpoint. Depois, clique e arraste uma linha para um ponto de controle no elemento da tarefa Mapeamento de dados. A borda indica o fluxo de controle da tarefa Call REST Endpoint 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 Email from Apigee Integrations.
    • Corpo do e-mail: selecione a variável JSONProdNameList criada anteriormente na tarefa Mapeamento de dados.
    • As opções restantes podem ser deixadas na configuração padrão.

    As alterações nas propriedades são salvas automaticamente.

    A configuração concluída precisa corresponder à figura abaixo:

    Configuração de tarefa de e-mail

  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.

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. Publicar a integração ativa o botão Testar na barra de ferramentas.
  2. Clique em Testar e selecione Acionador da API.
  3. Na caixa de diálogo Confirmar publicação e teste, clique em Publicar e testar.

Para mais informações sobre testes, consulte Como testar integrações.

Após a conclusão, a integração envia um e-mail com a lista de nomes de produtos 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 precisa ter um corpo semelhante a este:

["Vintage Typewriter", "Vintage Camera Lens", "Home Barista
Kit", "Terrarium", "Film Camera", "Vintage Record Player", "Metal Camping
Mug", "City Bike", "Air Plant"]

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 ver uma lista expandida de tarefas e variáveis na integração, além do status da tarefa e payloads de variável.

Parabéns! Você configurou e implantou uma integração com a Apigee.

A seguir