Configurar um plano freemium

Esta é a documentação do Apigee Edge.
Acesse Documentação da Apigee X.
informações

Com um plano freemium, os desenvolvedores de apps podem usar o plano de tarifas sem custo financeiro por um período baseado no uso, na duração ou em ambos. É possível configurar um plano freemium para qualquer tipo de plano de tarifas, exceto notificações ajustáveis.

Como configurar um plano freemium usando a interface

Configure um plano freemium para um plano de tarifas, conforme descrito abaixo.

Edge

Para configurar um plano freemium usando a interface do Edge ao criar ou editar um plano de tarifas, selecione qualquer tipo de plano (exceto a notificação ajustável). Na seção Freemium, ative o plano freemium e selecione uma das seguintes opções:

  • Oferta por uso (número de chamadas de API)
  • Oferta por período
  • O que vier primeiro

Com base na sua seleção, configure um dos seguintes campos ou ambos:

Campo Descrição
Uso do Freemium (chamadas de API) Observação: obrigatório se você selecionar Oferta por quantidade ou O que acontecer primeiro.

É o número de transações (ou valor referente a um atributo personalizado registrado na política de gravação de transações) em que os desenvolvedores não são cobrados. O volume é medido para o produto da API.

Período freemium Observação: obrigatório se você selecionar Oferta por duração ou O que acontecer primeiro.

Intervalo de tempo em que os desenvolvedores não são cobrados. Por exemplo, 30 dias. Especifique o número e a unidade (dia, semana ou mês).

Edge clássico (nuvem privada)

Para configurar um plano freemium usando a interface clássica do Edge:

  1. Selecione a guia Freemium.

  2. Digite as seguintes informações:
    Campo Descrição
    Pacote Freemium?

    A duração do período sem custo financeiro. Selecione um dos seguintes botões de opção:

    • Por quantidade. O período sem custo financeiro é baseado na quantidade especificada no volume .
    • Por duração. O período sem custo financeiro é baseado em um intervalo de tempo especificado no campo Freemium Duration.
    • O que vier primeiro. O período sem custo financeiro terminará quando a quantidade no volume ou o intervalo de tempo do campo Duração do Freemium for atingido, o que ocorrer primeiro.
    • Não. Este não é um plano Freemium. Esse é o padrão.
    Volume freemium

    O volume de transações (ou volume pertencente a um atributo personalizado registrado no a política de gravação de transações) que são cobrados dos desenvolvedores. O volume é medidas em todos os produtos do pacote da API. Insira um número de volume, como 5000. Isso significa que, quando os desenvolvedores iniciam o plano, eles não são cobrados pela primeira 5.000 transações (ou os primeiros 5.000 usos de um item relacionado a atributos personalizados). Esse campo só será ativado se você selecionar "Por quantidade". ou "O que vier primeiro" no "Pacote Freemium?" .

    Duração do Freemium

    É o intervalo de tempo em que os desenvolvedores não são cobrados. Digite um número e selecione um período, por exemplo, 1 mês. Isso significa que os desenvolvedores não estão cobrado por um mês após a data de início do plano adquirido. Este campo é ativada apenas se você selecionar "Por duração" ou "O que vier primeiro" na versão "freemium" Pacote?" .

Como configurar um plano freemium para um plano de tarifas usando a API

É possível adicionar um plano freemium ao criar ou atualizar o plano de tarifas. Você especifica propriedades freemium no corpo da solicitação da chamada.

Por exemplo, a solicitação a seguir cria um plano de tarifas padrão com um período de duração freemium. de 30 dias. (As especificações relacionadas a freemium estão destacadas.)

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Simple rate plan",
     "currency": {
      "id" : "usd"
     },
     "description": "Simple rate plan",
     "displayName" : "Simple rate plan",
     "freemiumDuration": "30",
     "freemiumDurationType": "DAY",
     "monetizationPackage": {
      "id": "location_package"
     },
     "organization": {
      "id": "{org_name}
     },
     "published": "true",
     "ratePlanDetails": [
     {
      …
      }
      ],
     "startDate": "2013-09-15",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location_package/rate-plans" \
-u email:password

Especificar uma quantidade baseada em freemium (como o número de transações que envolvem a API) ou o volume pertencente a um atributo personalizado registrado no registro da transação política), especifique-a como um número de unidades freemium. Por exemplo, a propriedade a seguir especifica que o freemium é baseado em 5.000 unidades freemium:

"freemiumUnit": "5000"

Consulte Plano de tarifas definições de configuração para uma lista completa das opções de planos de tarifas.