設定費率方案的限制通知

您正在查看 Apigee Edge 說明文件。
查看 Apigee X 說明文件。 資訊

當開發人員接近或即將購買的磁碟區、套裝組合價目表方案達到特定上限時，您可以透過電子郵件通知開發人員。舉例來說，如果開發人員購買的是套裝組合中含 1,000 次呼叫的按用量計費方案，當開發人員呼叫 800 次 (用量為 80%) 或 API 呼叫花費 $500 美元時，系統就會通知對方。

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

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

自訂通知範本

以下範例說明如何自訂要用來通知開發人員的通知範本。詳情請參閱使用 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

設定通知條件和動作

使用 API 設定通知條件和動作，詳情請參閱使用 API 設定通知條件和動作。

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

• RATEPLAN - 要傳送的通知類型。
• PUBLISHED - 將這個屬性設為 TRUE，即可觸發已發布的房價方案通知。

然後指定下列其中一個屬性：

• Transactions - 交易次數。例如，開發人員可在交易次數達 800 次時通知開發人員。必須為整數值，且只能使用 > 和 = 運算子。
• FeeExposure：交易時累積的金額或點數。必須為整數值，且只能使用 > 和 = 運算子。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