Visão geral da monetização da Apigee

Esta página se aplica à Apigee e à Apigee híbrida.

Confira a documentação da Apigee Edge.

Nesta seção, você conhecerá a monetização da Apigee.

Monetizar APIs usando a monetização da Apigee

Como provedor de APIs, você precisa de uma maneira fácil de usar e flexível para gerar receita com suas APIs para que possa gerar receita sempre que suas APIs forem usadas. Com o recurso de monetização da Apigee, você pode adicionar um plano de tarifas a um produto de API. Com o plano de tarifas, você cobra aos desenvolvedores pelo uso das suas APIs. Você também pode configurar o plano de tarifas para compartilhar a receita da sua API com os desenvolvedores.

Como um provedor de APIs, você monetiza suas APIs ativando a monetização da Apigee na organização e configurando os componentes definidos na tabela a seguir.

Componente	Descrição
Proxies de API	Ao desenvolver proxies de API para uso com produtos de API monetizados, você pode anexar as seguintes políticas: Política VerifyAPIKey ou VerifyAccessToken, que determinam se uma solicitação de entrada é monetizável ao verificar o plano de taxas publicado ativo. Para mais informações, consulte Como adicionar uma política de autenticação. PolicyLimitsCheck para validar se o desenvolvedor comprou o produto de API associado e tem saldo suficiente na carteira. Para mais informações, consulte Como aplicar assinaturas de desenvolvedor a produtos de API. Política Quota, que usa a configuração de cota definida no produto de API. Para mais informações, consulte Como aplicar cotas de monetização. DataCapture para substituir os dados de uso relacionados à monetização Para mais informações, consulte Capturar dados de monetização.
Produto de API	Defina a coleção de proxies de API que você quer fornecer aos desenvolvedores de apps como um pacote de monetização. O produto de API configura os limites de acesso (cotas), o método de aprovação de chave de API, o plano de taxas (descrito abaixo) e outros detalhes para os proxies de API integradas. Para mais informações, consulte O que é um produto de API? e Como aplicar cotas de monetização em produtos de API. Observação: se você usar o produto de API com a monetização da Apigee, o nome do produto não poderá conter espaços à direita.
Planos de taxas	Defina a configuração do faturamento, as taxas e as cobranças incorridas pelo uso de APIs oferecidas em um pacote de produtos de API monetizada. Por exemplo, é possível compartilhar a receita da API com seus desenvolvedores. Para mais informações, consulte Como gerenciar planos de preços para produtos de API. Observação: se um plano de taxas ativo estiver associado a um produto de API, o produto de API será considerado monetizado. Um produto de API pode ter vários planos de taxas associados a ele, mas somente um plano de taxas pode estar ativo por vez.

Para permitir que os desenvolvedores de apps comprem assinaturas de produtos de API, o provedor de API tem as seguintes possibilidades:

• Integrar a monetização da Apigee ao portal do desenvolvedor baseado em Drupal
• Criar uma interface de portal personalizada e comprar e gerenciar assinaturas de produtos de API usando a API

Para acessar as APIs, os desenvolvedores de apps compram assinaturas de produtos de API, adicionam elas aos apps e recebem uma chave de API para enviar com solicitações de API.

Noções básicas sobre cotas de monetização

Uma cota define o número de solicitações permitidas para um produto de API em um determinado período As cotas protegem os servidores de back-end contra variações de tráfego altas e diferenciam a linha de produtos.

Ao criar produtos de API, é possível configurar cotas de nível de negócios para controlar o acesso às APIs. Para mais informações sobre cotas definidas no nível do produto de API, consulte Cotas.

Anexe políticas de cotas aos proxies de API no produto de API com monetização para garantir que a cota definida no nível do produto de API seja usada. Para mais informações, consulte Como aplicar cotas de monetização.

Observação: se você adicionar uma cota depois que o produto de API estiver em uso, o cálculo da cota começará no momento da próxima transação monetizada.

Como funciona o faturamento

A monetização da Apigee é compatível com contas de faturamento pós-pagas e pré-pagas.

• Faturamento pós-pago: no faturamento pós-pago, os desenvolvedores de apps não realizam pagamentos antecipados. Os desenvolvedores de apps são cobrados após usar os produtos de API.
  A Apigee não oferece recursos específicos de geração de faturas para faturamento. Você lida com o acordo de faturamento com seus desenvolvedores.
• Faturamento pré-pago: nesse caso, os desenvolvedores de apps pagam antecipadamente antes de usar seus produtos de API. O pagamento antecipado feito pelo desenvolvedor está disponível na carteira do desenvolvedor. Com base no uso, o custo por transação é deduzido da carteira.

  A taxa de configuração (se houver), o custo por transação e todas as taxas recorrentes são deduzidas da carteira. Se a carteira do desenvolvedor tiver menos que o valor de qualquer taxa de configuração no momento da tentativa de compra de produto de API, a compra falhará com um erro que indica fundos insuficientes.

Ao criar um plano de taxas, você configura a moeda e a frequência de faturamento, bem como quaisquer taxas de configuração, recorrentes e as taxas com base no consumo. Com base na configuração do plano de taxas e na chave de API exclusiva do desenvolvedor usada para acessar as APIs, é possível coletar dados de uso para análise e gerar relatórios de monetização. Depois, use os dados coletados para gerar as faturas.