Configurare una notifica di limite per un piano tariffario

Stai visualizzando la documentazione di Apigee Edge.
Vai alla sezione Documentazione di Apigee X. Informazioni

Puoi informare gli sviluppatori via email quando stanno per raggiungere o hanno raggiunto un determinato limite di un piano tariffario a banda larga o bundle che hanno acquistato. Ad esempio, se gli sviluppatori acquistare un piano a banda larga con 1000 chiamate in un pacchetto, puoi avvisarle quando raggiungono 800 chiamate (80% di utilizzo) o se hanno speso 500 $in chiamate API.

Per configurare una notifica di limite per un piano tariffario utilizzando l'API:

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

Personalizzazione del modello di notifica

Di seguito viene fornito un esempio di come personalizzare il modello di notifica che verrà utilizzata per inviare una notifica allo sviluppatore. Per ulteriori informazioni, vedi Gestione modelli di notifica mediante 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 le condizioni e le azioni di notifica mediante 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 su piani tariffari pubblicati.

Quindi, specifica uno dei seguenti attributi:

• Transactions: numero di transazioni. Ad esempio, avvisa gli sviluppatori quando raggiunge 800 transazioni. Deve essere un valore intero e solo > Gli operatori and = sono consentito.
• FeeExposure: importo in dollari o punti accumulati per le transazioni. Deve essere un valore intero e solo > e =. FeeExposure non include gli importi delle spese di configurazione, ricorrenti o di recesso. Ad esempio, invia una notifica agli sviluppatori quando il costo delle transazioni API raggiunge 500 $. Calcoli FeeExposure variano a seconda dell'aliquota fiscale.

Il seguente payload attiva una notifica via email quando il numero di transazioni raggiunge [Codice del corso]:

$ 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