ここに表示されているのは Apigee Edge のドキュメントです。
Go to the
Apigee X のドキュメントに移動します。 info
収益化の上限を適用するには、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 プロキシを作成するときに収益化がインストールされている場合は、ウィザードに [Monetization configuration] セクションが表示されます。
エッジ
ウィザードの [Common policies] ページで、[Enforce monetization limits] チェックボックスをオンにして、Monetization Limits Check ポリシーを接続します。
ウィザードの [Summary] ページにポリシーの概要が表示されます。Monetization ポリシーが表示されていることを確認します。これは、以下で説明するように、Monetization Limits Check ポリシーが API プロキシに接続されることを示しています。
Classic Edge（Private Cloud）
ウィザードの [Security] ページで、[Enable Monetization Limits Check] チェックボックスをオンにして、 Monetization Limits Check ポリシーを接続します。
次の図に示すように、Monetization Limits Check ポリシーが VerifyAPIKey ポリシーまたは AccessTokenValidation ポリシーの後に ProxyEndpoint リクエスト PreFlow に追加されます。
作成済みの API プロキシに Monetization Limits Check ポリシーを追加するには:
- API プロキシ エディタで、デフォルトのプロキシ エンドポイントの [PreFlow] をクリックします。
- [Request flow] で、[+Step] をクリックします。
- [Mediation] カテゴリで [Monetization Limits Check] を選択します。
- [Add Step] ダイアログで、必要に応じてフィールドを変更し、[Add] をクリックします。
ポリシーは、VerifyAPIKey ポリシーまたは AccessTokenValidation ポリシーの後のリクエスト フローに接続され、クライアント アプリから ProxyEndpoint PreFlow へのリクエスト メッセージに適用されます。
MonetizationLimitsCheck ポリシーの XML ファイルの構成の詳細については、 MonetizationLimitsCheck ポリシーをご覧ください。