Como o Gerenciamento de API do Azure dá suporte à monetização

APLICA-SE A: todas as camadas do Gerenciamento de API

Com a plataforma de serviço de Gerenciamento de API do Azure , você pode:

Publique APIs, às quais seus usuários se inscrevem.
Implementação com mitigação de riscos.
Acelere o cronograma do projeto.
Dimensione suas APIs com confiança.

Neste documento, nos concentramos nos recursos de Gerenciamento de API que permitem a implementação de sua estratégia de monetização, como fornecer uma experiência sem atritos para:

Descubra suas APIs públicas.
Insira os detalhes do pagamento.
Ativar uma assinatura.
Consumir a API.
Monitore o uso.
Pague automaticamente pelo uso da API.

O diagrama a seguir apresenta estes principais recursos de Gerenciamento de API:

Descoberta de API

Inicie sua API e integre os consumidores de API usando o portal de desenvolvedor interno do Gerenciamento de API. Enfatize o conteúdo de desenvolvimento de boa qualidade para o portal do desenvolvedor, permitindo que os consumidores de API explorem e usem suas APIs perfeitamente. Teste o conteúdo e as informações fornecidas para acessibilidade, minuciosidade e usabilidade.

Para saber como adicionar conteúdo e controlar a identidade visual do portal do desenvolvedor, consulte Visão geral do portal do desenvolvedor.

Pacote de API

O Gerenciamento de API permite gerenciar como suas APIs são empacotadas e apresentadas usando o conceito de produtos e políticas.

Products

As APIs são publicadas por meio de produtos. Os produtos permitem que você defina:

Quais APIs um assinante pode acessar.
Políticas de limitação específicas, como limitar uma assinatura específica a uma cota de chamadas por mês.

Quando um consumidor de API assina um produto, ele recebe uma chave de API que pode ser usada para fazer chamadas. Inicialmente, a assinatura é definida para submitted. Ative a assinatura para permitir que os assinantes usem as APIs.

Você pode configurar os produtos de Gerenciamento de API para empacotar sua API subjacente para espelhar seu modelo de receita, com:

Uma relação um-para-um entre cada camada em seu modelo de receita.
Um produto de Gerenciamento de API correspondente.

Projetos de exemplo usam produtos de Gerenciamento de API como o meio de nível superior de codificar a estratégia de monetização. Os produtos de Gerenciamento de API espelham as camadas de modelo de receita e indexam o modelo de preços específico para cada camada. Essa configuração fornece uma abordagem flexível e orientada por configurações para preparar a estratégia de monetização.

Policies

Aplique políticas de Gerenciamento de API para controlar a qualidade do serviço para cada produto. Projetos de exemplo usam dois recursos de política específicos para controlar a qualidade do serviço, de acordo com o modelo de receita:

Recurso de política	Description
Cota	Define o número total de chamadas que o usuário pode fazer à API durante um período de tempo especificado, por exemplo, 100 chamadas por mês. Depois que o usuário atinge a cota, as chamadas para a API falham e o chamador recebe um `403 Forbidden` código de status de resposta.
Limite de taxa	Define o número de chamadas em uma janela de tempo deslizante que pode ser feita para a API, por exemplo, 200 chamadas por minuto. Projetado para evitar picos no uso da API além da qualidade de serviço paga do produto escolhido. Quando a taxa de chamada é excedida, o chamador recebe um `429 Too Many Requests` código de status de resposta.

Para obter mais detalhes sobre políticas, consulte Políticas no Gerenciamento de API do Azure.

Consumo de API

Conceda acesso para os consumidores de API para suas APIs por meio de produtos usando assinaturas de API.

Os consumidores de API estabelecem assinaturas de API ao se inscrever em um produto específico do Gerenciamento de API.
Integre o processo de assinatura com o provedor de pagamentos usando a delegação de Gerenciamento de API.
Depois de fornecer detalhes de pagamento com êxito, os usuários obtêm acesso à API com uma chave de segurança exclusiva e gerada para a assinatura.

Para obter mais informações sobre assinaturas, consulte Assinaturas no Gerenciamento de API do Azure.

Monitoramento de uso da API

Você pode obter insights sobre o uso e o desempenho da API usando a análise interna do Gerenciamento de API. Esses dados analíticos fornecem relatórios por:

API
Geografia
Operações de API
Product
Solicitação
Subscription
Hora
Utilizador

Examine os relatórios de análise regularmente para entender como sua estratégia de monetização está sendo adotada pelos consumidores de API.

Para obter mais informações, consulte Monitorar o Gerenciamento de API.

Segurança

Controle o nível de acesso de cada usuário para cada produto usando produtos, políticas de API e assinaturas do Gerenciamento de API. Evite uso indevido e abuso concedendo acesso à API no nível da assinatura se o usuário tiver se autenticado com êxito com o provedor de pagamento, mesmo que o produto de API específico seja gratuito.

Integration

Crie uma experiência de monetização perfeita por meio da integração de front-end e back-end entre o Gerenciamento de API e o provedor de pagamento escolhido. Use a delegação de Gerenciamento de API para integração de front-end e a API REST para integração de back-end.

Delegação

Nos projetos de exemplo, você pode usar a delegação de Gerenciamento de API para fazer integrações personalizadas com os provedores de pagamento do parceiro. A demonstração usa delegação para os processos de cadastro/login e assinatura de produtos.

Fluxo de trabalho de inscrição/entrada

O desenvolvedor seleciona o link de login ou cadastro no portal de desenvolvimento de gerenciamento de API.
O navegador da Web redireciona para o ponto de extremidade de delegação (configurado para uma página específica no aplicativo do portal de faturamento personalizado).
O aplicativo do portal de faturamento apresenta uma UI de login/cadastro.
Após a entrada/inscrição bem-sucedida, o usuário é autenticado e redirecionado de volta para a página inicial do portal do desenvolvedor do Gerenciamento de API.

Fluxo de trabalho da assinatura do produto

O desenvolvedor seleciona um produto no portal do desenvolvedor de Gerenciamento de API e escolhe o botão Assinar .
O navegador da Web redireciona para o ponto de extremidade de delegação (configurado para uma página específica no aplicativo do portal de faturamento personalizado).
O aplicativo personalizado do portal de cobrança:
- Apresenta uma interface do usuário configurada com base no provedor de pagamento (Stripe ou Adyen).
- Leva o usuário pelo processo de check-out relevante.
O usuário é redirecionado de volta para a página de produto do Gerenciamento de API inicial.
- O produto está ativo e as chaves de API estão disponíveis.

API REST

Use a API REST para Gerenciamento de API para automatizar a operação de sua estratégia de monetização.

Os projetos de exemplo usam a API para realizar de forma programática:

Recupere produtos e políticas de Gerenciamento de API para habilitar a configuração sincronizada de conceitos semelhantes em provedores de pagamento, como o Stripe.
Sondar o Gerenciamento de API regularmente para recuperar as métricas de uso da API para cada assinatura e conduzir o processo de cobrança.

Para obter mais informações, consulte a referência da API REST do Gerenciamento de API do Azure.

DevOps

Implemente o controle de versão e automatize as alterações de implantação no Gerenciamento de API usando o Azure Resource Manager, incluindo a configuração de recursos que implementam sua estratégia de monetização, como:

Products
Policies
O portal do desenvolvedor

Em projetos de exemplo, os scripts do Azure Resource Manager são aumentados por um arquivo JSON, que define o modelo de preço de cada produto do Gerenciamento de API. Com esse aumento, você pode sincronizar a configuração entre o Gerenciamento de API e o provedor de pagamento escolhido. A solução inteira é gerenciada em um único repositório de controle do código-fonte para:

Coordene todas as alterações associadas à evolução da estratégia de monetização em andamento como uma única versão.
Execute as alterações, seguindo os requisitos de governança e auditoria.

Inicialização e implantação

O Gerenciamento de API pode ser implantado por meio de:

O portal do Azure
Uma infraestrutura como abordagem de código usando modelos do Azure Resource Manager

Compartilhar via