API 프록시에서 수익 창출 한도 적용

이 페이지는 Apigee 및 Apigee Hybrid에 적용됩니다.

Apigee Edge 문서 보기

다음 섹션에 설명된 대로 수익 창출 API 제품과 연결된 API 프록시에 정책을 연결하여 수익 창출 한도를 적용합니다.

인증 정책 추가

Apigee 수익 창출은 VerifyAPIKey 또는 VerifyAccessToken 정책을 사용하여, 활성 게시 요금제를 확인하여 수신되는 요청에 대해 수익을 창출할 수 있는지 확인합니다.

다음 방법 중 하나를 사용하여 VerifyAPIKey 정책이나 VerifyAccessToken 정책을 API 프록시에 연결합니다.

  • 프록시 만들기 마법사를 사용하여 API 프록시를 만들 때 일반 정책 페이지의 보안: 승인 섹션에서 API 키나 OAuth 2.0을 선택합니다. 예를 들면 다음과 같습니다.

    API 키가 선택된 프록시 마법사 만들기의 일반 정책 페이지

  • API 프록시를 개발할 때 VerifyAPIKey 정책이나 VerifyAccessToken 정책을 API 프록시 PreFlow의 첫 번째 정책으로 요청 흐름에 연결합니다. 예를 들면 다음과 같습니다.

    PreFlow에 연결된 VerifyAPIKey 정책을 보여주는 API 프록시 편집기의 개발자 탭

자세한 내용은 다음을 참고하세요.

API 제품에 개발자 구독 적용

API 제품에 개발자 구독을 적용하려면 MonetizationLimitsCheck 정책을 API 프록시에 연결하세요. 특히 API에 액세스하는 앱 개발자가 관련 API 제품에 대한 구독을 구매하지 않은 경우 정책이 트리거됩니다. 이 경우 monetizationLimitsCheck 정책은 결함을 유발하고 API 호출을 차단합니다.

프록시 호출 실행 중에 가져온 API 제품에 대한 수익 창출 요금제가 없는 경우 제품은 수익 창출이 아닌 것으로 간주되고 monetizationLimitsCheck 정책은 더 이상 데이터를 가져오지 않으며 정책이 적용되지 않습니다.

MonetizationLimitsCheck 정책 디버깅 및 mint 흐름 변수 참조에 설명된 대로 API 프록시에 MonetizationLimitsCheck 정책을 연결하면 mint.limitscheck.* 및 mint.subscription_* 흐름 변수가 채워집니다.

다음 방법 중 하나로 MonetizationLimitsCheck 정책을 API 프록시에 연결합니다.

  • 프록시 만들기 마법사를 사용하여 API 프록시를 만들 때 다음 그림과 같이 일반 정책 페이지에서 수익 창출 한도 적용을 선택합니다.

    한도 적용 확인이 선택된 프록시 마법사 만들기의 일반 정책 페이지

  • API 프록시를 개발할 때 다음 그림과 같이 API 프록시 PreFlow의 요청 흐름에 VerifyAPIKey 또는 VerifyAccessToken 정책 뒤에 MonetizationLimitsCheckPolicy를 연결합니다.

    PreFlow에서 VerifyAPI 정책 뒤 연결된 MonetizationLimitsCheck 정책을 보여주는 API 프록시 편집기의 개발자 탭

자세한 내용은 다음을 참고하세요.

API 프록시에서 수익 창출 할당량 적용

할당량은 특정 기간 동안 API 제품에 허용되는 요청 수를 정의합니다. 수익 창출을 위해 할당량을 적용하려면 API 제품을 만들 때 할당량 값을 설정하는 것이 좋습니다.

API 제품의 할당량 값을 정의해도 API 제품을 통해 수행할 수 있는 호출 수의 제한이 자동으로 적용되지 않습니다. API 제품 수준에서 정의된 할당량 값이 적용되도록 하려면 API 제품에서 참조하는 API 프록시에 할당량 정책도 추가해야 합니다.

다음 방법 중 하나로 할당량 정책을 API 프록시에 연결합니다.

  • 프록시 만들기 마법사를 사용하여 API 프록시를 만들 때 다음 그림과 같이 일반 정책의 할당량 섹션에서 앱별 할당량 적용을 선택합니다.

    선택한 앱당 할당량을 적용하는 프록시 마법사 만들기의 일반 정책 페이지

  • API 프록시를 개발할 때 다음 그림과 같이 API 프록시 PreFlow의 요청 흐름에 VerifyAPIKey 또는 VerifyAccessToken 정책 뒤에 할당량 정책을 연결합니다.

    PreFlow에 연결된 할당량 정책을 보여주는 API 프록시 편집기의 개발자 탭

할당량 정책을 수정하여 <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>

할당량 정책 디버깅 및 할당량 정책 흐름 변수 참조에 설명된 대로 API 프록시에 할당량 정책을 연결하면 ratelimit.* 흐름 변수가 채워집니다.

자세한 내용은 다음을 참고하세요.