Visualização — Conector do hub de APIs da Apigee

Este recurso está sujeito aos Termos das Soluções Pré-GA na seção Termos Gerais de Serviço dos Termos Específicos de Serviço. Os recursos pré-GA estão disponíveis "no estado em que se encontram" e podem ter suporte limitado. Para mais informações, consulte as descrições da fase de lançamento.

Hub de APIs da Apigee

O conector do hub de APIs da Apigee permite gerenciar, descobrir e controlar APIs no portfólio da sua organização.

Versões compatíveis

Esse conector é compatível com a versão v1 do hub de APIs da Apigee.

Antes de começar

• No seu projeto do Google Cloud, faça o seguinte:

  • Verifique se a conectividade de rede está configurada. Para mais informações sobre padrões de rede, consulte Conectividade de rede.
  • Conceda o papel do IAM roles/connectors.admin ao usuário que está configurando o conector.
  • Ative os seguintes serviços:
    • secretmanager.googleapis.com (API Secret Manager)
    • connectors.googleapis.com (API Connectors)

    Para entender como ativar os serviços, consulte Como ativar serviços. Se esses serviços ou permissões não tiverem sido ativados no seu projeto, você precisará ativá-los ao configurar o conector.

• Se você estiver usando a autenticação da conta de serviço em vez da autenticação OAuth 2.0, verifique se as permissões adequadas foram concedidas à conta de serviço. Para mais informações, consulte Papéis predefinidos do IAM.

Criar uma conexão do hub de APIs da Apigee

Uma conexão é específica a uma fonte de dados. Isso significa que, se você tiver muitas fontes de dados, precisará criar uma conexão separada para cada uma. Para criar uma conexão, faça o seguinte:

1. No console do Cloud, acesse a página Integration Connectors > Conexões e selecione ou crie um projeto do Google Cloud.

   Acessar a página "Conexões"

2. Clique em + Criar novo para abrir a página Criar conexão.
3. Na seção Local, selecione um local na lista Região e clique em Próxima.

   Para conferir a lista de todas as regiões com suporte, consulte Locais.

4. Na seção Detalhes da conexão, faça o seguinte:
   1. Selecione o hub de APIs da Apigee na lista Conector.
   2. Selecione uma versão do conector na lista Versão do conector.
   3. No campo Nome da conexão, insira um nome para a instância de conexão. O nome da conexão pode conter letras minúsculas, números ou hífens. O nome precisa começar e terminar com uma letra ou um número e não pode exceder 49 caracteres.
   4. Como opção, insira uma Descrição para a instância de conexão.
   5. Como opção, ative o Cloud Logging, e selecione um nível de registro. Por padrão, o nível de registro é definido como Error.
   6. Conta de serviço: selecione uma conta de serviço que tenha os papéis necessários.
   7. Opcional: configure as Configurações do nó de conexão.
   • Número mínimo de nós: digite o número mínimo de nós de conexão.
   • Número máximo de nós: digite o número máximo de nós de conexão.

   Um nó é uma unidade (ou réplica) de uma conexão que processa transações. Mais nós são necessários para processar mais transações para uma conexão e, por outro lado, menos nós são necessários para processar menos transações. Para entender como os nós afetam os preços do conector, consulte Preços dos nós de conexão. Se você não inserir qualquer valor, por padrão os nós mínimos serão definidos como 2 (para melhor disponibilidade) e os nós máximos serão definidos como 50.

   Observação: você só poderá personalizar os valores do nó de conexão se for um cliente de pagamento por uso.
   8. Clique em Próxima.
5. Na seção Destinos, insira os detalhes do host remoto (sistema de back-end) ao qual você quer se conectar.
   1. No campo Tipo de destino, selecione um destino.
   2. No campo Endereço do host, especifique o nome do host ou o endereço IP do destino.

   3. Opcional: para inserir outros destinos, clique em \+ADICIONAR DESTINO.

   4. Clique em Próxima.
6. Na seção Autenticação, insira os detalhes da autenticação.
   1. Selecione um Tipo de autenticação e insira os detalhes relevantes.

      Os seguintes tipos de autenticação são compatíveis com a conexão do hub de APIs da Apigee:

      • Código de autorização OAuth 2.0
      • Autenticação da conta de serviço

   Para entender como configurar esses tipos de autenticação, consulte Configurar autenticação.

   2. Clique em Próxima.
7. Analise os detalhes da conexão e da autenticação e clique em Criar.

Configurar a autenticação

Digite os detalhes com base na autenticação que você quer usar.

• OAuth 2.0 - Código de autorização: selecione essa opção para autenticar usando um fluxo de login do usuário baseado na Web. Especifique os seguintes detalhes:
• ID do cliente : o ID do cliente necessário para se conectar ao serviço de back-end do hub de APIs da Apigee.
• Escopos: uma lista de escopos desejados separados por vírgulas. Para conferir todos os escopos do OAuth 2.0 com suporte para o serviço do Google necessário, consulte a seção relevante na página Escopos do OAuth 2.0 para APIs do Google.
• Chave secreta do cliente : selecione o Secret do Secret Manager. É necessário ter criado o Secret do Secret Manager antes de configurar essa autorização.
• Versão do secret : a versão da chave secreta do cliente no Secret Manager.

Para o tipo de autenticação Authorization code, depois de criar a conexão, é necessário autorizá-la.

• Autenticação da conta de serviço: selecione essa opção para autenticar usando a conta de serviço fornecida nas etapas anteriores ao configurar essa conexão. Verifique se você forneceu à conta de serviço os papéis e permissões relevantes do IAM necessários para a autenticação.
  • Escopos: selecione os escopos necessários do OAuth 2.0 no menu suspenso. Para mais informações, consulte Escopos de acesso.

Autorizar a conexão

Se você usar o código de autorização do OAuth 2.0 para autenticar a conexão, conclua as tarefas a seguir depois de criar a conexão.

1. Na página "Conexões", localize a conexão recém-criada.

   O status do novo conector será Autorização necessária.

2. Clique em Autorização necessária.

   Isso mostra o painel Editar autorização.

3. Copie o valor do URI de redirecionamento para seu aplicativo externo.
4. Verifique os detalhes da autorização.
5. Clique em Autorizar.

   Se a autorização for bem-sucedida, o status da conexão será definido como Ativo na página "Conexões".

Reautorização para código de autorização

Se você estiver usando o tipo de autenticação Authorization code e tiver feito alterações de configuração no hub de APIs da Apigee, será necessário autorizar novamente a conexão do hub de APIs da Apigee. Para reautorizar uma conexão, siga estas etapas:

1. Clique na conexão necessária na página "Conexões".

   A página de detalhes da conexão será aberta.

2. Clique em Editar para editar os detalhes da conexão.
3. Verifique os detalhes do código de autorização do OAuth 2.0 na seção Autenticação.

   Se necessário, faça as mudanças necessárias.

4. Clique em Salvar. Isso vai levar você à página de detalhes da conexão.
5. Clique em Editar autorização na seção Autenticação. Isso mostra o painel Autorizar.
6. Clique em Autorizar.

   Se a autorização for bem-sucedida, o status da conexão será definido como Ativo na página "Conexões".

Limitações do sistema

O conector do hub de APIs da Apigee pode processar no máximo 20 transações por segundo, por nó, e limita todas as transações além desse limite. Por padrão, os Integration Connectors alocam dois nós (para melhor disponibilidade) para uma conexão.

Para informações sobre os limites aplicáveis aos Integration Connectors, consulte Limites.

Observação: o número de nós dos Integration Connectors será escalonado automaticamente de forma dinâmica com base no seu uso. No entanto, se você quiser reservar capacidade para grandes volumes sem esperar pelo escalonamento automático, ajuste o valor mínimo do nó para uma conexão. Mais nós são necessários para processar mais transações para uma conexão. Por outro lado, menos nós são necessários se uma conexão processar menos transações. Para configurar os valores do nó, faça o seguinte:

• Se você for um cliente de pagamento por uso, configure o valor mínimo e máximo do nó na página de edição da conexão.
• Se você for um cliente com base em assinatura, entre em contato com o suporte.

O número máximo de transações que um nó pode processar depende de vários fatores. Portanto, antes de ajustar os nós mínimos para melhorar a capacidade de processamento, recomendamos que você verifique se os sistemas de back-end estão configurados de maneira ideal para processar o tráfego necessário.

Usar a conexão do hub de APIs da Apigee em uma integração

Depois de criar a conexão, ela fica disponível em Application Integration. É possível usar a conexão em uma integração pela tarefa Connectors.

Ações

Esse conector fornece uma camada de abstração para os objetos do serviço de back-end conectado. Só é possível acessar os objetos do back-end por essa abstração. A abstração é exposta a você como ações. Um Action é uma função de primeira classe disponibilizada para a integração por meio da interface do conector. Uma ação permite fazer alterações em uma ou mais entidades e varia de um conector para outro. No entanto, é possível que o conector não ofereça suporte a nenhuma ação, nesse caso a lista Actions estará vazia.

Problemas conhecidos

O conector do hub de APIs da Apigee tem limites de configuração. Os recursos pesquisáveis são limitados a 2,5 MB, e os arquivos de especificação da API têm um limite de 10 MB. Para mais informações, consulte Limites no hub de APIs da Apigee.

Receber ajuda da comunidade do Google Cloud

Poste suas dúvidas e converse sobre esse conector na comunidade do Google Cloud em Fóruns do Cloud.

A seguir

• Entenda como suspender e retomar uma conexão.
• Entenda como monitorar o uso do conector.
• Entenda como visualizar registros de conectores.