Descobrir o serviço de Gerenciamento de API

3 minutos

O Gerenciamento de API fornece a funcionalidade principal para garantir um programa de API bem-sucedido por meio do envolvimento do desenvolvedor, insights de negócios, análise, segurança e proteção. Cada API consiste em uma ou mais operações e cada uma pode ser adicionada a um ou mais produtos. Para usar uma API, os desenvolvedores assinam um produto que contém essa API e, em seguida, eles podem chamar a operação da API, sujeito às políticas de uso que possam estar em vigor.

Componentes do Gerenciamento de API

O Gerenciamento de API do Azure é composto por um gateway de API, um plano de gerenciamento e um portal do desenvolvedor. Esses componentes são hospedados no Azure e totalmente gerenciados por padrão. O Gerenciamento de API está disponível em várias camadas diferentes na capacidade e nos recursos.

O gateway de API é o ponto de extremidade que:
- Aceita chamadas à API e as direciona para o back-end apropriado
- Verifica chaves de API e outras credenciais apresentadas com solicitações
- Impõe o uso de cotas e limites de taxa
- Transforma solicitações e respostas especificadas em instruções de política
- Armazena em cache as respostas para melhorar a latência de resposta e minimizar a carga nos serviços de back-end
- Emite logs, métricas e rastreamentos para monitoramento, relatórios e solução de problemas
O plano de gerenciamento é a interface administrativa na qual você configura seu programa de API. Use-o para:
- Provisionar e definir o Gerenciamento de API de configurações de serviço
- Definir ou importar esquemas de API
- Empacotar APIs em produtos
- Políticas de configuração como cotas ou transformações em APIs
- Obter insights por meio de análises
- Gerenciar usuários
O portal do desenvolvedor é um site gerado automaticamente e totalmente personalizável com a documentação das suas APIs. Ao usar o portal do desenvolvedor, os desenvolvedores podem:
- Ler a documentação da API
- Experimentar uma API por meio do console interativo
- Criar uma conta e fazer uma assinatura para obter chaves de API
- Acessar a análise do seu próprio uso.
- Baixar definições de API
- Gerenciar chaves de API

Produtos

Os produtos são como as APIs são exibidas para os desenvolvedores. Os produtos no Gerenciamento de API têm uma ou mais APIs e são configurados com título, descrição e termos de uso. Produtos podem ser Abertos ou Protegidos. Produtos protegidos devem ser assinados antes que possam ser usados, enquanto produtos abertos podem ser usados sem uma assinatura. A aprovação de assinatura é configurada no nível do produto e pode requere a aprovação do administrador ou ser aprovada automaticamente.

Grupos

Os grupos são usados para gerenciar a visibilidade dos produtos para os desenvolvedores. O Gerenciamento de API tem os grupos de sistema imutáveis a seguir:

Administradores – Gerenciam instâncias de serviço de Gerenciamento de API e criam as APIs, operações e produtos que são usados pelos desenvolvedores. Os administradores de assinatura do Azure são membros desse grupo.
Desenvolvedores – usuários autenticados do portal do desenvolvedor que cria aplicativos usando suas APIs. Os desenvolvedores têm acesso ao portal do desenvolvedor e criam aplicativos que chamam as operações de uma API.
Convidados – Usuários do portal do desenvolvedor não autenticados. Eles podem receber certos acessos somente leitura, como a capacidade de exibir APIs, mas não de chamá-las.

Além desses grupos de sistemas, os administradores podem criar grupos personalizados ou usar grupos externos em locatários associados do Microsoft Entra.

Desenvolvedores

Os desenvolvedores representam as contas de usuários em uma instância de serviço de Gerenciamento de API. Os desenvolvedores podem ser criados ou convidados para se juntar aos administradores ou podem fazer a inscrição no Portal do desenvolvedor. Cada desenvolvedor é um membro de um ou mais grupos, e pode assinar produtos que dão visibilidade a esses grupos.

Políticas

As políticas são um conjunto de instruções executadas em sequência, na solicitação ou na resposta de uma API. As instruções populares incluem a conversão do formato de XML para JSON e limite de taxa de chamada para restringir a quantidade de chamadas recebidas de um desenvolvedor, além de várias outras políticas disponíveis.

Expressões de política podem ser usadas como valores de atributo ou texto em qualquer uma das políticas de Gerenciamento de API, a menos que a política especifique o contrário. Algumas políticas, como Controlar fluxo e Definir variável se baseiam em expressões de políticas.