Criar um gateway de API
Muitas vezes, as organizações necessitam de permitir que os parceiros acedam a dados. Esse acesso tem de ser controlado e gerido.
No exemplo da empresa de calçado, os revendedores que comercializam calçado NorthWind Shoes necessitam de saber a quantidade de stock que podem encomendar. Os clientes também gostam de saber exatamente quando vão receber o pedido.
Aqui, você aprenderá como o Gerenciamento de API do Azure funciona e como configurar um gateway de API.
Gestão de API do Azure
O serviço de gerenciamento de API do Azure é hospedado na nuvem do Azure e está posicionado entre suas APIs e a Internet. Sua instância de Gerenciamento de API atua como um gateway de API do Azure.
Ao publicar as suas APIs, irá utilizar o portal do Azure para controlar a forma como determinadas APIs são expostas aos consumidores. Pode querer que algumas APIs sejam disponibilizadas livremente aos programadores para fins de demonstração e que o acesso a outras APIs seja controlado rigorosamente.
Porquê utilizar a Gestão de API?
Para os programadores, a Gestão de API proporciona uma variedade de benefícios.
- Documentação de APIs. A documentação de APIs permite que os clientes que efetuam a chamada integrem rapidamente as suas soluções. O Gerenciamento de API permite que você exponha rapidamente a estrutura de sua API para chamar clientes por meio de padrões modernos, como OpenAPI. Pode ter mais do que uma versão de uma API. Com múltiplas versões, pode testar atualizações de aplicações, uma vez que as suas aplicações de consumo não têm de utilizar imediatamente a nova versão.
- Acesso de limitação de frequência. Se a sua API puder aceder a uma grande quantidade de dados, recomenda-se que limite a frequência com que os clientes podem pedir dados. A limitação de frequência 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.
- Monitorização do estado de funcionamento. Os clientes remotos consomem suas APIs, por isso pode ser difícil identificar possíveis problemas ou erros. A Gestão de API permite-lhe ver respostas a erros e ficheiros de registo, e filtrar por tipos de respostas.
- Formatos modernos, como o JSON. Ao longo dos anos, as APIs utilizaram muitos formatos de troca de dados diferentes, como o XML e o CSV, entre outros. A Gestão de API permite-lhe expor esses formatos através de modelos de dados modernos, como o JSON.
- Ligações a qualquer API. Em muitas empresas, as APIs estão 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. Ao desenvolver as suas APIs, é útil ver a frequência com que as mesmas estão a ser chamadas e por que tipos de sistemas. A Gestão de API permite-lhe visualizar esses dados no portal do Azure.
- Segurança. A segurança é fundamental ao lidar com dados de sistema. As falhas de segurança não autorizadas podem implicar custos monetários, perdas de tempo na reformulação de código e danos reputacionais para as empresas. As ferramentas de segurança que você pode usar com o gerenciamento de API do Azure incluem autorização de usuário OAuth 2.0 e integração com o Microsoft Entra ID.
- Níveis de preços. O Gerenciamento de API oferece camadas com diferentes recursos para taxa de transferência de solicitações, SLA, 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 da gestão de API
Para configurar a gestão de API, faça o seguinte:
- Criar um gateway de Gestão de API. O nome que utilizar para o gateway tem de ser globalmente exclusivo no espaço de nomes .azure-api.net.
- Registre uma API da Web existente no gateway. Registar a API disponibiliza a API aos consumidores no ponto final <gateway>.azure-api.net.
- Chame a API existente através do gateway. Os consumidores agora podem chamar a API na URL do ponto final.