Você está lendo a documentação do Apigee Edge.
Acesse a
documentação da Apigee X. info
Um plano freemium permite que os desenvolvedores de apps usem o plano de taxas sem custo financeiro por um período com base no uso, na duração ou em ambos. É possível configurar um plano freemium para qualquer tipo de plano de taxas, exceto a notificação ajustável.
Como configurar um plano freemium usando a interface
Configure um plano freemium para um plano de taxas, conforme descrito abaixo.
Edge
Para configurar um plano freemium usando a interface do Edge ao criar ou editar um plano de taxas, selecione qualquer tipo de plano de taxas (exceto a notificação ajustável) e, 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 acontecer primeiro
Com base na sua seleção, configure um ou ambos os campos a seguir:
| Campo | Descrição |
|---|---|
| Uso freemium (chamadas de API) | Observação: obrigatório se você selecionar Oferta por quantidade ou O que acontecer primeiro.
Número de transações (ou valor referente a um atributo personalizado registrado na política de registro de transações) para as quais 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 durante o qual 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 do Edge clássico:
- Selecione a guia "Freemium".
- Digite as seguintes informações:
Campo Descrição Pacote freemium? A extensã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 em uma quantidade especificada no campo "Volume" .
- Por duração. O período sem custo financeiro é baseado em um intervalo de tempo especificado no campo "Duração freemium".
- O que acontecer primeiro. O período sem custo financeiro termina quando a quantidade no campo "Volume" ou o intervalo de tempo no campo "Duração freemium" é atingido, o que acontecer primeiro.
- Não. Este não é um plano freemium. Esse é o padrão.
Volume freemium O volume de transações (ou volume referente a um atributo personalizado registrado em a política de registro de transações) para o qual os desenvolvedores são cobrados. O volume é medido em todos os produtos do pacote de API. Insira um número de volume, como 5000. Isso significa que, quando os desenvolvedores iniciarem o plano, eles não serão cobrados pelas primeiras 5.000 transações (ou pelos primeiros 5.000 usos de um item relacionado a um atributo personalizado). Esse campo só será ativado se você selecionar "Por quantidade" ou "O que acontecer primeiro" em no campo "Pacote freemium?".
Duração freemium O intervalo de tempo durante o qual os desenvolvedores não são cobrados. Insira um número e selecione um período, por exemplo, 1 mês. Isso significa que os desenvolvedores não serão cobrados por um mês após a data de início do plano comprado. Esse campo só será ativado se você selecionar "Por duração" ou "O que acontecer primeiro" no campo "Pacote freemium?".
Como configurar um plano freemium para um plano de taxas usando a API
É possível adicionar um plano freemium ao criar ou atualizar o plano de taxas. Você especifica as propriedades freemium no corpo da solicitação da chamada.
Por exemplo, a solicitação a seguir cria um plano de taxas padrão com um período de duração freemium de 30 dias. As especificações relacionadas ao freemium sã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
Para especificar uma quantidade baseada em freemium (como o número de transações envolvendo o pacote de API ou o volume referente a um atributo personalizado registrado na política de registro de transações ), especifique-o como um número de unidades freemium. Por exemplo, a atribuição de propriedade a seguir especifica que o freemium é baseado em 5.000 unidades freemium:
"freemiumUnit": "5000"
Consulte as configurações de configuração do plano de taxas para uma lista completa de opções de plano de taxas.