크레딧 발급

현재 Apigee Edge 문서가 표시되고 있습니다.
Apigee X 문서로 이동 정보

소개

수익 창출은 개발자 크레딧을 발급할 수 있는 유연성을 제공합니다.

선불 개발자의 경우 크레딧은 사용량이 감소하면 나타나며, 이로 인해 향후 개발자의 선불 잔액이 증가하거나 줄어듭니다. 체크카드를 사용할 때와 마찬가지로 개발자가 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에 POST 요청을 전송합니다. 여기서 {package_id} 및 {rate-plan_id}는 각각 크레딧이 적용되는 API 제품 번들 및 요금제의 식별을 정의합니다.

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

• 크레딧이 적용되는 개발자 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의 쿼리 매개변수

다음 쿼리 매개변수를 Credit API와 함께 사용할 수 있습니다.

이름	설명	기본 계정	필수 여부
billingMonth	크레딧이 적용되는 결제 월입니다(예: APRIL).	N/A	No
billingYear	크레딧이 적용되는 결제 연도입니다(예: 2018).	N/A	No
currencyId	크레딧에 사용되는 통화입니다. 개발자가 구매한 API 제품 번들의 요금제에 통화가 구성되어 있으며 변경할 수 없습니다.	N/A	지원됨
developerId	크레딧이 적용되는 개발자 또는 회사 이름	N/A	지원됨
productId	크레딧이 적용되는 API 제품입니다. 제품 ID를 지정하지 않으면 API 제품 번들에 포함된 모든 API 제품에 크레딧이 적용됩니다.	N/A	No
transactionAmount	지정된 통화로 된 크레딧 금액입니다. 양수 또는 음수 값을 지정합니다. 값은 0일 수 없습니다.	N/A	지원됨
transactionNote	크레딧 사유를 설명합니다.	N/A	지원됨