API プロキシに収益化の上限を適用する

このページは Apigee と Apigee ハイブリッドに適用されます。

Apigee Edge のドキュメントを表示する。

このページでは、収益化された API プロダクトの API プロキシにポリシーを接続して、収益化の上限を適用する方法について説明します。

認証ポリシーを追加する

Apigee Monetization では、VerifyAPIKey ポリシーまたは OAuth2 ポリシーの VerifyAccessToken オペレーションを使用してアクティブな公開料金プランを確認することで、受信リクエストが収益化可能かどうかを確認します。

Apigee UI または API を使用して、ポリシーを API プロキシに接続します。プロキシの編集については、API プロキシの編集をご覧ください。

関連情報:

API プロダクトに対するデベロッパー サブスクリプションを適用する

API プロダクトにデベロッパー サブスクリプションを適用するには、API プロキシに MonetizationLimitsCheck ポリシーを接続します。

  • プロキシ呼び出しの実行時に取得された API プロダクトに収益化料金プランが存在しない場合は、そのプロダクトは収益化されていないとみなされ、MonetizationLimitsCheck ポリシーはそれ以上のデータを取得しないため、このポリシーによる影響はありません。
  • 料金プランは見つかったが、API デベロッパーのサブスクリプションが見つからなかった場合、MonetizationLimitsCheck ポリシーによって障害が発生し、API 呼び出しがブロックされます。

MonetizationLimitsCheck ポリシーを API プロキシに接続すると、MonetizationLimitsCheck ポリシーのデバッグと mint フロー変数のリファレンスで説明されているように、mint.limitscheck.* と mint.subscription_* のフロー変数に値が代入されます。

詳しくは以下をご覧ください。

API プロキシに収益化の割り当てを適用する

割り当ては、特定の期間に API プロダクトで許可されるリクエストの数を定義します。収益化に割り当てを適用するには、API プロダクトを作成するときに割り当て値を設定することをおすすめします。

API プロダクトに割り当て値を定義しても、API プロダクトで実行できる呼び出し回数の制限は自動的には適用されません。また、API プロダクトで参照される API プロキシに Quota ポリシーを追加して、API プロダクト レベルで定義された割り当て値が適用されるようにする必要があります。

Quota ポリシーを編集して <UseQuotaConfigInAPIProduct> 要素を有効にして、API プロダクト レベルで定義された割り当て構成を使用します。

次に例を示します。

<Quota continueOnError="false" enabled="true" name="impose-quota">
    <DisplayName>Impose Quota</DisplayName>
    <UseQuotaConfigInAPIProduct stepName="verify-api-key">
        <DefaultConfig>
            <Allow>10000</Allow>
            <Interval>1</Interval>
            <TimeUnit>week</TimeUnit>
        </DefaultConfig>
    </UseQuotaConfigInAPIProduct>
    <Distributed>true</Distributed>
    <Synchronous>true</Synchronous>
    <StartTime>2021-01-01 12:00:00</StartTime>
</Quota>

Quota ポリシーを API プロキシに接続すると、ratelimit.* フロー変数に値が入力されます。詳細については、Quota ポリシーのデバッグと Quota ポリシーのフロー変数リファレンスをご覧ください。

詳しくは以下をご覧ください。