Configurar plano de notificação ajustável

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

Introdução

Em um plano de notificação ajustável, o provedor da API pode ajustar o número desejado de transações para cada desenvolvedor de apps. Você pode configurar se e quando as notificações são enviadas com base quando uma porcentagem do número desejado é alcançada, como 90%, 100% ou 150%. Adicional transações não são bloqueadas depois que o número desejado é atingido.

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 no corpo de 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 campo ratePlanDetails do corpo da solicitação:

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 Detalhes do plano de tarifação de configuração do Terraform.

Por exemplo, o código a seguir define um plano de notificação ajustável com uma base de agregação. definido 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 a meta número de transações para cada desenvolvedor de apps que usam a API

É possível definir o número pretendido de transações para um desenvolvedor de apps quando ele aceita para o plano de tarifação, e será possível atualizar o valor depois.

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

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

Por exemplo, a solicitação a seguir define o número de destino de transações como 4.000 quando o aplicativo o desenvolvedor aceitar 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 desejado de transações ao atualizar o plano de tarifas aceito

Para definir o número desejado de transações, atualize o plano de tarifas aceito e especifique propriedade quotaTarget no corpo da solicitação em uma solicitação PUT para o /organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id} recurso. Defina quotaTarget como um número inteiro positivo ou 0 para desativar notificações para o 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
}

Como alternativa, você pode consultar o {developer-rateplan-id} da taxa de desenvolvedor plano 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 Visualizar todos os planos de tarifas aceitos pelo 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 destino de transações para 4.000.

$ curl -H "Content-Type:application/json" -X PUT -d
{ 
   "id" : "b1c600b8-f871-496d-8173-12b9950d6ab1",
   "developer":{
     "id":"dev@minhaempresa.com"
   },
   "ratePlan":{
     "id":"p1_adjustable-notification-plan"
   },
   "startDate": "2016-04-15 00:00:00",

   "quotaTarget": 4000,
   "suppressWarning":false
}" .
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/b1c600b8-f871-496d-8173-12b9950d6ab1"
email:password