Configurare una notifica di limite per un piano tariffario

Stai visualizzando la documentazione di Apigee Edge.
Vai alla documentazione di Apigee X. informazioni

Puoi informare gli sviluppatori via email quando si avvicinano o hanno raggiunto un determinato limite di un piano tariffario con fasce di volume o bundle che hanno acquistato. Ad esempio, se gli sviluppatori acquistano un piano con banda di volume con 1000 chiamate in un bundle, puoi inviare una notifica quando raggiungono 800 chiamate (80% di utilizzo) o quando hanno speso 500 $in chiamate API.

Per impostare una notifica di limitazione per un piano tariffario utilizzando l'API:

1. Personalizza il modello di notifica che verrà utilizzato per inviare la notifica allo sviluppatore.
2. Configura la condizione e l'azione di notifica.

Personalizzazione del modello di notifica

Di seguito è riportato un esempio di come personalizzare il modello di notifica che verrà utilizzato per la notifica allo sviluppatore. Per maggiori informazioni, consulta Gestire i modelli di notifica utilizzando l'API.

$ curl -H "Content-Type: application/json " -X POST -d \    
'{
    "name": "RATE_PLAN_LIMIT_TEMPLATE",
    "subject": "Nearing your rate plan limit",
    "htmlImage": "<p>Hi ${developer.name} - Wanted to let you know that you have used 800 API calls from your ${ratePlan.displayName} rate plan, which started on ${ratePlan.startDate} under the ${ratePlan.monetizationPackage.displayName} package and ${ratePlan.monetizationPackage.products.displayName} product. Just a friendly reminder that your API calls will be charged double after you cross 1000 calls. Thanks for using the API!</p>",
    "source": "Postman API call"
    }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/notification-email-templates" \
    -u email:password

Configurazione della condizione e dell'azione di notifica

Configura una condizione e un'azione di notifica utilizzando l'API, come descritto in Configurare condizioni e azioni di notifica utilizzando l'API.

Per attivare la notifica relativa a un limite del piano tariffario, imposta i seguenti attributi:

• RATEPLAN - Tipo di notifica da inviare.
• PUBLISHED - Imposta questo attributo su TRUE per attivare le notifiche sui piani tariffari pubblicati.

Quindi, specifica uno dei seguenti attributi:

• Transactions: numero di transazioni. Ad esempio, invia una notifica agli sviluppatori quando raggiungono 800 transazioni. Deve essere un valore intero e sono consentiti solo gli operatori > e =.
• FeeExposure: importo dei dollari o dei punti accumulati sulle transazioni. Deve essere un valore intero e sono consentiti solo gli operatori > e =. FeeExposure non include gli importi dei costi di configurazione, ricorrenti o di recesso. Ad esempio, avvisa gli sviluppatori quando il costo delle loro transazioni API raggiunge 500 $. I calcoli di FeeExposure variano a seconda dell'aliquota fiscale.

Il seguente payload attiva una notifica via email quando il numero di transazioni raggiunge 800:

$ curl -H "Content-Type:application/json" -X POST -d \
    '{
    "notificationCondition": [
      {
        "attribute": "RATEPLAN",
        "value": "{RATE_PLAN_ID}"
      },
      {
        "attribute": "PUBLISHED",
        "value": "TRUE"
      },
      {
        "attribute": "Transactions",
        "value": "= 800"
      }     
    ],
   "actions": [{
          "actionAttribute": "DEV_ID",
          "value": "ANY",
          "templateId": "{EMAIL_TEMPLATE_ID}"
        }]
  }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-conditions" \
    -u email:password