Configurar plano de tarifa com atributos personalizados

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

Introdução

Em alguns casos, talvez seja necessário que os contadores de transações sejam baseados em uma variável ou valor personalizado. Por exemplo, você pode precisar:

• Cobrar dos desenvolvedores um valor variável com base em um valor fornecido na mensagem de uma chamada de API Por exemplo, talvez você queira cobrar dos desenvolvedores de apps com base no número de bytes transmitidos na solicitação de API.
• Agrupar várias chamadas de API em uma única transação.

Usando planos de tarifas com atributos personalizados, é possível identificar um valor na mensagem de uma chamada de API que atua como contador e que é usado para calcular contagens e cobranças de transações.

Os seguintes planos de tarifas com atributos personalizados são aceitos:

• Tabela de preços com atributo personalizado
• Notificação ajustável com atributo personalizado

É possível definir um máximo de dez atributos personalizados por plano de tarifas.

Entender os cálculos de atributos personalizados

A forma como o valor do atributo personalizado é considerado nas contagens e cobranças de transações do plano de tarifas depende do modelo de cobrança, conforme resumido na tabela a seguir.

Onde o plano de tarifas recebe o valor do atributo personalizado

A política de gravação de transações (no pacote de produtos de API) informa à monetização onde procurar o valor do atributo personalizado na mensagem. Você define o atributo personalizado na seção "Atributos personalizados" da política de gravação de transações para o pacote de produtos de API.

Em seguida, é possível selecionar esse atributo personalizado no plano de tarifas depois de criar um pacote de produtos de API que contenha a política de gravação de transações com o atributo personalizado definido.

Confira o fluxo de alto nível:

1. Defina os atributos personalizados ao adicionar um produto de API.
2. Crie um pacote de produtos de API que contenha o produto.
   Na política de gravação de transações para o pacote de produtos de API, adicione os atributos personalizados que serão usados para definir planos de tarifas.
3. Crie um plano de tarifas do tipo tabela de preços ou notificação ajustável para o pacote de produtos de API e especifique um parâmetro de classificação personalizado.

A figura a seguir mostra a relação entre o atributo personalizado definido na política de gravação de transações e a configuração do plano de tabela de preços. A relação do plano de tarifas de notificação ajustável com atributo personalizado é semelhante, embora o valor da faixa de volume não seja aplicável.

Como gerar o valor do atributo personalizado na mensagem

A política de gravação de transações pode procurar o valor do atributo personalizado em vários lugares, como o cabeçalho de resposta, o corpo da resposta ou as variáveis de fluxo predefinidas na resposta. A solicitação não está disponível porque uma transação não é oficial até que você receba uma resposta bem-sucedida . A seguir, mostramos exemplos de como adicionar um cabeçalho de resposta com o valor numérico à mensagem. Nos dois casos, vamos usar a política "Atribuir mensagem" em conjunto com variáveis.

Como adicionar o tamanho do payload da solicitação ao cabeçalho da resposta

Em cada solicitação de mensagem, há uma variável client.received.content.length que contém o número de bytes no payload da solicitação. Ao anexar uma política "Atribuir mensagem" à resposta do endpoint do proxy, podemos gerar um cabeçalho de resposta chamado messageSize que contém o valor do comprimento:

<AssignMessage async="false" continueOnError="false" enabled="true" name="Assign-Message-1">
    <DisplayName>Assign Message 1</DisplayName>
    <Set>
        <Headers>
          <Header name="messageSize">{client.received.content.length}</Header> 
        </Headers>  
    </Set>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

Como adicionar um valor de atributo personalizado do app ao cabeçalho

Da mesma forma, podemos gerar um cabeçalho com o valor de um atributo personalizado em um app. Por exemplo, se você incluir um atributo personalizado chamado apprating em cada app de desenvolvedor da seguinte maneira:

Ao usar a política "Verificar chave de API" (necessária para a monetização), esse valor é armazenado em uma variável chamada verifyapikey.{policy_name}.apprating. Usando a política "Atribuir mensagem" anexada à resposta do endpoint do proxy, é possível gerar um cabeçalho chamado apprating que contém o valor apprating do app:

<AssignMessage async="false" continueOnError="false" enabled="true" name="Assign-Message-1">
    <DisplayName>Assign Message 1</DisplayName>
    <Set>
        <Headers>
          <Header name="apprating">{verifyapikey.Verify-API-Key-1.apprating}</Header> 
        </Headers>  
    </Set>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

Como configurar o plano de tarifas

Além da configuração de atributos personalizados descrita acima, o plano de tarifas é configurado da mesma forma que você faria normalmente (para planos de tarifas sem atributos personalizados), mas precisa obedecer aos seguintes requisitos.

Como configurar o plano de tabela de preços com atributo personalizado usando a interface

Configure planos de tabela de preços com atributos personalizados usando a interface do Edge ou a interface clássica do Edge, conforme descrito nas seções a seguir.

Como configurar um plano de notificação ajustável com atributos personalizados usando a interface

Como especificar detalhes de um plano de tarifas com atributos personalizados usando a API

Siga estas etapas de pré-requisito:

1. Na política de gravação de transações de um produto de API, adicione os atributos personalizados que serão usados para definir planos de tarifas. Para mais detalhes, consulte a introdução neste tópico e Criar uma política de gravação de transações. Faça isso para cada produto de API que você quer incluir no pacote de API.
2. Depois que os produtos de API e as políticas de gravação de transações forem configurados exatamente da maneira que você deseja, crie um pacote de API que contenha o produto. Consulte Criar pacotes de API.

Em seguida, use a API para criar o plano de tarifas.

Você especifica detalhes de um plano de tarifas com atributos personalizados ao criar o plano de tarifas. Especifique os detalhes na propriedade ratePlanDetails no corpo da solicitação em uma chamada para /organizations/{org_name}/monetization-packages/{package_id}/rate-plans. Nos detalhes, especifique um valor de parâmetro de classificação que identifique o nome do atributo personalizado. Também é possível especificar um valor de parâmetro de classificação que agregue o atributo personalizado em um intervalo de tempo especificado.

Consulte Detalhes do plano de tarifas configurações para uma lista completa de opções de detalhes do plano de tarifas.

Por exemplo, o seguinte cria um plano de tabela de preços com atributo personalizado com base em um atributo personalizado chamado messageSize (consulte os itens em negrito).

$ curl -H "Content-Type:application/json" -X POST -d \
'{
   "name": "Custom attribute-based rate card plan",
   "developer":null,
   "developerCategory":null,
   "currency": {
     "id" : "usd"
     },     
   "description": "Custom attribute-based rate card plan",
   "displayName" : "Custom attribute-based rate card plan",
   "frequencyDuration": "1",
   "frequencyDurationType": "MONTH",
   "earlyTerminationFee": "10",
   "monetizationPackage": {
      "id": "location"
        },
      "organization": {
       "id": "{org_name}"
      },    
   "paymentDueDays": "30",
   "prorate": "false",
   "published": "false",     
   "ratePlanDetails":[
      {
        "currency":{
           "id":"usd"
        },
      "duration":1,
      "durationType":"MONTH",
      "meteringType":"VOLUME",
      "paymentDueDays":"30",
      "ratingParameter":"messageSize",
      "ratingParameterUnit":"MB",
      "organization":{
         "id":"{org_name}"
      },
      "ratePlanRates":[
         {
           "rate":0.15,
           "startUnit":0,
           "type":"RATECARD",
           "endUnit":1000
         },
         {
           "rate":0.1,
           "startUnit":1000,
           "type":"RATECARD",
           "endUnit":null
         }
      ],
      "freemiumUnit":0,
      "freemiumDuration":0,
      "freemiumDurationType":"MONTH",
      "type":"RATECARD",
      "customPaymentTerm":false
      }
    ],
    "freemiumUnit":0,
    "freemiumDuration":0,
    "freemiumDurationType":"MONTH",
    "contractDuration":"1",
    "contractDurationType":"YEAR", 
    "recurringStartUnit": 1,
    "recurringType": "CALENDAR",
    "recurringFee": "10",
    "setUpFee": "10",
    "startDate": "2013-09-15 00:00:00",
    "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

O seguinte cria um plano de tarifas de notificação ajustável com atributo personalizado com base em um atributo personalizado chamado messageSize (consulte o item em negrito).

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "AdjustableNotification",
     "displayName": "Custom attribute-based adjustable notification plan",
     "description": "Custom attribute-based adjustable notification plan",
     "published": "true",  
     "organization": {
      "id": "myorg"
     },
     "startDate": "2016-04-15 00:00:00",
     "type": "STANDARD",
     "monetizationPackage": {
        "id": "p1",
        "name": "test"
     },
     "currency": {
        "id" : "usd",
        "name" : "USD"
     },
     "ratePlanDetails": [
        {
           "type": "USAGE_TARGET",
           "meteringType": "DEV_SPECIFIC",
           "duration": 1,
           "durationType": "MONTH",
           "ratingParameter": "messageSize",
           "ratingParameterUnit": "MB",
           "organization": {
             "id": "myorg"
           },
           "currency": {
             "id": "usd",
             "name": "USD"
           }
        }
     ]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/p1/rate-plans"  \
-u email:password