Introdução

Você está vendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X.
informações

O que é um plano de tarifa?

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

Os desenvolvedores podem registrar os apps para usar um pacote de produtos da API somente comprando um dos planos de tarifas em vigor no momento. Se um produto de API não tiver um plano de tarifas publicado que esteja em vigor no momento, ele não será monetizado. Isso significa que os desenvolvedores de apps poderão usar as APIs sem restrições ou taxas após a aprovação do registro.

Ao criar um plano, você pode:

  • Selecione o tipo de plano de tarifa e configure-o com base nele. Consulte Tipos de plano de tarifas compatíveis.
  • Especifique o público do plano de tarifas para que ele esteja disponível a todos os desenvolvedores ou somente a um desenvolvedor, empresa ou categoria específica.

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

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

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

Depois de criar um plano de preços, você pode publicá-lo ou salvá-lo como rascunho. Publique-a somente quando tiver absoluta certeza de que ela é definitiva. Após a publicação, só é possível modificar a data de término, e não é possível excluir planos de tarifas publicados. Consulte Como publicar planos de tarifas.

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

Tipos de plano de tarifas compatíveis

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

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

Plano de tarifas Descrição
Taxas

O desenvolvedor de apps cobra taxas para usar o pacote de produtos da API e os recursos relacionados.

Crie um plano cobrado à parte ou adicione taxas a um plano. 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 que será cobrada se o desenvolvedor encerrar o plano antes do período de renovação.
  • Taxa básica: taxa cobrada do desenvolvedor continuamente até o desenvolvedor encerrar o plano.

    Para taxas recorrentes, configure o seguinte:

    • Duração entre as cobranças da taxa básica (como 30 dias)
    • 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.Você precisa configurar um dos seguintes modelos de carregamento:

  • Taxa fixa: é cobrada uma taxa fixa do desenvolvedor para cada transação.
  • Volume em banda: é cobrada uma taxa variável do desenvolvedor, dependendo do volume de transações.
  • Pacotes: é cobrado do desenvolvedor um valor definido (antecipadamente) para cada pacote de transações. O desenvolvedor é cobrado pelo valor definido, mesmo que o pacote não seja totalmente usado.

    Você também vai configurar:

    • Indica se o plano de tarifas se aplica a todos os produtos de API ou a um produto específico de API em um pacote de produtos de API.
    • Período de renovação (em meses ou anos)
    • Data de vencimento do pagamento

    Se você definiu atributos personalizados para seu produto de API, configure um parâmetro de classificação personalizada 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 em cada transação. Por exemplo, o consumidor compra um produto físico ou digital usando a API, e uma parte dos lucros é compartilhada com o desenvolvedor do app. Há suporte para os seguintes modelos de compartilhamento:

  • Modelo fixo: compartilha com o desenvolvedor uma porcentagem fixa da receita gerada em 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 determinado 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 vai configurar:

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

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

Notificação ajustável

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

Observação: um plano de tarifa de notificação ajustável pode ser ajustado depois que o plano de preços é publicado. Para todos os outros tipos de plano de tarifa, os detalhes são definitivos quando o plano é publicado e são os mesmos para todos os desenvolvedores de apps que aceitarem o plano.

Você pode configurar se e quando as notificações serão enviadas com base na porcentagem do número desejado (90%, 100% ou 150%). Outras transações não são bloqueadas depois que o número desejado é alcançado. O período de renovação (em meses ou anos) também é configurado.

Se você definiu atributos personalizados para seu produto de API, configure um parâmetro de classificação personalizada para cobrar o desenvolvedor de apps com base em um atributo personalizado em cada transação.

Freemium (em inglês) O desenvolvedor usa um produto de API sem custo financeiro durante um período ou com base na quantidade de uso.

Planos de tarifas públicos versus privados

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

Tipo Descrição
Público Os planos de tarifas públicas 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 tarifação particulares não são visíveis para os desenvolvedores de apps no portal do desenvolvedor. Você precisa comprar manualmente o plano de tarifas em nome do desenvolvedor do app usando a interface de gerenciamento ou a API de monetização. Depois da compra, o desenvolvedor do app vai encontrar o plano na lista de planos de preços comprados.