設定費率方案的限制通知

查看 Apigee Edge 說明文件。
前往 Apigee X說明文件。 資訊

您可以在開發人員即將達到或達到特定上限時，透過電子郵件通知開發人員 已購買的是系列書籍或套裝組合價目表方案。舉例來說 購買內含 1,000 通來電的音量頻帶方案，即可在通話對象撥打時通知他們 800 次呼叫 (用量 80%)，或是 API 呼叫已支出 $500 美元。

如要使用 API 為費率方案設定限制通知，請按照下列步驟操作：

  1. 自訂要使用的通知範本 通知開發人員。
  2. 設定通知條件和動作。

自訂通知範本

以下範例說明如何自訂通知範本 通知開發人員如需詳細資訊，請參閱管理 通知範本

$ 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

設定通知條件和動作

按照設定 通知條件及使用 API 採取的動作。

如要觸發費率方案限制的通知，請設定下列屬性：

  • RATEPLAN - 要傳送的通知類型。
  • PUBLISHED - 請將這項屬性設為 TRUE，才能在以下時間觸發通知： 包括已發布的費率方案

接著，指定下列其中一個屬性：

  • Transactions - 交易次數。舉例來說，通知開發人員 他們完成 800 筆交易須為整數值，且只能大於 >和 = 運算子 。
  • FeeExposure - 交易金額或累積的點數。必須為 整數值，且僅限 >and = 運算子可以使用，FeeExposure 不包含設定、週期性或終止服務費用的金額。例如通知開發人員 API 交易成本達 $500 美元時計算FeeExposure 會因稅率而異。
，瞭解如何調查及移除這項存取權。

下列酬載會在交易次數達到時觸發電子郵件通知 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