Compartilhar via

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

  • Artigo

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

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

  • Publicar APIs, para as quais seus consumidores se inscrevem.
  • Mitigar o risco de implementação.
  • Acelerar as escalas de tempo do projeto.
  • Escalar as 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 ininterrupta para:

  • Descobrir suas APIs públicas.
  • Inserir os detalhes de pagamento.
  • Ativar sua assinatura.
  • Consumir a API.
  • Monitorar o uso.
  • Pagar automaticamente pelo uso da API.

O seguinte diagrama apresenta estes recursos principais de Gerenciamento de API:

Diagrama dos recursos de monetização de Gerenciamento de API de chave

Descoberta de API

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

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

Empacotamento de API

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

Produtos

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, com a qual ele faz as chamadas. Inicialmente, a assinatura é definida no estado submitted. 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 o modelo de receita, com:

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

Os 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 para cada produto. Os projetos de exemplo usam dois recursos de política específicos para controlar a qualidade do serviço, em linha com o modelo de receita:

Recurso 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". Depois que o usuário atingir a cota, as chamadas para a API falharão e o chamador receberá um código de status de resposta 403 Forbidden.
Limite de taxa Define o número de chamadas em uma janela de tempo deslizante que pode ser feita na API. Por exemplo, "200 chamadas por mês". Projetado para evitar picos no uso da API além da qualidade de serviço paga com o produto escolhido. Quando a taxa da chamada for ultrapassada, o chamador receberá um código de status de resposta 429 Too Many Requests.

Para obter mais detalhes sobre as políticas, confira a documentação Políticas no Gerenciamento de API do Azure.

Consumo da API

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

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

Para obter mais informações sobre as assinaturas do Azure, confira 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 a análise interna do Gerenciamento de API. Essas análises fornecem relatórios por:

  • API
  • painel Geografia do app's selecionado
  • Operações de API
  • Produto
  • Solicitação
  • Subscription
  • Hora
  • Usuário

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, confira Obter análise de API no Gerenciamento de API do Azure.

Segurança

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

Integração

Crie uma experiência de monetização direta 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 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 assinatura ou entrada 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 do portal de cobrança personalizado apresenta uma interface de usuário de entrada/inscrição.
  4. 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 de Gerenciamento de API.

Fluxo de trabalho de assinatura do produto

  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 do portal de cobrança personalizado:
    • Apresenta uma interface do usuário configurada com base no provedor de pagamento (Stripe ou Adyen).
    • Conduz o usuário pelo processo de check-out relevante.
  4. O usuário é redirecionado de volta para a página inicial do produto de Gerenciamento de API.
    • O produto estará ativo e as chaves de API estarão disponíveis.

API REST

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

Os projetos de exemplo usam a API para programaticamente:

  • Recuperar os produtos e as políticas de Gerenciamento de API para habilitar a configuração sincronizada de conceitos semelhantes em provedores de pagamento, como 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 saber mais, confira a visão geral da API REST do Gerenciamento de API do Azure.

DevOps

Controle a 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:

  • 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 cada modelo de preço do 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. 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 da:

vídeos

Integrar o Gerenciamento de API ao gateway de pagamento do Adyen

Integrar o Gerenciamento de API ao gateway de pagamento do Stripe

Próximas etapas