料金プランの上限通知を設定する

<ph type="x-smartling-placeholder"></ph> 現在、Apigee Edge のドキュメントが表示されています。
Apigee X のドキュメント
詳細

一定の上限に近づいたときや達したときに、メールでデベロッパーに通知できます 購入済みのボリューム バンド プランまたはバンドル 料金プランの 1 つである。たとえば開発者が 1,000 件の通話を 1 つのバンドルとしてまとめたボリューム バンド プランを購入すると、通話数が 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 を使用して通知の条件とアクションを設定します。 通知条件とアクションをご覧ください。

料金プランの上限の通知をトリガーするには、次の属性を設定します。

  • RATEPLAN - 送信する通知のタイプ。
  • PUBLISHED - 次の場合に通知をトリガーするには、この属性を TRUE に設定します。 公開料金プラン

次に、次のいずれかの属性を指定します。

  • Transactions - トランザクション数。たとえば、Google Cloud のインフラストラクチャ 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