Começar a usar a integração de aplicações e os destinos de integração de proxy do Apigee

Este tutorial mostra como usar o assistente de proxy do Apigee para criar um proxy com um alvo de integração. O proxy usa uma referência de acionador de API de uma integração existente para iniciar a sequência de passos na integração.

Os passos abaixo descrevem como configurar o proxy Integration target para executar uma integração bem-sucedida quando o proxy é chamado.

Antes de começar

  • Confirme as suas credenciais de início de sessão do Apigee e os detalhes da organização. Estas informações são necessárias para aceder à funcionalidade de integração de aplicações e ao assistente de proxy na IU do Apigee.
  • Crie e publique uma integração com um acionador de API e pelo menos uma tarefa.
    • Se ainda não criou uma integração que use um acionador de API, siga os passos em Obtenha a carga útil da API e envie um email.
    • Tome nota do nome da integração que criar ou da integração existente que quer usar, uma vez que é usada num passo posterior.
  • Crie uma conta de serviço Google no mesmo projeto do Google Cloud em que a sua organização do Apigee foi criada e faça o seguinte:
    • Atribua a função Application Integration Invoker (roles/integrations.applicationIntegrationInvokerRole) à conta de serviço. Para obter informações sobre as funções de integração de aplicações predefinidas, consulte o artigo Funções de IAM predefinidas.
    • Permitir que a sua conta de utilizador (principal) anexe contas de serviço a recursos com a autorização iam.serviceAccounts.actAs. Para obter informações sobre as autorizações da conta de serviço, consulte o artigo Funções para autenticação de contas de serviço .

    Tem de fornecer esta conta de serviço quando implementar o proxy de API.

  • Se quiser usar as integrações de aplicações sem limitações, pode pagar pelas integrações. A integração de aplicações está disponível como um serviço suplementar para a sua subscrição. Se já comprou a autorização da Application Integration e quiser ativar a autorização para o seu projeto do Google Cloud ou organização do Apigee, contacte o apoio técnico do Apigee. No entanto, se quiser comprar a autorização de integração de aplicações, contacte as vendas do Apigee. Depois de a integração de aplicações ser ativada para si, execute as seguintes tarefas:
    1. Ative as seguintes APIs:
      • API Apigee (apigee.googleapis.com)
      • API Application Integration (integrations.googleapis.com)
      • API Secret Manager (secretmanager.googleapis.com)
      • API Connectors (connectors.googleapis.com)

      Para obter informações sobre como ativar as APIs, consulte Ativar serviços.

    2. Ative os suplementos Integration e Connectors para a sua organização do Apigee.
      • Se estiver a criar uma nova organização para usar na integração, execute o seguinte comando:

        curl -H "Authorization: Bearer $TOKEN" -X POST -H "content-type:application/json" -d '{"name":"${ORG_ID}", "analyticsRegion":"us-west1", "authorized_network":"${NETWORK_ID}", "runtimeType":"CLOUD", "runtimeDatabaseEncryptionKeyName":"${ENCRYPTION_KEY_NAME}", "addonsConfig": {"integrationConfig": {"enabled": true}, "connectorsPlatformConfig":{"enabled":true}}}' "https://apigee.googleapis.com/v1/organizations?parent=projects/${PROJECT_ID}"
      • Se estiver a usar uma organização existente, execute o seguinte comando:

        curl -H "Authorization: Bearer $TOKEN" -H "content-type:application/json" "https://apigee.googleapis.com/v1/organizations/${ORG_ID}:setAddons" -XPOST -d '{"addonsConfig":{"integrationConfig":{"enabled":true},"connectorsPlatformConfig":{"enabled":true}}}'
    3. Verifique se os suplementos foram ativados com êxito através do seguinte comando:

      curl -H "Authorization: Bearer $TOKEN"  -H "content-type:application/json" "https://apigee.googleapis.com/v1/organizations/${ORG_ID}"

      A execução do comando deve apresentar uma mensagem semelhante à seguinte:

      {
        "name": "Test....",
        "createdAt": "1615483867669",
        "lastModifiedAt": "1615483873468",
        …...
        "addonsConfig": {
          "integrationConfig": {
            "enabled": true,
          "connectorsPlatformConfig": {
            "enabled": true
          }
        }
        }
    4. Atribua as seguintes funções do IAM à sua conta de serviço do Apigee predefinida(service-PROJECT_NUMBER@gcp-sa-apigee.iam.gserviceaccount.com):
      • Application Integration Invoker (roles/integrations.applicationIntegrationInvokerRole)

      Para obter informações sobre como conceder funções ou autorizações adicionais a uma conta de serviço, consulte o artigo Conceder, alterar e revogar o acesso.

Crie um proxy de destino da integração de aplicações

Faça o seguinte para criar um proxy de destino de integração na IU do Apigee:

  1. Aceda à IU do Apigee e inicie sessão.
  2. Selecione a sua organização através do menu pendente no canto superior esquerdo da IU.
  3. Clique em Proxies de API na vista principal.

    Em alternativa, pode selecionar Desenvolver > Proxies de API no menu de navegação do lado esquerdo.

  4. Na lista pendente Ambiente, selecione o ambiente no qual quer criar um novo proxy de API.
  5. Clique em Criar novo.
  6. Selecione Alvo de integração na apresentação dos tipos de proxy.

    O assistente Criar proxy é iniciado.

  7. Na página de configuração Detalhes do proxy, faculte os seguintes detalhes:
    • Nome: introduza um nome para o proxy.

      Os nomes dos proxies podem conter carateres alfanuméricos, travessões e sublinhados.

    • Caminho base: este campo é preenchido automaticamente com base no nome do proxy.

      O caminho base faz parte do URL usado para fazer pedidos à sua API. O Apigee usa o URL para fazer corresponder e encaminhar os pedidos recebidos para o proxy de API adequado.

    • Descrição: (opcional) introduza uma breve descrição do proxy.

      Por exemplo, Proxy test for Application Integration.

    • Região de integração: selecione a região da integração na lista pendente.
    • Alvo de integração: selecione o nome do alvo de integração na lista pendente. Tenha em atenção que a lista de destinos de integração é preenchida com base na região de integração selecionada.
    • Acionador: selecione o acionador da API associado à integração na lista pendente.
    • Tipo de ponto final: selecione Sincronizar.
  8. Clicar em Seguinte.
  9. Na página de configuração Políticas comuns, deixe as seleções predefinidas e clique em Seguinte.
  10. Na página Resumo, clique em Criar.

    Foi criado um proxy de alvo de integração com êxito.

Implemente o proxy

Execute os passos seguintes para implementar o proxy recém-criado:

  1. Na IU do Apigee, selecione Desenvolver > Proxies de API.

    A IU apresenta uma lista de proxies de API e o respetivo estado de implementação.

  2. Na lista pendente Ambiente, selecione o ambiente no qual quer implementar o proxy de API.
  3. Clique no proxy criado recentemente que quer implementar. A IU apresenta a página Vista geral por predefinição.

  4. Para implementar as alterações, primeiro: clique em Implementar para apresentar a caixa de diálogo Implementar.
  5. Introduza os seguintes dados:
    • Revisão: o número de revisão do proxy que quer implementar.
    • Ambiente: o ambiente onde quer implementar o proxy.
    • Conta de serviço: a conta de serviço criada para o proxy.
  6. Clique em Implementar.

A IU inicia o processo de implementação da revisão selecionada. A implementação do proxy pode demorar até um minuto.

Quando o proxy é implementado, a coluna Estado na secção Implementações apresenta um ícone verde para mostrar que a revisão 1 do proxy está implementada.

Teste o proxy de destino da integração

Execute o seguinte comando na janela do terminal para invocar o proxy e acionar a integração:

curl -v https://YOUR_ENV_GROUP_HOSTNAME/PROXY_NAME

em que YOUR_ENV_GROUP_HOSTNAME é o nome de anfitrião de um grupo de ambientes que contém o ambiente no qual o proxy está implementado.

Por exemplo:

curl -v https://my-org-prod.hybrid.e2e.apigeeks.net/my-proxy

Para confirmar que a integração foi acionada através da invocação do proxy:

  1. Abra a IU do Apigee.
  2. Clique em Desenvolver > Integrações.
  3. Pesquise ou selecione o nome da integração criada nos passos acima e clique no nome da integração.
  4. Clique em Registos.
  5. Verifique se existe um registo de execução para a integração acionada. Para ver os detalhes do registo, clique na linha para expandir os detalhes de execução.

Atualize o payload do pedido de proxy (opcional)

Siga estes passos para atualizar o payload do pedido de proxy:

  1. Na IU do Apigee, selecione Develop > API Proxies no menu de navegação do lado esquerdo.
  2. Clique no proxy criado recentemente.

    Por predefinição, a IU apresenta o separador Vista geral desse proxy no editor de proxies.

  3. Clique no separador Desenvolver.
  4. No painel Navegador, selecione Definir pedido de integração no cabeçalho Políticas.
  5. Descomente o bloco <Parameters> e introduza os detalhes dos parâmetros.

    Para especificar parâmetros individuais, use o elemento <Parameter>. Para especificar matrizes de parâmetros, use o elemento <ParameterArray>.

  6. Clique em Guardar.

O que se segue?

Explore o esquema do criador de integrações e compreenda os vários conceitos de integração descritos em Todos os conceitos.