Introdução

Você está visualizando a documentação do Apigee Edge.
Acesse a documentação da Apigee X.
info

O que é um plano de tarifas?

Um plano de tarifas especifica a abordagem de monetização para o pacote de produtos de API ou para produtos de API individuais no pacote de produtos. Por exemplo, ele especifica se você cobra pelo uso do pacote de produtos de API e dos produtos com base em uma taxa fixa ou variável e se há taxas adicionais. Como alternativa, você pode usar a monetização para gerenciar os limites de transação e receber notificações quando eles forem atingidos, sem cobrança de taxas.

Os desenvolvedores só podem registrar os apps para usar um pacote de produtos de API comprando um dos planos de taxas em vigor. Se um produto de API não tiver um plano de tarifa publicado em vigor, o produto não será monetizado. Isso significa que os desenvolvedores de apps poderão usar as APIs sem restrições ou taxas depois que o registro for aprovado.

Ao criar um plano, você pode:

  • Selecione e configure o plano de tarifas com base no tipo escolhido. Consulte Tipos de plano de tarifas compatíveis.
  • Especifique o público-alvo do plano de taxas para que ele fique disponível para todos os desenvolvedores ou apenas para um desenvolvedor, empresa ou categoria de desenvolvedores específico.

    Configure as categorias de desenvolvedor conforme necessário, conforme descrito em Gerenciar categorias de desenvolvedor.

  • Defina o plano de tarifas como público ou privado. Consulte Planos de tarifas públicos e privados.
  • Para pacotes de produtos de API que incluem vários produtos de API, é possível tornar o plano genérico (ou seja, ele se aplica a todos os produtos de API em um pacote de produtos de API) ou específico do produto de API.

Para mais informações, consulte Gerenciar planos de tarifas.

Depois de criar um plano de taxas, você pode publicá-lo ou salvá-lo como rascunho. Só publique quando tiver certeza de que é a versão final. Depois de publicar, só é possível modificar a data de término. Não é possível excluir um plano de preços publicado. Consulte Como publicar planos de taxas.

Depois de publicar um plano de tarifas, você pode realizar uma ou mais das seguintes tarefas, conforme necessário:

Tipos de planos de tarifas aceitos

Você configura os planos de tarifas para usar um ou mais dos tipos mostrados na figura a seguir.

A tabela a seguir apresenta cada tipo de plano de preços, descreve as opções de configuração e fornece um link para mais informações.

Plano de tarifa Descrição
Taxas

O desenvolvedor de apps é cobrado para usar o pacote de produtos de API e os recursos dele.

Crie um plano somente com taxas ou adicione taxas a um plano de preços. As taxas podem incluir:

  • Taxa de configuração: taxa única cobrada para cada desenvolvedor na data de início do plano.
  • Taxa de rescisão antecipada: taxa única cobrada se o desenvolvedor encerrar o plano antes do período de renovação.
  • Taxa base: é cobrada do desenvolvedor de forma contínua até que ele encerre o plano.

    Para taxas recorrentes, configure:

    • Duração entre as cobranças da taxa básica (por exemplo, 30 dias)
    • Indica se uma taxa é proporcional se um desenvolvedor iniciar ou encerrar um plano no meio do mês
    • Se a taxa básica é cobrada antecipadamente
    • Quando as taxas são devidas
Tabela de preços

O desenvolvedor é cobrado por cada transação. É necessário configurar um dos seguintes modelos de cobrança:

  • Taxa fixa: o desenvolvedor é cobrado uma taxa fixa por cada transação.
  • Banda de volume: o desenvolvedor é cobrado com uma taxa variável dependendo do volume de transações.
  • Pacotes: o desenvolvedor paga um valor definido (de antemão) por cada pacote de transações. O desenvolvedor vai receber o valor definido, independentemente de o pacote ser usado ou não.

    Você também configura:

    • Se o plano de tarifas se aplica a todos os produtos de API ou a um produto específico em um pacote de produtos de API
    • Período de renovação (em meses ou anos)
    • Quando o pagamento é devido

    Se você definiu atributos personalizados para o produto de API, é possível configurar um parâmetro de classificação personalizado para cobrar o desenvolvedor do app com base em um atributo personalizado em cada transação.

Compartilhamento de receita

O provedor de API compartilha com o desenvolvedor uma porcentagem da receita gerada em cada transação. Por exemplo, o consumidor compra um produto físico ou digital usando a API, e uma parte dos rendimentos é compartilhada com o desenvolvedor do app. Os seguintes modelos de compartilhamento são compatíveis:

  • Modelo fixo: compartilhe com o desenvolvedor uma porcentagem fixa da receita gerada por cada transação (com base no preço bruto ou líquido de uma transação).
  • Modelo flexível: compartilhe com o desenvolvedor uma porcentagem variável da receita. A participação na receita depende da receita gerada em um período. A porcentagem usada no cálculo da participação na receita pode variar com base no valor da receita gerada pelas transações.

Você também configura:

  • Se o plano de tarifas se aplica a todos os produtos de API ou a um produto específico em um pacote de produtos de API
  • Período de renovação (em meses ou anos)
  • Quando o pagamento é devido
Tabela de preços e participação na receita

O provedor de API compartilha uma porcentagem da receita gerada por cada transação com o desenvolvedor do app, que é cobrado por cada transação.

Notificação ajustável

Plano somente de notificações. O provedor de API pode ajustar o número de transações de destino para cada desenvolvedor de app que acionar a notificação.

Observação: um plano de taxas de notificação ajustável pode ser ajustado após a publicação. Para todos os outros tipos de plano de preços, os detalhes do plano de preços são finais após a publicação e são os mesmos para todos os desenvolvedores de apps que aceitam o plano.

É possível configurar se e quando as notificações são enviadas com base na porcentagem do número de destino alcançado, como 90%, 100% ou 150%. As transações adicionais não são bloqueadas depois que o número de destino é alcançado. Você também configura o período de renovação (em meses ou anos).

Se você definiu atributos personalizados para o produto de API, é possível configurar um parâmetro de classificação personalizado para cobrar o desenvolvedor do app com base em um atributo personalizado em cada transação.

Freemium O desenvolvedor usa um produto de API sem cobrança por um período ou com base no volume de uso.

Planos de tarifas públicos e particulares

Ao criar um plano de taxas, você pode especificar se ele é público ou privado.

Tipo Descrição
Público Os planos de taxas públicos ficam visíveis para os desenvolvedores de apps no portal do desenvolvedor. Os desenvolvedores de apps podem se inscrever no plano de tarifas.
Particular Os planos de tarifas particulares não ficam visíveis para os desenvolvedores de apps no portal do desenvolvedor. É necessário comprar manualmente o plano de taxa em nome do desenvolvedor do app usando a API de monetização ou a interface de gerenciamento. Depois da compra, o desenvolvedor do app vai encontrar o plano de taxas na lista de planos de taxas comprados.