Introdução

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

O que é um plano de taxas?

Um plano de taxas especifica a abordagem de monetização para seu pacote de produtos de API ou para produtos de API individuais no pacote. Por exemplo, ele especifica se você cobra pelo uso do pacote e dos produtos de API com base em uma taxa fixa ou variável e se há taxas adicionais. Como alternativa, você pode usar a monetização para gerenciar limites de transação e receber notificações quando esses limites forem atingidos, sem cobrar 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 taxas publicado que esteja em vigor, ele não será monetizado. Isso significa que os desenvolvedores de apps podem usar as APIs sem restrições ou taxas após a aprovação do registro.

Ao criar um plano, você pode:

  • Selecionar o tipo de plano de taxas e configurá-lo com base no tipo selecionado. Consulte Tipos de planos de taxas aceitos.
  • Especificar o público-alvo do plano de taxas para que ele esteja disponível para todos os desenvolvedores, ou apenas para um desenvolvedor, empresa ou categoria de desenvolvedor específica.

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

  • Definir o plano de taxas como público ou particular. Consulte Planos de tarifas públicos e tarifas exclusivas.
  • 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) ou específico do produto de API.

Para mais informações, consulte Como gerenciar planos de taxas.

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

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

Tipos de planos de taxas aceitos

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

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

Plano de taxas Descrição
Taxas

O desenvolvedor de apps paga taxas para usar o pacote de produtos de API e os recursos dele.

Crie um plano somente de taxas ou adicione taxas a um plano de taxas. As taxas podem incluir:

  • Taxa de configuração: taxa única cobrada de 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 prazo de renovação.
  • Taxa básica: taxa cobrada do desenvolvedor de forma contínua até que ele encerre o plano.

    Para taxas recorrentes, você configura:

    • Duração entre as cobranças da taxa básica (como 30 dias)
    • Se uma taxa é proporcional quando um desenvolvedor inicia ou encerra um plano no meio de um mês
    • Se a taxa básica é cobrada antecipadamente
    • Quando as taxas vencem
Tabela de preços

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

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

    Você também configura:

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

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

Participação na receita

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

  • 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 durante 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 taxas se aplica a todos os produtos de API ou a um produto de API específico em um pacote de produtos de API
  • Período de renovação (em meses ou anos)
  • Quando o pagamento vence
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 de apps, e o desenvolvedor de apps paga por cada transação.

Notificação ajustável

Plano somente de notificação. O provedor de API pode ajustar o número de transações de destino para cada desenvolvedor de app que vai 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 planos de taxas, os detalhes do plano são finais depois que o plano é publicado e são iguais 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 que foi atingida, como 90%, 100% ou 150%. As transações adicionais não são bloqueadas depois que o número de destino é atingido. 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 de apps com base em um atributo personalizado em cada transação.

Freemium O desenvolvedor pode usar um produto de API sem custo financeiro durante um período ou com base na quantidade de uso.

Planos de tarifas públicos e tarifas exclusivas

Ao criar um plano de taxas, é possível especificar se ele é público ou particular.

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 taxas.
Particular Os planos de tarifas exclusivas não ficam visíveis para os desenvolvedores de apps no portal do desenvolvedor. É necessário comprar manualmente o plano de taxas em nome do desenvolvedor de apps usando a interface de gerenciamento ou a API de monetização. Depois da compra, o desenvolvedor de apps vai ver o plano de taxas na lista de planos de taxas comprados.