Apigee Edge のドキュメントを表示しています。
Apigee X のドキュメントに移動。 情報
収益化制限を適用するには、API プロキシに Monetization Limits Check ポリシーを接続します。具体的には、このポリシーは次の条件の下でトリガーされます。
- 収益化対象の API を利用するデベロッパーが登録されていないか、料金プランに加入していない。
- デベロッパーが、定期購入した料金プランのトランザクション ボリュームを超過した。
- デベロッパーの前払いアカウント残高に達したか、後払い利用限度額に達した。
Monetization Limits Check ポリシーは、上記のような状況が発生したときに障害を発生させ、API 呼び出しをブロックするように設計されています。このポリシーは Raise Fault ポリシー（Raise Fault ポリシー を参照）を拡張し、返されるメッセージをカスタマイズできます。適用可能な条件はビジネスに関する変数から導き出されます。
UI を使用して Monetization Limits Check ポリシーを接続する
収益化制限を適用するには、API にアクセスする API プロキシのリクエストフローに Monetization Limits Check ポリシーを接続する必要があります。Monetization Limits Check ポリシーは、リクエスト内の VerifyAPIKey ポリシーまたは AccessTokenValidation ポリシーの後に接続する必要があります。
Monetization Limits Check ポリシーは、API プロキシの作成時または API プロキシの作成後に接続できます。
シンプルな API プロキシを作成するで説明されているように、API プロキシを作成するときに収益化がインストールされている場合、ウィザードの [収益化の構成] セクションが表示されます。
Edge
ウィザードの [Common policies] ページで、[Enforce monetization limits] チェックボックスをオンにして、Monetization Limits Check ポリシーを適用します。
ウィザードの [Summary] ページに、ポリシーの概要が表示されます。以下に示すように、Monetization Limits Check ポリシーが API プロキシにアタッチされることを示す Monetization ポリシーが表示されていることを確認します。
Classic Edge（Private Cloud）
ウィザードの [セキュリティ] ページで、[収益化制限チェックを有効にする] チェックボックスをオンにして、収益化制限チェック ポリシーを接続します。
次の図に示すように、Monetization Limits Check ポリシーは、ProxyEndpoint リクエストの PreFlow に、VerifyAPI Key ポリシーまたは AccessTokenValidation ポリシーの後に追加されます。
すでに作成されている API プロキシに Monetization Limits Check ポリシーを追加するには:
- API プロキシ エディタで、デフォルトのプロキシ エンドポイントの [PreFlow] をクリックします。
- リクエスト フローで、[+Step] をクリックします。
- [メディエーション] カテゴリで [収益化の上限チェック] を選択します。
- [ステップを追加] ダイアログでフィールドを必要に応じて変更し、[追加] をクリックします。
このポリシーは、VerifyAPIKey ポリシーまたは AccessTokenValidation ポリシーの後にリクエスト フローに接続され、クライアント アプリから ProxyEndpoint PreFlow へのリクエスト メッセージに適用されます。
MonetizationLimitsCheck ポリシーの XML ファイルの構成について詳しくは、MonetizationLimitsCheck ポリシーをご覧ください。