크레딧 발급

Apigee Edge 문서입니다.
Go to the Apigee X 문서로 이동합니다.
info

소개

수익 창출을 사용하면 개발자 크레딧을 유연하게 발급할 수 있습니다.

선불 개발자의 경우 크레딧은 사용량 감소로 표시됩니다. 이는 개발자의 선불 잔액을 늘리거나 줄입니다. 체크카드를 사용하는 것과 마찬가지로 개발자가 API 제품 번들을 구매하면 개발자의 선불 잔액에서 금액이 인출됩니다. 개발자는 구매를 위한 충분한 잔액을 유지해야 합니다. 선불 계정 잔액을 계산하려면 어떻게 해야 하나요?를 참고하세요.

후불 개발자의 경우 크레딧은 인보이스에 별도의 항목으로 표시되어 인보이스의 청구 금액을 줄입니다.

크레딧 페이지 탐색

아래 설명에 따라 크레딧 페이지에 액세스하고 탐색합니다.

에지

Edge UI를 사용하여 크레딧 페이지에 액세스하려면 다음 안내를 따르세요.

  1. apigee.com/edge에 로그인합니다.
  2. 왼쪽 탐색 메뉴에서 게시 > 수익 창출 > 크레딧 을 선택합니다.

크레딧 페이지가 표시됩니다.

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

  • 수신자 이름, 크레딧 금액, 크레딧이 적용되는 날짜 및 시간, 크레딧이 적용되는 API 제품 번들 및 API 제품, 추가된 메모를 비롯한 모든 크레딧의 요약 정보를 봅니다.
  • 크레딧 발급하기
  • 크레딧 목록 검색

기본 Edge (Private Cloud)

기본 Edge UI를 사용하여 크레딧 페이지에 액세스하려면 다음 단계를 따르세요.

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

크레딧 페이지에서 다음을 수행할 수 있습니다.

  • 수신자 이름, 크레딧 금액, 크레딧이 적용되는 날짜 및 시간, 크레딧이 적용되는 API 제품 번들 및 API 제품, 추가된 메모를 비롯한 모든 크레딧의 요약 정보를 봅니다.
  • 크레딧 발급하기
  • 크레딧 목록 검색

크레딧 발급

  1. 크레딧 페이지에 액세스합니다.
  2. + 크레딧 을 클릭합니다.
  3. 다음 정보를 입력합니다.
    필드 설명
    결제 월

    크레딧이 적용되는 결제 월입니다. 목록에서 월을 선택합니다.

    개발자

    크레딧이 적용되는 개발자 또는 회사 이름입니다. 텍스트 상자에 이름을 입력합니다. 입력과 동시에 문자열이 포함된 개발자/회사 목록이 드롭다운에 표시됩니다. 드롭다운 목록에서 개발자 또는 회사 이름을 클릭합니다.

    참고: 개발자 또는 회사를 선택하면 나머지 필드가 표시됩니다. 요금제를 수락하지 않은 회사 또는 개발자를 선택하면 크레딧을 발급할 수 없습니다.

    제품 번들

    크레딧이 적용되는 API 제품 번들입니다. 사용 가능한 API 제품 번들 목록에서 선택합니다.

    제품

    크레딧이 적용되는 선택한 API 제품 번들의 API 제품입니다. 목록에서 모든 제품 또는 단일 API 제품을 선택합니다.

    통화

    크레딧에 사용되는 통화입니다. 통화는 개발자가 구매한 API 제품 번들의 요금제에 대해 구성되며 변경할 수 없습니다. 요금제에 여러 통화가 정의되어 있는 경우 통화 중 하나를 선택할 수 있습니다.

    금액

    크레딧 금액 (지정된 통화)입니다. 양수 또는 음수 값을 지정합니다. 값은 0일 수 없습니다.

    부가 정보

    크레딧 이유를 설명하는 선택적 메모입니다.

  4. 크레딧 저장 을 클릭합니다.

API를 사용하여 크레딧 발급

API를 사용하여 API 제품 번들 전체 또는 API 제품 번들의 특정 API 제품 사용에 대해 개발자에게 크레딧을 발급합니다.

API를 사용하여 크레딧을 발급하려면 /organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{rate-plan_id}/real-currency-credit-transactions, 여기에 {package_id}{rate-plan_id}는 각각 크레딧이 적용되는 API 제품 번들 및 요금제의 식별을 정의하는 POST 요청을 실행합니다.

요청을 실행할 때 쿼리 매개변수로 다음을 지정해야 합니다.

  • 크레딧이 적용되는 개발자 ID (이메일 주소)
  • 크레딧 금액
  • 크레딧에 사용되는 통화
  • 크레딧 이유를 설명하는 메모

선택적으로 다음과 같은 추가 쿼리 매개변수를 지정할 수 있습니다.

  • 크레딧이 적용되는 결제 월입니다. 이 값은 기본적으로 현재 월로 설정됩니다.
  • 크레딧이 적용되는 결제 연도입니다. 이 값은 기본적으로 현재 연도로 설정됩니다.
  • 크레딧이 적용되는 API 제품입니다. API 제품 ID를 지정하지 않으면 크레딧이 API 제품 번들의 모든 API 제품에 적용됩니다.

예를 들어 다음 요청은 dev1@myorg.com으로 식별된 개발자에게 2018년 4월의 결제 월에 대해 100달러의 크레딧을 발급합니다. 크레딧은 payment API 제품 번들 및 payment_standard_plan 요금제에 적용됩니다.

크레딧 요청에서 지정할 수 있는 쿼리 매개변수의 전체 목록은 크레딧 API의 쿼리 매개변수를 참고하세요.

$ curl -H "Content-Type:application/json" -X POST \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/payment/rate-plans/payment_standard_plan/real-currency-credit-transactions?currencyId=usd&developerId=dev1@myorg.com&transactionAmount=100&transactionNote=Credit+for+failed+transactions&billingMonth=APRIL&billingYear=2013" \
-u email:password

다음은 응답의 예시 발췌문입니다.

{
  "currency" : "USD",
  "developer" : {
    "address" : [ {
      "address1" : "Dev One Address",
     ...
    } ],
    "approxTaxRate" : 0.0000,
    "billingType" : "PREPAID",
    "broker" : false,
    "developerRole" : [ ],
    "email" : "dev1@myorg.com",
    "hasSelfBilling" : false,
    "id" : "K4jW2QLjZ1h8GFA8",
    "legalName" : "DEV ONE",
    "name" : "Dev One",
    "organization" : {
     ...
    },
    "registrationId" : "TestRegId",
    "status" : "ACTIVE",
    "type" : "TRUSTED"
  },
  "endTime" : "2013-09-04 15:54:36",
  "environment" : "PROD",
  "euroExchangeRate" : 0.8107,
  "gbpExchangeRate" : 0.6860,
  "id" : "904c3f73-ab8d-4e5d-a48c-225fd49a3bde",
  "isVirtualCurrency" : false,
  "notes" : "Credit for failed transactions",
  "pkgId" : "myorg@@@payment",
  "pkgRatePlanProductName" : "Payment",
  "providerTxId" : "904c3f73-ab8d-4e5d-a48c-225fd49a3bde",
  "rate" : 100,
  "ratePlan" : {
    ...
      },
      "status" : "ACTIVE",
      "virtualCurrency" : false
    },
    "description" : "Standard Plan",
    "displayName" : "Standard Plan",
        "monetizationPackage" : {
      "description" : "Payment",
      ...
        } ],
       ...
      },
      "product" : [ {
        "customAtt1Name" : "user",
        "description" : "Payment",
        "displayName" : "Payment",
        "id" : "payment",
        "name" : "payment",
        "organization" : {
          ...
        },
        "status" : "CREATED",
        "transactionSuccessCriteria" : "Status=='200 OK'"
      } ],
      "status" : "CREATED"
    },
    "name" : "Standard Plan",
    "organization" : {
     ...
    },
    ...
      },
      ...
      },
      ...
  },
  "revenueShareAmount" : 0,
  "startTime" : "2013-09-04 15:54:36",
  "status" : "SUCCESS",
  "taxModel" : "UNDISCLOSED",
  "txProviderStatus" : "SUCCESS",
  "type" : "CREDIT",
  "usdExchangeRate" : 1.0675,
  "utcEndTime" : "2013-09-04 15:54:36",
  "utcStartTime" : "2013-09-04 15:54:36"
}

크레딧 API의 쿼리 매개변수

크레딧 API와 함께 사용할 수 있는 쿼리 매개변수는 다음과 같습니다.

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

크레딧이 적용되는 결제 월(예: 4월)

해당 사항 없음 아니요
billingYear

크레딧이 적용되는 결제 연도(예: 2018)

해당 사항 없음 아니요
currencyId

크레딧에 사용되는 통화입니다. 통화는 개발자가 구매한 API 제품 번들의 요금제에 대해 구성되며 변경할 수 없습니다.

해당 사항 없음
developerId

크레딧이 적용되는 개발자 또는 회사 이름입니다.

해당 사항 없음
productId

크레딧이 적용되는 API 제품입니다. 제품 ID를 지정하지 않으면 크레딧이 API 제품 번들의 모든 API 제품에 적용됩니다.

해당 사항 없음 아니요
transactionAmount

크레딧 금액 (지정된 통화)입니다. 양수 또는 음수 값을 지정합니다. 값은 0일 수 없습니다.

해당 사항 없음
transactionNote

크레딧 이유를 설명하는 메모입니다.

해당 사항 없음