Apigee Edge のドキュメントを表示しています。
Apigee X のドキュメントに移動します。 情報
デベロッパーが購入したボリューム バンドまたはバンドル料金プランの特定の制限に近づいた場合や、その制限に達した場合に、メールでデベロッパーに通知できます。たとえば、デベロッパーが 1,000 回の呼び出しをバンドルしたボリューム バンド プランを購入した場合、800 回の呼び出し（使用率 80%）に達したときや、API 呼び出しに 500 ドルを費やしたときに通知できます。
API を使用して料金プランの制限通知を設定する手順は次のとおりです。
- デベロッパーへの通知に使用される通知テンプレートをカスタマイズします。
- 通知の条件とアクションを構成します。
通知テンプレートのカスタマイズ
以下に、デベロッパーへの通知に使用される通知テンプレートをカスタマイズする方法の例を示します。詳細については、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