Descubra o serviço de Gerenciamento de API

Concluído

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álises, segurança e proteção. Cada API é constituída por uma ou mais operações e cada API pode ser adicionada a um ou mais produtos. Para utilizar uma API, os programadores subscrevem um produto que contém essa API e, em seguida, podem chamar a operação da API, estando sujeitos a todas as políticas de utilização que possam estar em vigor.

Componentes de 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ários níveis , diferindo em capacidade e recursos.

  • O gateway da API é o ponto final que:

    • Aceita chamadas de API e as encaminha para back-ends apropriados
    • Verifica chaves de API e outras credenciais apresentadas com solicitações
    • Impõe cotas de uso e limites de taxa
    • Transforma solicitações e respostas especificadas em declaraçõ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, emissão de relatórios e solução de problemas
  • O plano de gerenciamento é a interface administrativa onde você configura seu programa de API. Utilize-o para:

    • Provisionar e definir configurações do serviço de Gerenciamento de API
    • Definir ou importar esquema de API
    • Empacotar APIs em produtos
    • Configurar políticas como cotas ou transformações nas APIs
    • Obtenha informações a partir de análises
    • Gerir utilizadores
  • O portal do desenvolvedor é um site gerado automaticamente, totalmente personalizável com a documentação de suas APIs. Usando o portal do desenvolvedor, os desenvolvedores podem:

    • Leia a documentação da API
    • Chame uma API através do console interativo
    • Crie uma conta e inscreva-se para obter chaves de API
    • Aceda a análises sobre a sua própria utilização
    • Baixar definições de API
    • Gerir chaves de API

Produtos

Os produtos são a forma como as APIs são apresentadas aos programadores. Os produtos na API Management têm uma ou mais APIs e são configurados com um título, uma descrição e termos de utilização. Os produtos podem ser Abertos ou Protegidos. Os produtos protegidos têm de ser subscritos antes de poderem ser utilizados, enquanto os produtos abertos podem ser utilizados sem uma subscrição. A aprovação da assinatura é configurada no nível do produto e pode exigir aprovação do administrador ou ser aprovada automaticamente.

Grupos

Os grupos são utilizados para gerir a visibilidade dos produtos para os programadores. A Gestão de API tem os seguintes grupos de sistema imutáveis:

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

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

Programadores

Os programadores representam as contas de utilizador numa instância de serviço de API Management. Os programadores podem ser criados ou convidados a aderirem por administradores, ou podem inscrever-se a partir do Portal do programador. Cada programador é membro de um ou mais grupos e pode subscrever os produtos que concedem visibilidade a esses grupos.

Políticas

As políticas são uma coleção de instruções que são executadas sequencialmente no pedido ou na resposta de uma API. As instruções populares incluem a conversão do formato de XML para JSON e a limitação de taxa de chamadas para restringir o número de chamadas recebidas de um programador, bem como várias outras políticas disponíveis.

As expressões de política podem ser utilizadas como valores de atributo ou valores de texto em qualquer uma das políticas de API Management, a menos que a política especifique o contrário. Algumas políticas, como Fluxo de controlo e Definir variável, baseiam-se em expressões de política.

As políticas podem ser aplicadas em escopos diferentes, dependendo das suas necessidades: global (todas as APIs), um produto, uma API específica ou uma operação de API.