Criar um gateway de API

  • 5 minutos

Geralmente, as organizações precisam oferecer aos parceiros acesso a dados. Esse acesso precisa ser controlado e gerenciado.

No exemplo da empresa de calçados, varejistas que fornecem estoque para a NorthWind Shoes precisam saber quanto estoque eles podem pedir. Os clientes também gostam de saber exatamente quando vão receber seu pedido.

Aqui, você saberá como funciona o Gerenciamento de API do Azure e como configurar um gateway de API.

Gerenciamento de API do Azure

O serviço de Gerenciamento de API do Azure está hospedado na nuvem do Azure e fica posicionado entre as suas APIs e a Internet. Sua instância de Gerenciamento de API atua como um gateway de API do Azure.

Quando publica suas APIs, você usa o portal do Azure para controlar como determinadas APIs são expostas aos consumidores. Talvez você queira que algumas APIs sejam disponibilizadas gratuitamente para os desenvolvedores, para fins de demonstração, e que o acesso a outras APIs seja controlado rigorosamente.

Por que usar o Gerenciamento de API?

Para os desenvolvedores, o Gerenciamento de API fornece uma variedade de benefícios.

  • Documentação da API. A documentação das APIs permite que clientes que efetuam chamadas integrem rapidamente suas soluções. O Gerenciamento de API permite expor rapidamente a estrutura da API aos clientes que fazem chamadas por meio de padrões modernos, como OpenAPI. Você pode ter mais de uma versão de uma API. Com várias versões, você pode preparar as atualizações de aplicativos, pois os aplicativos de consumo não precisam usar a nova versão imediatamente.
  • Acesso com limitação de fluxo. Se a sua API tiver o potencial de acessar um grande volume de dados, será uma boa ideia limitar a taxa em que os clientes podem solicitar dados. A limitação de fluxo ajuda a manter tempos de resposta ideais para todos os clientes. O Gerenciamento de API permite definir limites de taxa como um todo ou para clientes individuais específicos.
  • Monitoramento da integridade. Os clientes remotos consomem suas APIs, portanto, pode ser difícil identificar possíveis problemas ou erros. O Gerenciamento de API permite exibir respostas de erro e arquivos de log, bem como filtrar por tipos de respostas.
  • Formatos modernos, como JSON. As APIs já usaram vários formatos de troca de dados diferentes ao longo dos anos, de XML a CSV, entre muitos outros. O Gerenciamento de API permite que você exponha esses formatos usando modelos de dados modernos, como JSON.
  • Conexões com qualquer API. Em muitas empresas, as APIs ficam localizadas em diferentes países/regiões e usam formatos diferentes. O Gerenciamento de API permite adicionar todas essas APIs diferentes em uma única interface moderna.
  • Análise. Conforme você desenvolve suas APIs, é útil ver a frequência com que suas APIs estão sendo chamadas e por quais tipos de sistemas. O Gerenciamento de API permite visualizar esses dados no portal do Azure.
  • Segurança. A segurança é fundamental ao lidar com os dados do sistema. Violações não autorizadas podem custar dinheiro, tempo perdido com retrabalho do código e perda de reputação para as empresas. As ferramentas de segurança que você pode usar com o gerenciamento de API do Azure incluem a autorização de usuário OAuth 2.0 e a integração com o Microsoft Entra ID.
  • Tipos de preço. O Gerenciamento de API oferece camadas com diferentes recursos para taxa de transferência de solicitação, SLA (Contrato de Nível de Serviço), isolamento de rede, flexibilidade de atualização e assim por diante. Ao criar um gateway de gerenciamento de API do Azure, você escolhe a camada que atende às suas necessidades.

Configuração do gerenciamento de API

Para configurar o gerenciamento de API:

  1. Crie um gateway de Gerenciamento de API. O nome usado para o gateway precisa ser globalmente exclusivo dentro do namespace .azure-api.net.
  2. Registre uma API Web existente no gateway. Registrar a API a disponibiliza para os consumidores no ponto de extremidade <gateway>.azure-api.net.
  3. Chame a API existente por meio do gateway. Os consumidores agora podem chamar a API na URL do ponto de extremidade.