Vista geral da rentabilização do Apigee

Esta página aplica-se ao Apigee e ao Apigee Hybrid.

Veja a documentação do Apigee Edge.

Esta secção apresenta a rentabilização do Apigee.

Rentabilize as suas APIs através da rentabilização da Apigee

Enquanto fornecedor de APIs, precisa de uma forma flexível e fácil de usar para rentabilizar as suas APIs, de modo a poder gerar receita sempre que as suas APIs forem usadas. Com a funcionalidade de rentabilização do Apigee, pode adicionar um plano tarifário a um produto de API. O plano tarifário permite-lhe cobrar aos programadores pela utilização das suas APIs. Também pode configurar o plano de tarifas para partilhar a receita da API com os programadores.

Enquanto fornecedor de APIs, rentabiliza as suas APIs ativando a rentabilização do Apigee na sua organização e configurando os componentes definidos na tabela seguinte.

Componente	Descrição
Proxies de API	Ao desenvolver proxies de API para utilização com produtos de API rentabilizados, pode anexar as seguintes políticas: Política VerifyAPIKey ou a Operação VerifyAccessToken da política OAuth2 para determinar se um pedido recebido é rentabilizável verificando o plano tarifário publicado ativo. Para mais informações, consulte o artigo Adicionar uma política de autenticação. Política MonetizationLimitsCheck para validar se o programador comprou o produto API associado e tem saldo suficiente na carteira. Para mais informações, consulte Aplicação de subscrições de programadores a produtos de API. Política de quotas para usar a configuração de quotas definida através do produto API. Para mais informações, consulte o artigo Aplicação de quotas de rentabilização. Política de captura de dados para substituir os dados de utilização relacionados com a rentabilização. Para mais informações, consulte Capture dados de rentabilização.
Produto da API	Defina a coleção de proxies de API que quer disponibilizar aos programadores de apps como um pacote rentabilizado. O produto API configura os limites de acesso (quotas), o método de aprovação da chave da API, o plano tarifário (descrito abaixo) e outros detalhes para os proxies de API incluídos. Para mais informações, consulte os artigos O que é um produto de API? e Aplicação de quotas de rentabilização em produtos de API. Nota: se usar o produto API com a rentabilização do Apigee, o nome do produto não pode conter espaços no final.
Plano tarifário	Defina a configuração de faturação, as taxas e os encargos incorridos pela utilização de APIs oferecidas num pacote de produtos de API monetizado. Por exemplo, pode partilhar a receita da API com os seus programadores. Para mais informações, consulte o artigo Gerir planos tarifários para produtos API. Nota: se um plano tarifário ativo estiver associado a um produto API, o produto API é considerado rentabilizado. Um produto de API pode ter vários planos tarifários associados, mas apenas um plano tarifário pode estar ativo em qualquer momento.

Permitir que os programadores de apps comprem subscrições de produtos de API

Para permitir que os programadores de apps comprem subscrições de produtos de API, como fornecedor de APIs, pode fazer uma das seguintes ações:

• Integre a rentabilização do Apigee com o seu portal do programador baseado no Drupal
• Crie uma interface de portal personalizada e compre e faça a gestão de subscrições de produtos de API através da API

Para aceder às APIs, os programadores de apps compram subscrições de produtos de API, adicionam-nas às respetivas apps e obtêm uma chave da API para enviar com os pedidos de API.

Compreenda as quotas de rentabilização

Uma quota define o número de pedidos permitidos para um produto API durante um determinado período. As quotas podem proteger os seus servidores de back-end de variações de tráfego elevadas e diferenciar a sua linha de produtos.

Quando criar os seus produtos de API, pode configurar quotas ao nível da empresa para controlar o acesso às suas APIs. Para mais informações sobre as quotas definidas ao nível do produto API, consulte o artigo Quotas.

Anexe políticas de quota aos proxies de API no seu produto de API rentabilizado para garantir que é usada a quota definida ao nível do produto de API. Para mais informações, consulte o artigo Aplicação de quotas de rentabilização.

Nota: se adicionar uma quota depois de o produto da API estar em utilização, o cálculo da quota começa a partir da transação monetizada seguinte.

Compreenda a faturação de produtos de API rentabilizados

A rentabilização do Apigee suporta contas de faturação pós-pagas e pré-pagas.

• Faturação pós-paga: na faturação pós-paga, os programadores de apps não fazem nenhum pagamento inicial. Os programadores de apps são faturados após a utilização dos seus produtos de API.
  O Apigee não oferece nenhuma funcionalidade específica de geração de faturas para faturação. É responsável pela liquidação da faturação junto dos seus programadores.
• Faturação pré-paga: na faturação pré-paga, os programadores de apps pagam antecipadamente antes de usar os seus produtos de API. O pagamento inicial feito pelo programador está disponível na carteira do programador. Com base na utilização, o custo por transação é deduzido da carteira.

  A taxa de configuração (se aplicável), o custo por transação e quaisquer taxas recorrentes são deduzidos da carteira. Se a carteira do programador contiver um valor inferior ao de qualquer taxa de configuração no momento da tentativa de compra do produto API, a compra falha com um erro que indica fundos insuficientes.

Quando cria um plano de tarifas, configura a moeda e a frequência de faturação, as taxas de configuração e recorrentes, bem como as taxas baseadas no consumo. Com base na configuração do plano tarifário e na chave da API única do programador usada para aceder às suas APIs, pode recolher dados de utilização para análise e gerar relatórios de rentabilização. Em seguida, pode usar os dados recolhidos para gerar as suas faturas de faturação.