Pré-visualização

Este produto ou funcionalidade está sujeito aos "Termos das Ofertas de Pré-DG" na secção Termos Gerais do Serviço dos Termos Específicos do Serviço. Os produtos e as funcionalidades pré-GA estão disponíveis "tal como estão" e podem ter apoio técnico limitado. Para mais informações, consulte as descrições das fases de lançamento.

Hub de APIs Apigee

O conetor do hub de APIs da Apigee permite-lhe gerir, descobrir e controlar APIs na carteira da sua organização.

Versões suportadas

Este conetor suporta a versão v1 do hub de APIs do Apigee.

Antes de começar

• No seu projeto do Google Cloud, faça as seguintes tarefas:

  • Certifique-se de que a conetividade de rede está configurada. Para obter informações sobre padrões de rede, consulte o artigo Conetividade de rede.
  • Conceda a função IAM roles/connectors.admin ao utilizador que está a configurar o conetor.
  • Ative os seguintes serviços:
    • secretmanager.googleapis.com (API Secret Manager)
    • connectors.googleapis.com (API Connectors)

    Para saber como ativar serviços, consulte o artigo Ativar serviços. Se estes serviços ou autorizações não tiverem sido ativados anteriormente para o seu projeto, é-lhe pedido que os ative quando configurar o conector.

• Se estiver a usar a autenticação da conta de serviço em vez da autenticação OAuth 2.0, certifique-se de que são concedidas as autorizações adequadas à conta de serviço. Para mais informações, consulte o artigo Funções de IAM predefinidas.

Crie uma ligação ao hub de APIs do Apigee

Uma associação é específica de uma origem de dados. Isto significa que, se tiver muitas origens de dados, tem de criar uma associação separada para cada origem de dados. Para criar uma associação, faça o seguinte:

1. Na Cloud Console, aceda à página Integration Connectors > Ligações e, de seguida, selecione ou crie um projeto do Google Cloud.

   Aceda à página Ligações

2. Clique em + Criar novo para abrir a página Criar associação.
3. Na secção Localização, selecione uma localização na lista Região e, de seguida, clique em Seguinte.

   Para ver a lista de todas as regiões suportadas, consulte o artigo Localizações.

4. Na secção Detalhes da associação, faça o seguinte:
   1. Selecione o Apigee API hub na lista Conetor.
   2. Selecione uma versão do conetor na lista Versão do conetor.
   3. No campo Nome da associação, introduza um nome para a instância da associação. O nome da associação pode conter letras minúsculas, números ou hífenes. O nome tem de começar com uma letra e terminar com uma letra ou um número, e não pode exceder 49 carateres.
   4. Opcionalmente, introduza uma Descrição para a instância de associação.
   5. Opcionalmente, ative o Registo na nuvem e, em seguida, selecione um nível de registo. Por predefinição, o nível do registo está definido como Error.
   6. Conta de serviço: selecione uma conta de serviço que tenha as funções necessárias.
   7. (Opcional) Configure as definições do nó de associação.
   • Número mínimo de nós: introduza o número mínimo de nós de ligação.
   • Número máximo de nós: introduza o número máximo de nós de ligação.

   Um nó é uma unidade (ou uma réplica) de uma ligação que processa transações. São necessários mais nós para processar mais transações para uma ligação e, inversamente, são necessários menos nós para processar menos transações. Para compreender como os nós afetam os preços dos conetores, consulte o artigo Preços dos nós de ligação. Se não introduzir valores, por predefinição, os nós mínimos são definidos como 2 (para uma melhor disponibilidade) e os nós máximos são definidos como 50.

   Nota: só pode personalizar os valores do nó de associação se for um cliente de pagamento por utilização.
   8. Clicar em Seguinte.
5. Na secção Destinos, introduza os detalhes do anfitrião remoto (sistema de back-end) ao qual quer estabelecer ligação.
   1. No campo Tipo de destino, selecione um destino.
   2. No campo Endereço do anfitrião, especifique o nome do anfitrião ou o endereço IP do destino.

   3. Opcionalmente, para introduzir destinos adicionais, clique em +ADICIONAR DESTINO.

   4. Clicar em Seguinte.
6. Na secção Autenticação, introduza os detalhes de autenticação.
   1. Selecione um Tipo de autenticação e introduza os detalhes relevantes.

      Os seguintes tipos de autenticação são suportados pela ligação do hub de APIs do Apigee:

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

   Para saber como configurar estes tipos de autenticação, consulte o artigo Configurar autenticação.

   2. Clicar em Seguinte.
7. Reveja os detalhes da ligação e da autenticação e, de seguida, clique em Criar.

Configure a autenticação

Introduza os detalhes com base na autenticação que quer usar.

• OAuth 2.0 – Código de autorização: selecione esta opção para autenticar através de um fluxo de início de sessão do utilizador baseado na Web. Especifique os seguintes detalhes:
• ID de cliente: o ID de cliente necessário para estabelecer ligação ao serviço de hub da API Apigee de back-end.
• Âmbitos: uma lista separada por vírgulas dos âmbitos pretendidos. Para ver todos os âmbitos do OAuth 2.0 suportados para o serviço Google necessário, consulte a secção relevante na página Âmbitos do OAuth 2.0 para APIs Google.
• Segredo do cliente: selecione o segredo do Secret Manager. Tem de ter criado o Secret do Secret Manager antes de configurar esta autorização.
• Versão do Secret: versão do Secret do Secret Manager para o segredo do cliente.

Para o tipo de autenticação Authorization code, depois de criar a associação, tem de autorizar a associação.

• Autenticação da conta de serviço: selecione esta opção para fazer a autenticação através da conta de serviço que indicou nos passos anteriores ao configurar esta associação. Certifique-se de que forneceu à conta de serviço as funções e as autorizações de IAM relevantes necessárias para a autenticação.
  • Âmbitos: selecione os âmbitos do OAuth 2.0 necessários no menu pendente. Para mais informações, consulte o artigo Âmbitos de acesso.

Autorize a associação

Se usar o código de autorização do OAuth 2.0 para autenticar a associação, conclua as seguintes tarefas depois de criar a associação.

1. Na página Ligações, encontre a ligação criada recentemente.

   Tenha em atenção que o Estado do novo conetor é Autorização necessária.

2. Clique em Autorização obrigatória.

   É apresentado o painel Editar autorização.

3. Copie o valor do URI de redirecionamento para a sua aplicação externa.
4. Valide os detalhes da autorização.
5. Clique em Autorizar.

   Se a autorização for bem-sucedida, o estado da associação é definido como Ativo na página Associações.

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

Se estiver a usar o tipo de autenticação Authorization code e tiver feito alterações de configuração no hub de APIs do Apigee, tem de voltar a autorizar a ligação ao hub de APIs do Apigee. Para autorizar novamente uma associação, siga estes passos:

1. Clique na associação pretendida na página Associações.

   É apresentada a página de detalhes da associação.

2. Clique em Editar para editar os detalhes da associação.
3. Valide os detalhes de OAuth 2.0 – Código de autorização na secção Autenticação.

   Se necessário, faça as alterações necessárias.

4. Clique em Guardar. Esta ação direciona para a página de detalhes da associação.
5. Clique em Editar autorização na secção Autenticação. É apresentado o painel Autorizar.
6. Clique em Autorizar.

   Se a autorização for bem-sucedida, o estado da associação é definido como Ativo na página Associações.

Limitações do sistema

O conector do hub de APIs Apigee pode processar um máximo de 20 transações por segundo, por nó e limita todas as transações que excedam este limite. Por predefinição, os Integration Connectors atribuem 2 nós (para uma melhor disponibilidade) a uma ligação.

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

Nota: o número de nós de conectores de integração é dimensionado automaticamente de forma dinâmica com base na sua utilização. No entanto, se quiser reservar capacidade para grandes volumes sem esperar pela escalabilidade automática, pode ajustar o valor mínimo de nós para uma ligação. São necessários mais nós para processar mais transações para uma associação. Por outro lado, são necessários menos nós se uma associação processar menos transações. Para configurar os valores dos nós, faça o seguinte:

• Se for cliente de pagamento conforme o uso, configure o valor mínimo e máximo do nó na página de edição da associação.
• Se for cliente com base numa subscrição, contacte o apoio técnico.

O número máximo de transações que um nó pode processar depende de vários fatores. Assim, antes de ajustar os nós mínimos para um melhor débito, é recomendável verificar se os seus sistemas de back-end estão configurados de forma ideal para processar o tráfego necessário.

Use a ligação do hub de APIs da Apigee numa integração

Depois de criar a associação, esta fica disponível na integração de aplicações. Pode usar a ligação numa integração através da tarefa Conectores.

Ações

Este conector fornece uma camada de abstração para os objetos do serviço de back-end associado. Só pode aceder aos objetos do back-end através desta abstração. A abstração é exposta para si como ações. Uma Action é uma função de primeira classe disponibilizada à integração através da interface do conector. Uma ação permite-lhe fazer alterações a uma ou mais entidades e varia de conetor para conetor. No entanto, é possível que um conector não suporte nenhuma ação, caso em que a lista Actions está vazia.

Problemas conhecidos

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

Obtenha ajuda da comunidade do Google Cloud

Pode publicar as suas perguntas e discutir este conector na comunidade do Google Cloud nos Fóruns do Cloud.

O que se segue?

• Compreenda como suspender e retomar uma associação.
• Compreenda como monitorizar a utilização do conector.
• Compreenda como ver os registos do conector.