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

Apigee Edge のドキュメントを表示しています。
Apigee X のドキュメントをご確認ください
情報

購入したボリューム バンドまたはバンドルのレート表のプランが一定の上限に近づいたか、または上限に近づいたときに、デベロッパーにメールで通知できます。たとえば、デベロッパーが 1,000 回の呼び出しで 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