クレジットを発行する

<ph type="x-smartling-placeholder"></ph> 現在、Apigee Edge のドキュメントが表示されています。
Apigee X のドキュメント。 詳細

はじめに

収益化により、デベロッパー クレジットを柔軟に発行できます。

前払いデベロッパーの場合、 クレジットは使用量が減ったように見えます。これにより、デベロッパーのプリペイド残高が増減します。ほぼ同じ デビットカードを使用する場合、 API プロダクト バンドルを購入します。デベロッパーは、 購入します。アカウントの前払い残高の計算方法をご覧ください。

後払いのデベロッパーの場合、クレジットは次のように表示されます。 請求書の 1 行に 1 行ずつ追加することで、請求書の料金を削減できます。

[Credits] ページの詳細

以下で説明するように、[クレジット] ページにアクセスして内容を確認します。

クレジットの発行

1. [クレジット] ページにアクセスします。
2. [+ Credit] をクリックします。
3. 次の情報を入力します。

   フィールド	説明
   請求月	クレジットが適用される請求月。リストから月を選択します。
   デベロッパー	クレジットが適用されるデベロッパーまたは会社名。テキスト ボックスに名前を入力します。 入力を始めると、その文字列を含むデベロッパー/会社のリストがプルダウンに表示されます。 プルダウン リストからデベロッパーまたは会社の名前をクリックします。 注: デベロッパーまたは会社を選択すると、残りのフィールドが表示されます。 料金プランに同意していない会社やデベロッパーを選択した場合、クレジットを発行することはできません。
   製品バンドル	クレジットが適用される API プロダクト バンドル。利用可能な API プロダクト バンドルのリストから選択します。
   プロダクト	クレジットが適用される、選択した API プロダクト バンドルの API プロダクト。選択 All Products またはリストの単一の API プロダクト。
   通貨	クレジットに使用する通貨。通貨は、API プロダクト バンドルの料金プランに構成されており、 変更はできません。 料金プランに複数の通貨が定義されている場合は、いずれか 1 つの通貨を選択できます。
   金額	クレジットの金額（指定した通貨）。正または負の値を指定します。値をゼロにすることはできません。
   注	クレジットの理由を説明するメモ（省略可）。

4. [クレジットを保存] をクリックします。

API を使用したクレジットの発行

API を使用して、API プロダクト バンドル全体に対してデベロッパーにクレジットを発行する、または API プロダクト バンドルに含まれる特定の API プロダクトの使用を禁止する機能を提供します。

API を使用してクレジットを発行するには、POST リクエストを /organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{rate-plan_id}/real-currency-credit-transactions, ここで、{package_id} と {rate-plan_id} は、 クレジットが適用される API プロダクト バンドルと料金プランの識別をそれぞれ示します。

リクエストを発行するときは、次のクエリ パラメータとして指定する必要があります。

• クレジットを適用するデベロッパー ID（メールアドレス）。
• クレジットの金額。
• クレジットに使用する通貨。
• クレジットを取得する理由についてのメモ。

必要に応じて、次の追加のクエリ パラメータを指定できます。

• クレジットが適用される請求月。この値はデフォルトで あります。
• クレジットが適用される請求期間。この値はデフォルトで現在の年に設定されます。
• クレジットが適用される API プロダクト。API プロダクトを指定しない場合 API プロダクト バンドル内のすべての API プロダクトにクレジットが適用されます。

たとえば、次のリクエストでは、2018 年 4 月の請求月に $100 のクレジットを発行します。 dev1@myorg.com として識別されるデベロッパーに送信。クレジットは payment API プロダクトのバンドルと payment_standard_plan 料金プラン:

クエリ パラメータの完全なリストについては、Credit 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"
}

Credit API のクエリ パラメータ

Credit API では、次のクエリ パラメータを使用できます。