요금제 관리

Apigee Edge 문서를 보고 있습니다.
Apigee X 문서로 이동하세요. info

다음 섹션에 설명된 대로 UI 및 API를 사용하여 요금제를 관리합니다.

요금제 페이지 살펴보기

아래 설명에 따라 요금제 페이지에 액세스합니다.

에지

Edge UI에서 요금제를 확인하려면 요금제 페이지에 액세스하세요.

  1. apigee.com/edge에 로그인합니다.
  2. 왼쪽 탐색 메뉴에서 게시 > 수익 창출 > 요금제를 선택합니다.

요금제 페이지가 표시됩니다.

그림에 강조 표시된 것처럼 요금제 페이지에서 다음을 수행할 수 있습니다.

클래식 에지 (프라이빗 클라우드)

기본 Edge UI를 사용하여 요금제를 보려면 API 패키지 페이지에 액세스하세요.

  1. http://ms-ip:9000에 로그인합니다. 여기서 ms-ip는 관리 서버 노드의 IP 주소 또는 DNS 이름입니다.
  2. 상단 탐색 메뉴에서 게시 > 패키지를 선택합니다.

API 패키지 페이지에는 각 패키지에 정의된 요금제가 표시됩니다.

요금제 페이지에서 다음을 작업을 수행할 수 있습니다.

요금제 만들기

요금제를 만들려면 다음 단계를 따르세요.

  1. 요금제 페이지에 액세스합니다.
  2. +요금제를 클릭합니다.
  3. 상단 패널에서 다음 필드를 구성합니다.
    필드 설명 기본값 필수
    요금제 이름 요금제 이름입니다.

    NOTE: 이름은 API 제품 번들 내에서 고유해야 합니다. 동일한 제품 번들 내의 두 요금제는 이름이 같을 수 없습니다.

    		해당 사항 없음 예
    요금제 유형 요금제 유형입니다. 드롭다운 목록에서 값을 선택합니다. 유효한 요금제 유형 목록은 지원되는 요금제 유형을 참고하세요. 해당 사항 없음 예
    제품 번들 API 제품 번들입니다. 드롭다운 목록에서 값을 선택합니다. API 제품 번들에 대한 자세한 내용은 API 제품 번들 관리를 참고하세요.

    API 제품이 두 개 이상 포함된 제품 번들을 선택하는 경우 각 API 제품에 개별 요금제를 구성할지 아니면 모든 API 제품에 적용되는 일반 요금제를 구성할지 선택해야 합니다.

    		해당 사항 없음 예
    대상 요금제에 액세스할 수 있는 잠재고객입니다. 드롭다운 목록에서 다음 값 중 하나를 선택합니다.
    • 모든 사용자 - 모든 개발자
    • 개발자 - 개발자 또는 회사입니다. 개발자 이름 또는 회사를 입력합니다. 입력과 동시에 문자열을 포함하는 개발자/회사 목록이 드롭다운에 표시됩니다. 드롭다운 목록에서 개발자 또는 회사 이름을 클릭합니다.
    • 개발자 카테고리 - 개발자 카테고리입니다. 드롭다운 목록에서 개발자 카테고리를 선택합니다.

      개발자 카테고리 관리에 설명된 대로 필요에 따라 개발자 카테고리를 구성합니다.

    		 전체 아니요
    시작일 요금제가 적용되는 날짜입니다. 시작일을 입력하거나 캘린더를 사용하여 날짜를 선택합니다. 오늘 아니요
    종료일 요금제가 종료되는 날짜입니다. 종료일을 지정하려면 종료일 있음 전환 스위치를 사용 설정하고 종료일을 입력하거나 캘린더를 사용하여 날짜를 선택합니다.

    참고: 요금제는 지정된 날짜의 하루가 끝날 때까지 적용됩니다. 예를 들어 2018년 12월 1일에 요금제를 만료하려면 endDate 값을 2018-11-30으로 설정해야 합니다. 이 경우 요금제는 2018년 11월 30일이 끝날 때 만료되며 2018년 12월 1일의 모든 요청이 차단됩니다.

    		없음 아니요
    포털에 표시 요금제가 공개인지 비공개인지 설정합니다. 공개 요금제와 특별 요금제 비교를 참고하세요. 사용 설정됨 아니요
  4. 요금제의 요금을 구성합니다. 요금제 요금 구성을 참고하세요.
    NOTE: 조정 가능한 알림 요금제에는 적용되지 않습니다.
  5. API 제품이 두 개 이상 포함된 제품 번들을 선택한 경우 특정 또는 일반 요금제 섹션에서 다음 환경설정을 지정합니다.
    참고: 이 단계는 조정 가능한 알림 요금제에는 적용되지 않습니다.
    필드 설명 기본값
    제품별로 개별적으로 구성 각 API 제품에 대해 개별 요금제를 구성할지 여부를 지정하는 플래그입니다. 사용 중지됨
    각 제품의 무료 체험 혜택을 개별적으로 구성 각 API 제품에 대해 프리미엄 요금제를 구성할지 여부를 지정하는 플래그입니다. 사용 중지됨
    제품 선택 플래그를 하나 또는 두 개 모두 사용 설정하는 경우 드롭다운 목록에서 각 제품을 개별적으로 선택하고 요금제 세부정보를 구성해야 합니다.

    NOTE: 제품 번들에 포함된 모든 제품을 구성해야 합니다.

    		해당 사항 없음
  6. 선택한 요금제 유형에 따라 요금제 세부정보를 구성합니다.
  7. 다음 중 하나를 클릭합니다.
    버튼 설명
    초안으로 저장 요금제를 초안으로 저장합니다.

    요금제는 게시하기 전에는 앱 개발자에게 표시되지 않습니다. 초안 요금제의 모든 필드를 수정할 수 있습니다.

    새 계획 게시 계획을 게시합니다.

    NOTE: 요금제를 게시한 후에는 종료일이 아직 설정되지 않은 경우에만 수정할 수 있습니다. 게시된 요금제는 삭제할 수 없지만 게시된 요금제 만료에 설명된 대로 요금제를 만료하고 향후 요금제로 대체할 수 있습니다.

  8. 요금제에 포함된 API 제품과 연결된 API 프록시에 수익 창출 한도 확인 정책을 연결합니다. 수익 창출 한도 확인 정책은 API 프록시에 수익 창출 한도를 적용하고 분석 및 수익 창출 보고서에 오류가 정확하게 포착되도록 합니다. 자세한 내용은 API 프록시에서 수익 창출 한도 적용을 참고하세요.

요금제 수정

제품 번들, 유형, 잠재고객을 제외한 임시 요금제의 모든 필드를 수정할 수 있습니다. 요금제를 게시한 후에는 종료일이 지정되지 않은 경우에만 종료일을 수정할 수 있습니다.

요금제를 수정하려면 다음 단계를 따르세요.

  1. 요금제 페이지에 액세스합니다.
  2. 수정하려는 요금제의 행을 클릭합니다.
    요금제 패널이 표시됩니다.
  3. 필요에 따라 요금제 필드를 수정합니다.
    NOTE: 요금제를 게시한 후에는 종료일이 아직 설정되지 않은 경우에만 수정할 수 있습니다.
  4. 다음 중 하나를 클릭합니다.
    버튼 설명
    초안 업데이트 (요금제 초안) 요금제를 초안으로 저장합니다.

    요금제는 게시하기 전에는 앱 개발자에게 표시되지 않습니다. 초안 요금제의 모든 필드를 수정할 수 있습니다.
    초안 게시 (초안 요금제) 요금제를 게시합니다.

    NOTE: 요금제를 게시한 후에는 종료일이 아직 설정되지 않은 경우에만 종료일을 수정할 수 있습니다. 게시된 요금제는 삭제할 수 없지만 게시된 요금제 만료에 설명된 대로 요금제를 만료하고 향후 요금제로 대체할 수 있습니다.
    업데이트된 종료일 (게시된 요금제) 게시된 요금제의 종료일을 설정합니다.

    NOTE: 게시된 요금제의 종료일이 설정되면 더 이상 수정할 수 없습니다.

임시 요금제 삭제

더 이상 필요하지 않은 경우 초안 요금제를 삭제합니다.

참고: 게시된 요금제는 삭제할 수 없습니다.

요금제 초안을 삭제하려면 다음 단계를 따르세요.

  1. 요금제 페이지에 액세스합니다.
  2. 삭제하려는 요금제 위에 커서를 이동하여 작업 메뉴를 표시합니다.
  3. 을 클릭합니다.
  4. 삭제를 클릭하여 작업을 확인합니다.

API를 사용하여 요금제 관리

다음 섹션에서는 API를 사용하여 요금제를 관리하는 방법을 설명합니다.

API를 사용하여 요금제 만들기

요금제를 만들려면 /organizations/{org_name}/monetization-packages/{monetizationpackage_id}/rate-plans에 POST 요청을 실행합니다. 여기서 {monetizationpackage_id}은 요금제를 만들 API 제품 번들의 ID입니다 (ID는 API 제품 번들을 만들 때 응답으로 반환됨).

요금제를 만들 때 요청 본문에 다음을 지정해야 합니다.

  • 조직 ID
  • API 제품 번들 ID
  • 요금제 이름
  • 요금제 설명
  • 요금제의 범위 (모든 개발자에게 적용되는지 아니면 특정 개발자, 회사 또는 개발자 카테고리에만 적용되는지)
  • 요금제가 적용되는 날짜
  • 요금제의 통화
  • 요금제를 게시할지 여부
  • 요금제가 공개인지 비공개인지 여부

선택적으로 지정할 수 있는 다른 설정도 있습니다 (예: 30일). 요금제의 구성 속성을 참고하세요.

제품이 두 개 이상인 API 제품 번들에 요금제 (수수료 전용 요금제 제외)를 만드는 경우 제품 번들의 특정 제품에 요금제를 적용할 수 있습니다. 요청에서 제품을 식별하여 이 작업을 실행합니다. 제품을 식별하지 않으면 계획이 API 제품 번들의 모든 제품에 적용됩니다.

다음 섹션에서는 요금제를 만드는 방법을 설명합니다.

API를 사용하여 표준 요금제 만들기

표준 요금제를 만들려면 다음 예와 같이 type 속성을 STANDARD로 설정합니다.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Simple rate plan",
     "currency": {
      "id" : "usd"
     },
     "description": "Simple rate plan",
     "displayName" : "Simple rate plan",
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },
     "published": true,
     "isPrivate" : false,
     "ratePlanDetails": [
     {
      …
     }
     ],
     "startDate": "2013-09-15",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location_package/rate-plans" \
-u email:password

API를 사용하여 개발자 또는 회사 요금제 만들기

특정 개발자 또는 회사에 요금제를 적용하려면 type 값을 Developer로 설정합니다. 또한 요청에서 개발자 또는 회사를 식별해야 합니다. ID, 법적 이름, 개발자 또는 회사 이름을 식별해야 합니다.

예를 들어 다음 발췌문은 Dev Five 개발자의 요금제를 만듭니다.

...
     "type": "DEVELOPER",
       "developer" : {
        "id" : "0mkKu1PALUGfjUph",
        "legalName" : "DEV FIVE",
        "name" : "Dev Five"
      }
...

API를 사용하여 개발자 카테고리 요금제 만들기

개발자 카테고리에 요금제를 적용하려면 type 값을 Developer_Category로 설정합니다. 요청에서 개발자 카테고리도 식별해야 합니다. 예를 들면 다음과 같습니다.

...
     "type": "DEVELOPER_CATEGORY",
       "developerCategory" : {
        "id" : "5e172299-8232-45f9-ac46-40076139f373",
        "name" : "Silver",
        "description" : "Silver category"
      }
...

API를 사용하여 API 제품별 요금제 만들기

여러 API 제품이 포함된 API 제품 번들의 요금제를 만들 때 API 제품별로 요금제 세부정보를 지정할 수 있습니다.

예를 들어 다음은 API 제품이 두 개인 수익 공유 요금제를 만듭니다.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Multi-product rate plan",
     "currency": {
      "id" : "usd"
     },
     "description": "Multi-product rate plan",
     "displayName" : "Multi-product rate plan",
     "monetizationPackage": {
      "id": "mypackage",
      ...
     },
     "organization": {
      "id": "{org_name}",
      ...
     },
     "published": true,
     "isPrivate" : false,
     "ratePlanDetails": [
     {
        "ratePlanRates":[{
            "revshare":0,
            "startUnit":0,
            "type":"REVSHARE",
            "endUnit":null
        }],
       "revenueType":"NET",
       "type":"REVSHARE"
       "currency":{...},
       "product":{"id":"product1","displayName":"Product1"},
       "customPaymentTerm":false
     },
     {
        "ratePlanRates":[{
            "revshare":10,
            "startUnit":0,
            "type":"REVSHARE",
            "endUnit":null
        }],
       "revenueType":"NET",
       "type":"REVSHARE"
       "currency":{...},
       "product":{"id":"product2","displayName":"Product2"},
       "customPaymentTerm":false
     }
     ],
     "startDate": "2019-09-15",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/my-package/rate-plans" \
-u email:password

my-package API 제품 번들에 API 제품을 추가하려면 API 제품별 요금제를 사용하여 API 제품 번들에 API 제품 추가에 설명된 대로 요청 본문에 API 제품의 요금제 세부정보를 추가해야 합니다. 

$ curl -H "Content-Type:application/json" -X POST -d \
'{
    "ratePlan": [
    {
        "id": "my-package_multi-product-rate-plan",
        "ratePlanDetails": [
        {
            "ratePlanRates":[{
                "revshare":20,
                "startUnit":0,
                "type":"REVSHARE",
                "endUnit":null
             }],
             "revenueType":"NET",
             "type":"REVSHARE"
             "currency":{...},
             "customPaymentTerm":false
         }]
    }]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/my-package/products/product3" \
-u email:password

API를 사용하여 요금제를 공개 또는 비공개로 설정

요금제를 만들 때 요청 본문의 isPrivate 속성을 사용하여 공개 또는 비공개 여부를 지정할 수 있습니다. true로 설정하면 요금제가 비공개로 설정됩니다. 자세한 내용은 공개 요금제와 비공개 요금제 비교를 참고하세요.

예를 들어 다음은 특별 요금제를 만듭니다.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Simple rate plan",
     "currency": {
      "id" : "usd"
     },
     "description": "Simple rate plan",
     "displayName" : "Simple rate plan",
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },
     "published": true,
     "isPrivate" : true,
     "ratePlanDetails": [
     {
      …
     }
     ],
     "startDate": "2013-09-15",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location_package/rate-plans" \
-u email:password

API를 사용하여 요금제 게시

요금제를 게시하려면 요금제를 만들 때 published 속성 값을 true로 설정합니다. 개발자는 요금제의 startDate 속성에 지정된 날짜부터 요금제를 볼 수 있습니다.

예를 들어 다음은 요금표 요금제를 만들고 게시합니다 (요청의 일부만 표시됨).

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Flat rate card plan",
     "developer":null,
     "developerCategory":null,
     "advance": "false",
     …
     "published": "true",
     "ratePlanDetails": [
     …
      ],
     …
     "type": "RATECARD"
     }],
     …
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

API를 사용하여 요금제 초안 저장

게시하지 않고 요금제를 저장하려면 요금제를 만들 때 published 속성 값을 false로 설정합니다.

예를 들어 다음은 요금 카드 요금제를 만들고 초안으로 저장합니다 (요청의 일부만 표시됨).

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Flat rate card plan",
     "developer":null,
     "developerCategory":null,
     "advance": "false",
     …
     "published": "false",
     "ratePlanDetails": [
     …
      ],
     …
     "type": "RATECARD"
     }],
     …
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

API를 사용하여 요금제 초안 수정

요금제 초안을 업데이트하려면 /organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_Id}에 PUT 요청을 실행합니다. 여기서 {package_id}는 API 패키지의 식별자이고 {plan_Id}는 요금제의 식별자입니다. 업데이트할 때는 요청 본문에 업데이트된 설정과 요금제의 ID를 지정해야 합니다. 요금제 요금을 업데이트하는 경우 요금제 요금의 ID도 지정해야 합니다. 예를 들어 다음 요청은 ID가 location_flat_rate_card_plan인 요금제의 요금제 요금을 업데이트합니다 (업데이트가 강조 표시됨).

$ curl -H "Content-Type: application/json" -X PUT -d \
 '{
      "id" : "location_flat_rate_card_plan",
      "name": "Flat rate card plan",
      "advance": "false",
      "currency": {
       "id" : "usd"
      },
      "description": "Flat rate card plan",
      "displayName" : "Flat rate card plan",
      "frequencyDuration": "30",
      "frequencyDurationType": "DAY",
      "earlyTerminationFee": "10",
      "monetizationPackage": {
       "id": "location"
      },
      "organization": {
       "id": "{org_name}"
      },
      "paymentDueDays": "30",
      "prorate": "false",
      "published": "false",
      "ratePlanDetails": [
      {
       "currency": {
        "id" : "usd"
       },
       "paymentDueDays": "30",
       "meteringType": "UNIT",
       "organization": {
        "id": "{org_name}"
       },
       "ratePlanRates": [
        {
         "id" : "26b69b0b-9863-48c9-ba73-74a5b918fcec",
         "type": "RATECARD",
         "rate": "0.15",
         "startUnit": "0"
        }
       ],
      "ratingParameter": "VOLUME",
      "type": "RATECARD"
      }],
      "recurringStartUnit": 1,
      "recurringType": "CALENDAR",
      "recurringFee": "10",
      "setUpFee": "10",
      "startDate": "2013-09-15 00:00:00",
      "type": "STANDARD"
 }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans/location_flat_rate_card_plan" \
-u email:password

응답에는 업데이트된 요금제 요금이 포함됩니다 (응답의 일부만 표시됨).

…
"ratePlanRates" : [ {
  "id" : "26b69b0b-9863-48c9-ba73-74a5b918fcec",
  "rate" : 0.15,
  "startUnit" : 0,
  "type" : "RATECARD"
} ],
…

API를 사용하여 요금제 보기

다음 섹션에 설명된 대로 수익 창출 API를 사용하여 요금제를 확인할 수 있습니다.

API를 사용하여 조직의 모든 요금제 보기

조직의 모든 요금제를 보려면 /mint/organizations/{org_name}/rate-plans에 GET 요청을 실행합니다. 여기서 {org_name}은 조직의 이름입니다.

다음 쿼리 매개변수를 전달하여 결과를 필터링할 수 있습니다.

쿼리 매개변수 설명
all 모든 요금제를 반환할지 여부를 지정하는 플래그입니다. false로 설정하면 페이지당 반환되는 요금제 수는 size 쿼리 매개변수로 정의됩니다. 기본값은 true입니다.
size 페이지당 반환되는 API 패키지 수입니다. all 쿼리 매개변수가 true로 설정된 경우 이 매개변수는 무시됩니다.
page 반환하려는 페이지 번호입니다 (콘텐츠가 페이지로 나뉘는 경우). all 쿼리 매개변수가 true로 설정된 경우 이 매개변수는 무시됩니다.

예를 들면 다음과 같습니다.

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/rate-plans" \
  -u email:password

API를 사용하여 API 제품 번들의 모든 요금제 보기

API 패키지의 모든 요금제를 보려면 /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans에 GET 요청을 실행합니다. 여기서 {package_id}은 API 패키지의 ID입니다 (패키지 ID는 수익 창출 패키지를 만들 때 반환됨).

기본적으로 활성 상태이고 공개된 표준 요금제만 결과에 반환됩니다. 포함할 내용:

  • 초안 또는 만료된 요금제의 경우 current 쿼리 매개변수를 false (예: ?current=false)로 설정합니다.
  • 특별 요금제의 경우 showPrivate 쿼리 매개변수를 true로 설정합니다(예: ?showPrivate=true).
  • 모든 표준 요금제의 경우 standard 쿼리 매개변수를 true로 설정합니다(예: ?standard=true).

예를 들면 다음과 같습니다.

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/communications/rate-plans" \
  -u email:password

API를 사용하여 API 패키지의 요금제 보기

API 패키지의 요금제를 보려면 /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_id}에 GET 요청을 실행합니다. 여기서 {package_id}은 API 패키지의 ID이고 {plan_id}은 요금제의 ID입니다 (패키지 ID는 수익 창출 패키지를 만들 때 반환되고 요금제 ID는 요금제를 만들 때 반환됨).

예를 들면 다음과 같습니다.

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/communications/rate-plans/communications_standard_fixed_plan" \
  -u email:password

다음은 응답의 예시입니다.

{
   "advance" : true,
   "contractDuration" : 1,
   "contractDurationType" : "YEAR",
   "currency" : {
     "id" : "usd",
     ...
     "organization" : {
       ...
     },
     ...
   },
   "description" : "Standard Fixed Plan",
   "displayName" : "Standard Fixed Plan",
   "earlyTerminationFee" : 0.0000,
   "frequencyDuration" : 1,
   "frequencyDurationType" : "MONTH",
   "id" : "communications_standard_fixed_plan",
   "isPrivate" : false,
   "monetizationPackage" : {
     "description" : "Communications",
     "displayName" : "Communications",
     "id" : "communications",
     "name" : "Communications",
     "organization" : {
      ...
     },
     "product" : [ {
       "customAtt1Name" : "user",
       "description" : "Location",
       "displayName" : "Location",
       "id" : "location",
       "name" : "location",
       "organization" : {
       ...
       },
       "status" : "CREATED"
     }, {
       "customAtt1Name" : "user",
       "description" : "Messaging",
       "displayName" : "Messaging",
       "id" : "messaging",
       "name" : "messaging",
       "organization" : {
         ...
       },
       "status" : "CREATED"
     } ],
     "status" : "CREATED"
   },
   "name" : "Standard Fixed Plan",
   "organization" : {
     ...
   },
   "paymentDueDays" : "30",
   "prorate" : true,
   "published" : true,
   "ratePlanDetails" : [ {
     "aggregateFreemiumCounters" : true,
     "aggregateStandardCounters" : true,
     "currency" : {
       "id" : "usd",
       "name" : "USD",
       "organization" : {
        ...
       },
       "status" : "ACTIVE",
       "virtualCurrency" : false
     },
     "id" : "cb92f7f3-7331-446f-ad63-3e176ad06a86",
     "meteringType" : "UNIT",
     "organization" : {
      ...
     },
     "paymentDueDays" : "30",
     "ratePlanRates" : [ {
       "id" : "07eefdfb-4db5-47f6-b182-5d606c6051c2",
       "rate" : 0.0500,
       "startUnit" : 0,
       "type" : "RATECARD"
     } ],
     "ratingParameter" : "VOLUME",
     "type" : "RATECARD"
   } ],
   "recurringFee" : 200.0000,
   "recurringStartUnit" : 1,
   "recurringType" : "CALENDAR",
   "setUpFee" : 100.0000,
   "startDate" : "2013-01-11 22:00:00",
   "type" : "STANDARD"
 }

API를 사용하여 개발자의 모든 활성 요금제 보기

개발자의 모든 활성 요금제를 보려면 /mint/organizations/{org_name}/developers/{developer_id}/developer-rateplans에 GET 요청을 실행합니다. 여기서 {developer_id}은 개발자의 이메일 주소입니다.

다음 쿼리 매개변수를 전달하여 결과를 필터링할 수 있습니다.

쿼리 매개변수 설명
all 모든 API 패키지를 반환할지 여부를 지정하는 플래그입니다. false로 설정된 경우 페이지당 반환되는 API 패키지 수는 size 쿼리 매개변수로 정의됩니다. 기본값은 false입니다.
size 페이지당 반환되는 API 패키지 수입니다. 기본값은 20입니다. all 쿼리 매개변수가 true로 설정된 경우 이 매개변수는 무시됩니다.
page 반환하려는 페이지 번호입니다 (콘텐츠가 페이지로 나뉘는 경우). all 쿼리 매개변수가 true로 설정된 경우 이 매개변수는 무시됩니다.

예를 들면 다음과 같습니다.

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans" \
  -u email:password

다음은 응답의 예시입니다.

{
  "ratePlan" : [ {
    "advance" : true,
    "contractDuration" : 1,
    "contractDurationType" : "MONTH",
    "currency" : {
      "description" : "United States Dollar",
      "displayName" : "United States Dollar",
      "id" : "usd",
      "name" : "USD",
      "organization" : {
        ...
      },
      "status" : "ACTIVE",
      "virtualCurrency" : false
    },
    "description" : "Fee Only RatePlan",
    "displayName" : "Fee Only RatePlan",
    "earlyTerminationFee" : 10.0000,
    "freemiumDuration" : 0,
    "freemiumDurationType" : "MONTH",
    "freemiumUnit" : 0,
    "frequencyDuration" : 1,
    "frequencyDurationType" : "WEEK",
    "id" : "messaging_package_fee_only_rateplan",
    "isPrivate" : false,
    "monetizationPackage" : {
      "description" : "messaging package",
      "displayName" : "Messaging Package",
      "id" : "messaging_package",
      "name" : "Messaging Package",
      "organization" : {
        ...
      },
      "product" : [ {
        "customAtt1Name" : "user",
        "customAtt2Name" : "response size",
        "customAtt3Name" : "content-length",
        "description" : "messaging api product",
        "displayName" : "messaging",
        "id" : "messaging",
        "name" : "messaging",
        "organization" : {
         ...
        },
        "status" : "CREATED",
        "transactionSuccessCriteria" : "status == 'SUCCESS'"
      } ],
      "status" : "CREATED"
    },
    "name" : "Fee Only RatePlan",
    "organization" : {
     ...
    },
    "paymentDueDays" : "30",
    "prorate" : false,
    "published" : true,
    "ratePlanDetails" : [ ],
    "recurringFee" : 10.0000,
    "recurringStartUnit" : 1,
    "recurringType" : "CALENDAR",
    "setUpFee" : 20.0000,
    "startDate" : "2013-02-20 00:00:00",
    "type" : "STANDARD"
  } ],
  "totalRecords" : 1
}

API를 사용하여 개발자의 승인된 요금제 보기

개발자의 활성 요금제를 보려면 /mint/organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id}에 GET 요청을 실행하세요. 여기서 {developer_id}는 개발자의 이메일 주소이고 {developer_rateplan_id}는 게시된 요금제를 수락할 때 응답에 반환되는 수락된 요금제의 ID입니다.

예를 들면 다음과 같습니다.

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/messaging_package_fee_only_rateplan" \
  -u email:password

다음은 응답의 예시입니다.

{
    "created" : "2018-01-25 20:01:54",
    "developer" : {
    },
    "id" : "a73s104-276f-45b3-8075-83d1046ea550",
    "nextCycleStartDate" : "2018-02-19 00:00:00",
    "nextRecurringFeeDate" : "2018-02-19 00:00:00",
    "prevRecurringFeeDate" : "2018-01-25 00:00:00",
    "ratePlan" : {
      "frequencyDuration" : 1,
      "frequencyDurationType" : "MONTH",
      "recurringFee" : 0.0000,
      "recurringStartUnit" : 19,
      "recurringType" : "CALENDAR",
      "setUpFee" : 0.0000,
      "type" : "STANDARD"
    },
    "startDate" : "2018-01-25 20:01:54",
    "updated" : "2018-01-25 20:01:54"
  }

API를 사용하여 API 제품이 포함된 개발자의 승인된 요금제 보기

API 제품이 포함된 개발자의 승인된 요금제를 보려면 /mint/organizations/{org_id}/developers/{developer_id}/products/{product_id}/rate-plan-by-developer-product에 GET 요청을 실행합니다. 여기서 {developer_id}는 개발자의 ID이고 /{product_id}는 제품의 ID입니다.

기본적으로 공개 요금제만 결과에 반환됩니다. 특별 요금제를 표시하려면 showPrivate 쿼리 매개변수를 true로 설정합니다 (예: ?showPrivate=true).

예를 들면 다음과 같습니다.

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/products/location/rate-plan-by-developer-product" \
  -u email:password

API를 사용하여 개발자가 수락한 모든 요금제 보기

개발자가 수락한 요금제를 보려면 /mint/organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans에 GET 요청을 실행합니다. 여기서 {developer_id}은 개발자의 ID입니다.

다음 쿼리 매개변수를 전달하여 결과를 필터링할 수 있습니다.

쿼리 매개변수 설명
all 모든 API 패키지를 반환할지 여부를 지정하는 플래그입니다. false로 설정된 경우 페이지당 반환되는 API 패키지 수는 size 쿼리 매개변수로 정의됩니다. 기본값은 false입니다.
size 페이지당 반환되는 API 패키지 수입니다. 기본값은 20입니다. all 쿼리 매개변수가 true로 설정된 경우 이 매개변수는 무시됩니다.
page 반환하려는 페이지 번호입니다 (콘텐츠가 페이지로 나뉘는 경우). all 쿼리 매개변수가 true로 설정된 경우 이 매개변수는 무시됩니다.

예를 들면 다음과 같습니다.

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-accepted-rateplans" \
  -u email:password

다음은 응답의 예시입니다.

{
  "developerRatePlan" : [ {
     "created" : "2018-01-25 20:01:54",
     "developer" : { ...
     },
     "id" : "a73s104-276f-45b3-8075-83d1046ea550",
     "nextCycleStartDate" : "2018-02-19 00:00:00",
     "nextRecurringFeeDate" : "2018-02-19 00:00:00",
     "prevRecurringFeeDate" : "2018-01-25 00:00:00",
     "ratePlan" : {
       "frequencyDuration" : 1,
       "frequencyDurationType" : "MONTH",
       "recurringFee" : 0.0000,
       "recurringStartUnit" : 19,
       "recurringType" : "CALENDAR",
       "setUpFee" : 0.0000,
       "type" : "STANDARD"
     },
     "startDate" : "2018-01-25 20:01:54",
     "updated" : "2018-01-25 20:01:54"
   }],
   "totalRecords" : 1
}

API를 사용하여 요금제 초안 삭제

요금제 초안을 삭제하려면 /organizations/{org_name}/monetization-packages/package_id}/rate-plans/{plan_Id}에 DELETE 요청을 실행합니다. 여기서 {plan_Id}은 삭제할 요금제의 식별자이고 {package_id}은 요금제의 API 패키지 식별자입니다. 예를 들면 다음과 같습니다.

$ curl -H "Accept:application/json" -X DELETE \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans/location_flat_rate_card_plan" \
-u email:password

요금제의 구성 속성

API를 사용하여 요금제를 만들 때 다음 구성 설정을 지정할 수 있습니다.

이름 설명 기본값 필수 여부
advance

정기 수수료에만 유효합니다. 반복 요금이 사전에 청구되는지 여부를 지정하는 플래그입니다. 유효한 값으로 다음이 포함되어 있습니다.

  • true - 반복 요금이 미리 청구됩니다. 예를 들어 기간이 1개월인 경우 이전 결제 월이 종료될 때 생성된 인보이스에 반복 요금이 청구됩니다.
  • false - 기간이 끝나면 반복 요금이 청구됩니다. 예를 들어 기간이 1개월인 경우 현재 결제 월이 종료되면 인보이스에 반복 수수료가 청구됩니다. 이는 기본값입니다.
 거짓 아니요
contractDuration

contractDurationType와 함께 요금제의 계약 기간입니다. 예를 들어 계약 기간을 6개월로 지정하려면 contractDuration을 6으로, contractDurationType을 MONTH으로 설정합니다.

 해당 사항 없음 아니요
contractDurationType

contractDuration와 함께 요금제의 계약 기간입니다. 유효한 값은 다음과 같습니다.

  • DAY
  • WEEK
  • MONTH
  • QUARTER
  • YEAR
 해당 사항 없음 아니요
currency

요금제에 사용되는 통화입니다. 통화의 ISO 4217 코드를 지정합니다(예: 미국 달러의 경우 usd, 스위스 프랑의 경우 chf).

 해당 사항 없음 예
description

요금제에 대한 설명입니다.

 해당 사항 없음 예
developer

개발자 ID (이메일 주소)입니다. 개발자 요금제에만 지정합니다.

 해당 사항 없음 아니요
developerCategory

개발자 카테고리 ID입니다. 개발자 카테고리 요금제에만 지정합니다.

 해당 사항 없음 아니요
displayName

요금제의 사용자 친화적인 표시 이름입니다.

 해당 사항 없음 예
earlyTerminationFee

개발자가 갱신 기간 전에 요금제를 종료하는 경우 청구되는 일회성 수수료입니다.

 해당 사항 없음 아니요
endDate

요금제가 종료되는 날짜입니다. 이 날짜가 지나면 개발자는 요금제를 볼 수 없습니다. 특정 날짜에 요금제가 종료되지 않도록 하려면 endDate에 null 값을 지정합니다.

요금제는 지정된 날짜의 하루가 끝날 때까지 적용됩니다. 예를 들어 2016년 12월 1일에 요금제를 만료하려면 endDate 값을 2016-11-30으로 설정해야 합니다. 이 경우 요금제는 2016년 11월 30일이 끝날 때 만료되며 2016년 12월 1일의 모든 요청은 차단됩니다.

NOTE: API를 사용하여 요금제를 볼 때 endDate 타임스탬프가 YYYY-MM-DD 00:00:00로 지정되어 혼동을 일으킬 수 있습니다.

 해당 사항 없음 아니요
freemiumDuration

freemiumDurationType와 함께 부분 유료 기간의 기간입니다. 예를 들어 무료 기간이 30일임을 지정하려면 freemiumDuration을 30로, freemiumDurationType을 DAY로 설정합니다.

 해당 사항 없음 아니요
freemiumDurationType

freemiumDuration와 함께 무료 기간의 기간입니다. 유효한 값으로 다음이 포함되어 있습니다.

  • DAY
  • WEEK
  • MONTH
  • QUARTER
  • YEAR
 해당 사항 없음 아니요
freemiumUnit

부분 유료 수량입니다. 값은 트랜잭션 레코딩 정책에 기록된 맞춤 속성과 관련된 트랜잭션 수 또는 단위 수일 수 있습니다.

 해당 사항 없음 아니요
frequencyDuration

정기 수수료에만 유효합니다. 반복 요금 청구 사이의 기간과 frequencyDurationType입니다. 예를 들어 수수료 청구 간 기간이 30일임을 지정하려면 frequencyDuration을 30로, frequencyDurationType을 DAY로 설정합니다.

 해당 사항 없음 아니요
frequencyDurationType 정기 수수료에만 유효합니다. 반복 요금 청구 사이의 기간과 frequencyDuration입니다. 유효한 값은 다음과 같습니다.
  • DAY
  • WEEK
  • MONTH
  • QUARTER
  • YEAR
 해당 사항 없음 아니요
isPrivate 요금제가 공개인지 비공개인지 지정하는 플래그입니다. 기본값은 false (공개)입니다. 자세한 내용은 공개 요금제와 특별 요금제를 참고하세요. 해당 사항 없음 아니요
monetizationPackage

요금제의 API 제품 번들 ID입니다.

 해당 사항 없음 아니요
name

요금제 이름입니다.

 해당 사항 없음 예
organization

요금제의 조직 ID입니다.

 해당 사항 없음 예
paymentDueDays

정기 수수료에만 유효합니다. 수수료가 청구되는 일수입니다. 예를 들어 값이 30이면 수수료가 30일 후에 부과된다는 의미입니다.

 해당 사항 없음 아니요
proRate

정기 수수료에만 유효합니다. 개발자가 월 중간에 요금제 부분을 시작하거나 종료할 때 반복 요금이 일할 계산되는지 여부를 지정하는 플래그입니다. 유효한 값은 다음과 같습니다.

  • true - 초기 요금은 기간이 끝날 때까지의 일수 (또는 기간에 사용된 일수)에 따라 일할 계산됩니다.
  • false - 개발자가 요금제를 시작 (또는 종료)하는 시점과 관계없이 초기 수수료가 전액 청구됩니다. 이는 기본값입니다.
 거짓 아니요
published

개발자가 볼 수 있도록 요금제를 게시해야 하는지 여부를 지정하는 플래그입니다. 유효한 값으로 다음이 포함되어 있습니다.

  • true - 요금제를 게시합니다.
  • false - 요금제를 게시하지 않습니다.
 해당 사항 없음 예
ratePlanDetails

요금제 세부정보 (요금제 세부정보의 구성 속성 참고)

 해당 사항 없음 예
recurringFee

개발자가 요금제를 종료할 때까지 지속적으로 개발자에게 청구되는 수수료입니다.

 해당 사항 없음 아니요
recurringStartUnit

recurringType이 CALENDAR으로 설정된 경우에만 유효합니다. 반복 수수료가 청구되는 월의 날짜입니다. 예를 들어 반복 수수료가 매월 청구되고 recurringStartUnit이 1로 설정된 경우 반복 수수료는 매월 1일에 청구됩니다.

 해당 사항 없음 아니요
recurringType

반복 요금 일정입니다. 유효한 값으로 다음이 포함되어 있습니다.

  • CALENDAR - 캘린더를 기반으로 예약됨
  • CUSTOM - 맞춤 날짜 설정에 따라 예약됩니다.
 해당 사항 없음 아니요
setUpFee

요금제 시작일 (즉, 개발자가 요금제를 구매한 날짜)에 각 개발자에게 청구되는 일회성 수수료입니다.

 해당 사항 없음 아니요
startDate

요금제가 시작되는 날짜입니다. 개발자는 이 날짜부터 요금제를 볼 수 있습니다.

 해당 사항 없음 예
type

요금제 유형입니다. 다음 중 하나를 지정합니다.

  • STANDARD. 모든 개발자에게 적용됩니다.
  • DEVELOPER_CATEGORY. 선택한 카테고리의 모든 개발자에게 적용됩니다.
  • DEVELOPER. 특정 개발자 또는 회사에 적용됩니다.
 해당 사항 없음 예

요금제 세부정보의 구성 속성

요금제를 만들 때 ratePlanDetails 배열의 일부로 다음 구성 속성을 지정할 수 있습니다.

이름 설명 기본값 필수 여부
aggregateFreemiumCounters

API 제품의 사용량이 무료 범위에 있는지 확인하기 위해 집계 카운터가 사용 설정되었는지 여부를 지정하는 플래그입니다. 제품의 무료 체험 요금제를 설정하려면 집계 카운터를 사용 설정해야 합니다. 유효한 값으로 다음이 포함되어 있습니다.

  • true - 집계 카운터를 사용 설정합니다.
  • false - 집계 카운터를 사용 설정하지 마세요.
 해당 사항 없음 아니요
aggregateStandardCounters

집계 카운터를 사용하여 사용량 대역 (예: 요금 카드 요금제의 볼륨 대역)을 결정하는지 여부를 지정하는 플래그입니다. 값은 다음 중 하나일 수 있습니다.

  • true - 집계 카운터를 사용합니다.
  • false - 집계 카운터를 사용하지 마세요.
 해당 사항 없음 아니요
aggregateTransactions

NOTE: 이 속성은 현재 수익 창출에서 사용되지 않으며 무시해도 됩니다.

 true 아니요
currency

환율 정보

 해당 사항 없음 아니요
duration

계산 빈도의 기간입니다. durationType와 함께 사용되며 허용되는 duration 값은 1~24입니다.

예를 들어 duration를 2로, durationType를 MONTH로 설정하여 계산 빈도를 2개월로 지정합니다.

 해당 사항 없음 아니요
durationType

duration와 함께 계산 빈도의 기간입니다. 유일하게 유효한 값은 MONTH입니다.

사용 예시는 duration를 참고하세요.

 해당 사항 없음 아니요
freemiumDuration

개별 API 제품의 무료 기간과 freemiumDurationType를 함께 나타내는 기간입니다. 예를 들어 API 제품의 무료 체험 기간이 30일임을 지정하려면 freemiumDuration을 30으로 설정하고 freemiumDurationType을 DAY로 설정합니다.

 해당 사항 없음 아니요
freemiumDurationType

개별 API 제품의 무료 기간과 freemiumDuration를 함께 나타내는 기간입니다. 유효한 값으로 다음이 포함되어 있습니다.

  • DAY
  • WEEK
  • MONTH
  • QUARTER
  • YEAR

예를 들어 API 제품의 무료 체험 기간이 30일임을 지정하려면 freemiumDuration을 30으로, freemiumDurationType을 DAY로 설정합니다.

 해당 사항 없음 아니요
freemiumUnit

API 제품의 프리미엄 수량입니다. 값은 트랜잭션 수 또는 트랜잭션 레코딩 정책에 기록된 맞춤 속성과 관련된 단위 수일 수 있습니다.

 해당 사항 없음 아니요
meteringType

요금 카드 요금제의 청구 모델입니다. 유효한 값으로 다음이 포함되어 있습니다.

  • UNIT - 고정 요금 충전 모델입니다.
  • VOLUME - 볼륨 대역별 요금 모델입니다.
  • STAIR_STEP - 번들 충전 모델입니다.
  • DEV_SPECIFIC - 조정 가능한 알림 충전 모델 다른 수익 모델에는 유효하지 않습니다.
 해당 사항 없음 예
organization

조직 ID

 해당 사항 없음 아니요
paymentDueDays

후불 개발자의 결제 기한입니다. 예를 들어 30일 후에 결제 기한이 도래함을 나타내려면 값을 30으로 설정합니다.

 해당 사항 없음 아니요
product

API 제품 정보(예: ID)

 해당 사항 없음 아니요
ratePlanRates

요금제 유형 (REVSHARE 또는 RATECARD), 요율표 요금제의 요율, 수익 공유 요금제의 수익 공유, 범위 (요금제 요율이 적용되는 시작 단위 및 종료 단위)와 같은 요금제 요율 세부정보입니다.

 해당 사항 없음 예
ratingParameter

요금제의 기준입니다. 요금제는 거래 또는 맞춤 속성을 기반으로 합니다. 유효한 값으로 다음이 포함되어 있습니다.

  • VOLUME - 요금제는 거래량에 따라 결정됩니다.
  • custom_attribute - API 제품의 거래 기록 정책에 정의되고 요금표 요금제에만 유효한 맞춤 속성의 이름입니다. 맞춤 속성 이름은 VOLUME로 정의할 수 없습니다.
 VOLUME 예
ratingParameterUnit

ratingParameter. Only required if ratingParameter 에 적용되는 단위가 맞춤 속성으로 설정됩니다 (즉, VOLUME으로 설정되지 않음).

 해당 사항 없음 예
revenueType

수익 공유 요금제의 수익 공유 기준입니다. 유효한 값으로 다음이 포함되어 있습니다.

  • GROSS - 수익 배분은 거래의 총 가격 비율을 기반으로 합니다.
  • NET - 수익 배분은 거래의 순 가격 비율을 기반으로 합니다.
 해당 사항 없음 아니요
type

요금제 유형입니다. 유효한 값으로 다음이 포함되어 있습니다.

  • REVSHARE - 수익 공유 모델
  • RATECARD - 요율표 모델입니다.
  • REVSHARE_RATECARD - 수익 배분 및 요율 모델입니다.
  • USAGE_TARGET - 조정 가능한 알림 모델

요금제 유형에 대한 자세한 내용은 지원되는 요금제 유형을 참고하세요.

 해당 사항 없음 예