API プロキシに対して収益化による制限を適用する

Apigee Edge のドキュメントが表示されています。
Apigee X のドキュメントに移動します。 情報

Monetization Limits Check ポリシーを API プロキシに接続して、収益化の上限を適用します。具体的には、このポリシーは次の条件でトリガーされます。

• 収益化された API にアクセスしているデベロッパーが登録されていないか、料金プランに登録していない。
• デベロッパーが登録した料金プランのトランザクション量を超過している。
• デベロッパーの前払いアカウント残高または後払いクレジット限度額に達しました。

Monetization Limits Check ポリシーは、上記のような状況で障害を発生させ、API 呼び出しをブロックするように設計されています。このポリシーは Raise Fault ポリシーを拡張したもので（Raise Fault ポリシーを参照）、返されるメッセージをカスタマイズできます。適用可能な条件はビジネス変数から導出されます。

UI を使用して収益化の上限チェック ポリシーを適用する

収益化の上限を適用するには、API にアクセスする API プロキシのリクエスト フローに Monetization Limits Check ポリシーを接続する必要があります。収益化上限チェック ポリシーは、リクエスト内の VerifyAPIKey ポリシーまたは AccessTokenValidation ポリシーの後にアタッチする必要があります。

収益化上限チェック ポリシーは、API プロキシの作成時または作成後に接続できます。

シンプルな API プロキシをビルドするで説明されているように、API プロキシを作成するときに、収益化がインストールされていると、ウィザードに [Monetization configuration] セクションが表示されます。

次の図に示すように、Monetization Limits Check ポリシーは、VerifyAPI Key ポリシーまたは AccessTokenValidation ポリシーの後に、ProxyEndpoint リクエスト PreFlow に追加されます。

すでに作成されている API プロキシに Monetization Limits Check ポリシーを追加するには:

1. API プロキシ エディタで、デフォルトのプロキシ エンドポイントの [PreFlow] をクリックします。
   
2. [Request flow] で、[+Step] をクリックします。
3. [メディエーション] カテゴリで [収益化の上限チェック] を選択します。

   

4. [ステップを追加] ダイアログで、必要に応じてフィールドを変更し、[追加] をクリックします。

このポリシーは、VerifyAPI Key ポリシーまたは AccessTokenValidation ポリシーの後にリクエスト フローに接続され、クライアント アプリから ProxyEndpoint PreFlow へのリクエスト メッセージに適用されます。

MonetizationLimitsCheck ポリシーの XML ファイルの構成について詳しくは、MonetizationLimitsCheck ポリシーをご覧ください。