Skip to main content

Gateways

Visão Geral​

O API Gateway é o componente responsável por expor as APIs com segurança, performance e escalabilidade. Ele é o intermediário que realiza o roteamento de todas as requisições para os sistemas internos, oferecendo funcionalidades relacionadas ao acesso e consumo da sua API, como autenticação, autorização, validação e transformação das requisições, controle de tráfego, cache, entre outros. No DHuO, o API Gateway pode ser utilizado também para expor os serviços de integração desenvolvidos no módulo iPaaS.

O DHuO adota o conceito de Federated API Management, fornecendo a capacidade de gerenciamento multi-gateway, oferecendo suporte a outros fornecedores de API Gateways. Para saber mais, acesse a seção Gestão multi-gateway do API Gateway. O DHuO oferece suporte para os seguintes tipos de API Gateways:

  • DHuO Gateway
  • Kong
  • APISIX

O DHuO Gateway utiliza a arquitetura extensível da versão open source do Kong Gateway, oferecendo funcionalidades de nível enterprise e suporte profissional, atendendo às necessidades específicas e personalizadas dos clientes.

O cadastro de gateways no DHuO compreende informações para que ele consiga se conectar aos gateways para configuração de APIs e demais entidades relacionadas como certificados, consumidores de APIs e credenciais, entre outros.

Informação adicional

O cadastro de gateways no DHuO não realiza o provisionamento de infraestrutura. Os API Gateways devem estar previamente instalados e serem administrados pela equipe de infraestrutura responsável (a depender do modelo de contratação da plataforma DHuO).

Configuração​

Os API Gateways são gerenciados no contexto da Organização. A partir da home, acesse o ícone de configurações da Organização ⚙ menu > Gateways. Na página de gateways, eles podem ser cadastrados, editados e excluídos.

Permissões​

Apenas usuários com papel de administrador da organização (Org Admin) podem gerenciar gateways. Para saber mais, acesse a seção Papéis e permissões.

Parâmetros​

Aqui estão os parâmetros gerais para a configuração de um gateway:

  • Nome: Obrigatório. Nome do gateway.
Informação adicional

Os gateways são únicos por Organização. Não é possível ter mais de um gateway com o mesmo nome.

  • Ambiente: Obrigatório. Ambiente no qual pertence o API Gateway.
  • Tipo do Gateway: Obrigatório. Tipo do API Gateway a ser cadastrado. Opções: DHuO Gateway, Kong, APISIX.
Atenção!

Não é possível alterar o ambiente e tipo do gateway após a criação do gateway. Caso seja necessário alterá-los, é preciso excluir o gateway e criar um novo no ambiente e tipo desejados.

Parâmetros DHuO Gateway e Kong​

  • URL de acesso: Obrigatório. URL utilizada pelos consumidores de API para acesso às APIs disponibilizadas no gateway.
  • URL de deploy: Obrigatório. URL base de acesso à Admin API para gerenciamento do gateway pelo DHuO. A Admin API é uma API REST que permite o DHuO criar e gerenciar os recursos desenvolvidos na plataforma no gateway. Em instalações padrão a Admin API é disponibilizada na porta 8001 (ou 8443 para https).
  • Key: Token de acesso utilizado no header apikey para proteger a Admin API. Como a Admin API permite controle total do gateway, é importante proteger essa API contra acesso indesejado, principalmente em arquiteturas onde o DHuO estiver em redes diferentes dos gateways. Além de restrições de acesso ao nível de rede, uma das estratégias possíveis é utilizar o próprio gateway como um proxy para a sua Admin API. A partir dessa técnica é possível configurar mecanismos de autenticação para controlar o acesso. Neste cenário, o DHuO a autenticação para acesso à Admin API por meio de autenticação Key Authentication. Para saber mais, acesse a seção API Gateway da Plataforma.

Parâmetros APISIX​

  • URL de acesso: Obrigatório. URL utilizada pelos consumidores de API para acesso às APIs disponibilizadas no gateway.
  • URL de deploy: Obrigatório. URL base de acesso à Admin API para gerenciamento do gateway pelo DHuO. A Admin API é uma API REST que permite o DHuO criar e gerenciar os recursos desenvolvidos na plataforma no gateway. Em instalações padrão a Admin API é disponibilizada na porta 9180 (ou 9443 para https). Não é necessário informar o path /apisix/admin no cadastro. O DHuO infere automaticamente o path da Admin API.
  • Key: Obrigatório. Token de acesso utilizado no header X-API-KEY para acesso à Admin API. Refere-se à propriedade apisix.admin_key.key configurada no arquivo conf/config.yaml da instalação do APISIX.
Atenção!

Não é possível excluir um gateway caso ele esteja em uso. Exemplos:

  • APIs implantadas
  • Certificados ou certificados de CA implantados
  • Consumidores de API criados
  • O gateway esteja relacionado em um ambiente de portal

É necessário remover todas as entidades relacionadas para excluir um gateway.

Cuidado!

A exclusão do cadastro de um gateway na interface do Manager não implica a remoção da infraestrutura correspondente. A completa remoção do gateway deve ser realizada pela equipe de infraestrutura responsável (a depender do modelo de contratação da plataforma DHuO).

Da mesma forma, caso o gateway seja removido da infraestrutura ou tenha seus dados de acesso modificados, o DHuO não conseguirá se comunicar com ele até que o ambiente seja reestabelecido ou as configurações sejam atualizadas no cadastro.