Introdução ao Application Integration e aos destinos de integração de proxy da Apigee

Neste tutorial, você verá como usar o assistente de proxy do Apigee para criar um proxy com um destino de integração. O proxy usa uma referência do gatilho de API de uma integração existente para iniciar a sequência de etapas na integração.

As etapas abaixo descrevem como configurar o proxy de destino de integração para executar uma integração bem-sucedida quando o proxy é chamado.

Antes de começar

Confirme as credenciais de login e os detalhes da organização da Apigee. Essas informações são necessárias para acessar o recurso Application Integration e o assistente de proxy na interface do usuário do Apigee.
Crie e publique uma integração com um gatilho de API e pelo menos uma tarefa.
- Se você ainda não criou uma integração que usa um acionador de API, siga as etapas em Recuperar payload da API e enviar um e-mail.
- Anote o nome da integração criada ou a integração atual que você quer usar, porque ela será usada em uma etapa posterior.
Crie uma conta de serviço do Google no mesmo projeto do Google Cloud em que sua organização da Apigee foi criada e siga estas etapas:
- Atribua o papel Invocador do Application Integration (roles/integrations.applicationIntegrationInvokerRole) à conta de serviço. Para informações sobre os papéis predefinidos do Application Integration, consulte Papéis predefinidos do IAM.
- Permita que sua conta de usuário (principal) anexe contas de serviço a recursos com a permissão iam.serviceAccounts.actAs. Para informações sobre permissões da conta de serviço, consulte Papéis para a autenticação da conta de serviço .
É preciso fornecer essa conta de serviço ao implantar o proxy de API.
Se você quiser usar as integrações de aplicativo sem limitações, poderá pagar pelas integrações. A Application Integration está disponível como um serviço complementar para sua assinatura. Se você já comprou o direito de acesso à Application Integration e quer ativá-la no projeto do Google Cloud ou na organização da Apigee, entre em contato com o suporte da Apigee. No entanto, se você quiser comprar o direito de acesso à Application Integration, entre em contato com a equipe de vendas da Apigee. Depois de ativar a Application Integration, execute as seguintes tarefas:
1. Ative as APIs a seguir:
  - API Apigee (apigee.googleapis.com)
  - API Application Integration (integrations.googleapis.com)
  - API Secret Manager (secretmanager.googleapis.com)
  - Connectors API (connectors.googleapis.com)
  Para informações sobre como ativar as APIs, consulte Como ativar serviços.
2. Ative os complementos de integração e conectores para a organização da Apigee.
  - Se você estiver criando 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 você estiver usando 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 complementos estão ativados usando o seguinte comando:
```
curl -H "Authorization: Bearer $TOKEN"  -H "content-type:application/json" "https://apigee.googleapis.com/v1/organizations/${ORG_ID}"
```
  Ao executar o comando, é exibida uma mensagem semelhante a esta:
```
{
  "name": "Test....",
  "createdAt": "1615483867669",
  "lastModifiedAt": "1615483873468",
  …...
  "addonsConfig": {
    "integrationConfig": {
      "enabled": true,
    "connectorsPlatformConfig": {
      "enabled": true
    }
  }
  }
```
  Observação:
  - Quando você executa um comando de complemento, todos os complementos atuais são substituídos. Portanto, se você tiver complementos, inclua-os no comando de complementos.
  - Desativar um complemento exclui todas as configurações do recurso (recurso). Por exemplo, se você desativar o complemento, todas as integrações serão excluídas.
4. Atribua os papéis do IAM a seguir à conta de serviço padrão (service-PROJECT_NUMBER@gcp-sa-apigee.iam.gserviceaccount.com):
  - Invocador do Application Integration (roles/integrations.applicationIntegrationInvokerRole)
  Para informações sobre como conceder papéis ou permissões adicionais a uma conta de serviço, consulte Como conceder, alterar e revogar acesso.

Criar um proxy de destino da Application Integration

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

Acesse a IU da Apigee e faça login.
Selecione a organização usando o menu suspenso no canto superior esquerdo da IU.
Clique em API Proxies na visualização principal.
Como alternativa, selecione Develop > API Proxies no menu de navegação à esquerda.
Na lista suspensa Ambiente, selecione o ambiente em que você quer criar um novo proxy de API.
Clique em Criar nova.
Clique em destino de integração na exibição dos tipos de proxy.
O assistente de criação de proxy será iniciado.
Na página de configuração Detalhes do proxy, forneça os seguintes detalhes:
- Nome: digite um nome para o proxy.
  Nomes de proxy podem conter caracteres alfanuméricos, traços e sublinhados.
- Caminho de base: é preenchido automaticamente com base no nome do proxy.
  O Caminho base faz parte do URL usado para fazer solicitações à API. O Edge usa o URL para corresponder e rotear solicitações de entrada para o proxy da API apropriado.
- Descrição (opcional): digite 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 suspensa.
- Destino da integração: selecione o nome do destino da integração na lista suspensa. A lista de destinos da integração é preenchida com base na região de integração selecionada.
- Gatilho: selecione o gatilho de API associado à integração na lista suspensa.
- Tipo de endpoint: selecione Sincronizar.
Clique em Próxima.
Na página de configuração Políticas comuns, mantenha as seleções padrão e clique em Avançar.
Na página Resumo, clique em Criar.
Um proxy de destino de integração foi criado.

Implante o proxy

Siga estas etapas para implantar o proxy recém-criado:

Na IU da Apigee, selecione Desenvolver > Proxies de API.
A IU exibe uma lista de proxies de API e os status de implantação deles:
Na lista suspensa Ambiente, selecione o ambiente em que você quer implantar o proxy da API.
Clique no proxy recém-criado que você quer implantar. A IU exibe a página Visão geral por padrão.
Para implantar as alterações, primeiro clique em Implantar para exibir a caixa de diálogo Implantar.
Digite o seguinte:
- Revisão: o número de revisão do proxy que você quer implantar.
- Ambiente: o ambiente em que você quer implantar o proxy.
- Conta de serviço: a conta de serviço criada para o proxy.
Clique em Implantar.

A IU inicia o processo de implantação da revisão selecionada. A implantação do proxy pode levar até um minuto para ser concluída.

Quando o proxy é implantado, a coluna Status na seção Implantações mostra um ícone verde para mostrar que a revisão 1 do proxy está implantada.

Observação: não há um elemento Authentication explícito na definição de política Definir solicitação da integração do proxy. A Apigee adiciona um token de autenticação à solicitação automaticamente.

Para que a política Definir solicitação da integração seja autenticada, implante o destino de integração com uma conta de serviço que tenha os papéis do IAM necessários para executar uma integração. Para mais detalhes sobre como implantar um proxy de API, consulte Implantar na Apigee.

Testar 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 o YOUR_ENV_GROUP_HOSTNAME é o nome do host de um grupo de ambientes que contém o ambiente em que o proxy foi implantado.

Exemplo:

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

Para confirmar se a integração foi acionada invocando o proxy:

Abra a IU da Apigee.
Clique em Desenvolver > Integrações.
Pesquise ou selecione o nome da integração criada nas etapas acima e clique no nome da integração.
Clique em Registros.
Verifique se há um registro de execução para a integração acionada. Para ver os detalhes do registro, clique na linha para expandir os detalhes da execução.

Atualizar o payload da solicitação de proxy (opcional)

Siga estas etapas para atualizar o payload da solicitação do proxy:

Na IU da Apigee, selecione Develop > API Proxies no menu de navegação à esquerda.
Clique no proxy criado recentemente.
Por padrão, a IU exibe a guia Visão geral desse proxy no editor de proxy.
Clique na guia Desenvolver.
No painel Navigator, selecione Set Integration Request no cabeçalho Policies.
Remova a marca de comentário do bloco <Parameters> e insira os detalhes do parâmetro.
Para especificar parâmetros individuais, use o elemento <Parameter>. Para especificar matrizes de parâmetro, use o elemento <ParameterArray>.

Observação: para simplificar, o bloco Parameters é deixado como comentário neste tutorial. A Application Integration é compatível com vários parâmetros que podem ser transmitidos como parte da política Set Integration Request. Para mais informações e exemplos, consulte a política SetintegrationRequest.
Clique em Salvar.

A seguir

Explore o layout do designer de integração e entenda os vários conceitos descritos em Todos os conceitos.