Configurar plano de notificação ajustável

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

Introdução

Em um plano de notificação ajustável, o provedor de API pode ajustar o número de transações desejado para cada desenvolvedor de app. É possível configurar se e quando as notificações são enviadas com base no momento em que uma porcentagem do número de destino é alcançada, como 90%, 100% ou 150%. As transações adicionais não são bloqueadas depois que o número de destino é alcançado.

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

Configure planos de notificação ajustáveis, conforme descrito abaixo.

Como configurar um plano de notificação ajustável usando a API

Especifique os detalhes do plano de notificação ajustável na propriedade ratePlanDetails do corpo da solicitação em uma solicitação POST para /organizations/{org_name}/monetization-packages/{package_id}/rate-plans.

Para especificar um plano de notificação ajustável, especifique os seguintes valores no ratePlanDetails do corpo da solicitação:

Propriedade	Valor
type	Defina como USAGE_TARGET.
meteringType	Defina como DEV_SPECIFIC.
duration	Defina o período da base de agregação, com durationType. Para planos de taxa de notificação ajustável, defina um valor inteiro entre 1 e 24.
durationType	Defina o período de tempo para a base de agregação com durationType. Para planos de taxa de notificação ajustável, defina esse valor como MONTH.

Para mais informações sobre as propriedades de configuração que podem ser definidas ao especificar detalhes do plano de notificação ajustável, consulte Configurações de detalhes do plano de preços.

Por exemplo, o exemplo a seguir define um plano de notificação ajustável com uma base de agregação definida como 1 mês.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "AdjustableNotification",
     "displayName": "Adjustable notification plan",
     "description": "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": "VOLUME",
           "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

Como definir o número de transações desejado para cada desenvolvedor de app que usa a API

É possível definir o número de transações de destino para um desenvolvedor de apps quando ele aceita o plano de preços e atualizar o valor mais tarde.

Como definir o número de transações desejado ao aceitar o plano de tarifas

Ao aceitar o plano de tarifas, para definir o número de transações desejado, especifique a propriedade quotaTarget no corpo da solicitação em uma solicitação POST para o recurso /organizations/{org_name}/developers/{developer_id}/developer-rateplans. Defina quotaTarget como um número inteiro positivo ou 0 para desativar as notificações do desenvolvedor do app. Se não for especificado, o padrão de quotaTarget será 0.

Por exemplo, a solicitação a seguir define o número de transações de destino como 4.000 quando o desenvolvedor do app aceita o plano de notificação ajustável.

$ curl -H "Content-Type:application/json" -X POST -d \
'{ 
   "developer":{
     "id":"dev@mycompany.org"
   },
   "ratePlan":{
     "id":"p1_adjustable-notification-plan"
   },
   "startDate": "2016-03-24 00:00:00",
   "quotaTarget": 4000,
   "suppressWarning": false
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans" \
-u email:password

Como definir o número de transações desejado ao atualizar o plano de tarifas aceito

Para definir o número de transações desejado, atualize o plano de taxas aceito e especifique a propriedade quotaTarget no corpo da solicitação em uma solicitação PUT para o recurso /organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id}. Defina quotaTarget como um número inteiro positivo ou 0 para desativar as notificações do desenvolvedor do app. Se não for especificado, quotaTarget será 0 por padrão.

O {developer_rateplan_id} é retornado na resposta quando você aceita o plano de tarifas publicado.

Exemplo:

{
  "created": "2016-03-31 18:59:54",
  "developer": {
    ...
  },
  "id": "b1c600b8-f871-496d-8173-12b9950d6ab1",
  "quotaTarget": 3000,
  "ratePlan": {
    ...
  },
  "startDate": "2016-03-31 00:00:00",
  "updated": "2016-03-31 18:59:54",
  "waiveTerminationCharge": false
}

Se preferir, você pode receber o {developer-rateplan-id} do plano de tarifas do desenvolvedor emitindo uma solicitação GET para /organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans, em que {developer_id} é o endereço de e-mail do desenvolvedor. Para mais informações, consulte Como conferir todos os planos de taxas aceitos por um desenvolvedor.

Exemplo:

{
  "developerRatePlan": [
    {
      "created": "2016-03-31 14:52:30",
      "developer": {
        ...
      },
      "id": "b1c600b8-f871-496d-8173-12b9950d6ab1",
      "quotaTarget": 3000,
      "ratePlan": { 
        ... 
      }, 
      "startDate": "2016-03-31 00:00:00", 
      "updated": "2016-03-31 18:59:54" 
    } 
  ], 
  "totalRecords": 1 
}
        

A solicitação a seguir atualiza o número de transações de destino para 4.000.

email:password