Partilhar via

Como o Gerenciamento de API oferece suporte à monetização

  • Artigo

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 seus consumidores se inscrevem.
  • Implementação de redução de riscos.
  • 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 a subscrição.
  • Consuma a API.
  • Monitore o uso.
  • Pague automaticamente pelo uso da API.

O diagrama abaixo apresenta esses principais recursos de gerenciamento de API:

Diagrama dos principais recursos de monetização do 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 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 quanto à acessibilidade, rigor e usabilidade.

Para obter detalhes sobre como adicionar conteúdo e controlar a identidade visual do portal do desenvolvedor, consulte a visão geral do portal do desenvolvedor.

Empacotamento de API

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

Produtos

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 com ele faz chamadas. Inicialmente, a assinatura é definida como um submitted estado. Ative a assinatura para permitir que os assinantes usem as APIs.

Configure 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:

Recurso de política Description
Quota 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 atingir a cota, as chamadas para a API falharão e o chamador receberá 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 podem ser feitas para a API. Por exemplo, "200 chamadas por minuto". Projetado para evitar picos no uso da API além da qualidade paga do serviço com o produto escolhido. Quando a taxa de chamada é excedida, o chamador recebe um código de status de 429 Too Many Requests resposta.

Para obter mais detalhes sobre políticas, consulte a documentação 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.

  1. Os consumidores de API estabelecem assinaturas de API ao se inscreverem em um produto específico de Gerenciamento de API.
  2. Integre o processo de assinatura com o provedor de pagamento usando a delegação de Gerenciamento de API.
  3. 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 a documentação Assinaturas no Gerenciamento de API do Azure.

Monitoramento de uso da API

Obtenha informações sobre o uso e o desempenho da API usando as análises integradas do Gerenciamento de API. Essas análises fornecem relatórios por:

  • API
  • Geografia
  • Operações de API
  • Produto
  • Pedir
  • Subscrição
  • Hora
  • 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 Obter análise de API no Gerenciamento de API do Azure.

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.

Integração

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.

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 de terceiros. A demonstração usa a delegação para as experiências de inscrição/entrada e assinatura do produto.

Fluxo de trabalho de inscrição/entrada

  1. O desenvolvedor clica no link de entrada ou inscrição no portal do desenvolvedor do Gerenciamento de API.
  2. O navegador redireciona para o ponto de extremidade de delegação (configurado para uma página no aplicativo do portal de cobrança personalizado).
  3. O aplicativo de portal de cobrança personalizado apresenta uma interface do usuário de entrada/inscrição.
  4. 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

  1. O desenvolvedor seleciona um produto no portal do desenvolvedor do Gerenciamento de API e clica no botão Assinar
  2. O navegador redireciona para o ponto de extremidade de delegação (configurado para uma página no aplicativo do portal de cobrança personalizado).
  3. Aplicativo de portal de faturamento personalizado:
    • 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.
  4. O usuário é redirecionado de volta para a página inicial do produto Gerenciamento de API.
    • O produto estará ativo e as chaves da API estarã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.
  • Sonde o Gerenciamento de API regularmente para recuperar métricas de uso de API para cada assinatura e conduzir o processo de cobrança.

Para obter mais informações, consulte a Visão geral do Gerenciamento de API do Azure da API REST .

DevOps

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:

  • Produtos
  • 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:

  • A interface do usuário do portal do Azure ou
  • Uma abordagem de "infraestrutura como código" usando modelos do Azure Resource Manager.

Vídeos

Integre o gerenciamento de API com o gateway de pagamento da Adyen

Integre o gerenciamento de API com o gateway de pagamento Stripe

Próximos passos