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

APLICA-SE A: Todas as camadas de gerenciamento de API

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

Publique APIs, às quais os seus consumidores aderem.
Reduzir riscos na implementação.
Acelere os prazos do projeto.
Dimensione suas APIs com confiança.

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

Descubra suas APIs públicas.
Insira os detalhes de pagamento.
Ative uma assinatura.
Consuma a API.
Monitore o uso.
Pague automaticamente pelo uso da API.

O diagrama a seguir apresenta esses principais recursos de gerenciamento de API:

Descoberta de API

Inicie sua API e integre consumidores de API usando o portal de desenvolvedor integrado do Gerenciamento de API. Enfatize 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 quanto à acessibilidade, rigor 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.

Empacotamento de APIs

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 através de produtos. Os produtos permitem-lhe definir:

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 usar para fazer chamadas. Inicialmente, a assinatura é definida como estado 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 nível no 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 do 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ção para preparar a estratégia de monetização.

Políticas

Aplique políticas de Gerenciamento de API para controlar a qualidade do serviço de cada produto. Exemplos de projetos utilizam duas características políticas específicas para controlar a qualidade do serviço, em conformidade com o modelo de receitas:

Funcionalidade de política	Description
Cota	Define o número total de chamadas que o usuário pode fazer para a API durante um período de tempo especificado, por exemplo, 100 chamadas por mês. Quando o usuário atinge a cota, as chamadas para a API falham e o chamador recebe um código de status de `403 Forbidden` resposta.
Limite da 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 prevenir picos no uso da API além da qualidade de serviço paga com o produto escolhido. Quando o limite de chamadas é excedido, o chamador recebe um código de status de resposta `429 Too Many Requests`.

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

Consumo de API

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

Os consumidores de API estabelecem assinaturas de API ao se inscreverem em um produto específico de Gerenciamento de API.
Integre o processo de assinatura com o provedor de pagamento usando a delegação de Gerenciamento de API.
Depois de fornecer com sucesso os detalhes de pagamento, os usuários obtêm acesso à API com uma chave de segurança exclusiva 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 informações sobre o uso e o desempenho da API usando as análises internas do Gerenciamento de API. Essas análises geram relatórios por:

API
Geografia
Operações de API
Produto
Solicitação
Subscription
Time
User

Revise 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 a cada produto usando os produtos, políticas de API e assinaturas do Gerenciamento de API. Impeça o uso indevido e o 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 específico da API seja gratuito.

Integration

Crie uma experiência de monetização perfeita por meio da integração 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 front-end e a API REST para integração back-end.

Delegation

Nos projetos de exemplo, você pode usar a delegação de Gerenciamento de API para fazer integrações personalizadas com os provedores de pagamento parceiros. A demonstração usa a delegação para os processos de registo/início de sessão e a assinatura do produto.

Fluxo de trabalho de inscrição/entrada

O desenvolvedor seleciona o link de iniciar sessão ou registar-se no portal de programadores da Gestão de API.
O navegador da web redireciona para o ponto de delegação (configurado para uma página na aplicação do portal de faturação personalizado).
A aplicação do portal de faturação personalizada apresenta uma interface de usuário de início de sessão/registo.
Após o login/inscrição bem-sucedido, o usuário é autenticado e redirecionado de volta para a página inicial do portal do desenvolvedor do Gerenciamento de API.

Fluxo de trabalho de subscrição de produtos

O desenvolvedor seleciona um produto no portal do desenvolvedor do Gerenciamento de API e escolhe o botão Assinar .
O navegador da web redireciona para o ponto de delegação (configurado para uma página na aplicação do portal de faturação personalizado).
A aplicação do portal de faturação personalizada:
- Apresenta uma interface do usuário configurada com base no provedor de pagamento (Stripe ou Adyen).
- Conduz o usuário através do processo de checkout relevante.
O usuário é redirecionado de volta para a página inicial do produto Gerenciamento de API.
- 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, programaticamente:

Recupere produtos e políticas de gerenciamento de API para permitir a configuração sincronizada de conceitos semelhantes em provedores de pagamento, como o Stripe.
Interrogue a Gestão de API regularmente para recuperar métricas de uso de API para cada subscrição e impulsionar o processo de faturação.

Para obter mais informações, consulte Referência da API REST de 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 Gerenciador de Recursos do Azure, incluindo a configuração de recursos que implementam sua estratégia de monetização, como:

Products
Políticas
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ços de cada produto de Gerenciamento de API. Com esse aumento, você pode sincronizar a configuração entre o Gerenciamento de API e o provedor de pagamento escolhido. Toda a solução é gerenciada sob um único repositório de controle de origem, para:

Coordene todas as alterações associadas à evolução contínua da estratégia de monetização como uma única versão.
Realizar as mudanças, 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

Partilhar via