クレジットを発行する

Apigee Edge のドキュメントを表示しています。
Apigee X のドキュメントに移動。 情報

はじめに

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

プリペイドのデベロッパーの場合、クレジットは使用量が減ったように見えます。これにより、デベロッパーのプリペイド残高が増減します。デビットカードを使用する場合と同様に、デベロッパーが API プロダクト バンドルを購入すると、デベロッパーの前払い残高から資金が引き落とされます。デベロッパーは、購入に十分な残高を維持する必要があります。前払いアカウントの残高を確認するにはどうすればよいですか？をご覧ください。

後払いデベロッパーの場合、クレジットは請求書の個別の行として表示され、請求書の請求額が減額されます。

[クレジット] ページの確認

次の手順に沿って [クレジット] ページにアクセスし、内容を確認します。

クレジットの発行

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

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

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 をそれぞれ定義します。

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

• クレジットが適用されるデベロッパー ID（メールアドレス）。
• クレジットの金額。
• クレジットに使用される通貨。
• クレジットの理由を説明するメモ。

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

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

たとえば、次のリクエストは、dev1@myorg.com という ID の開発者に、2018 年 4 月の請求月に 100 ドルのクレジットを発行します。クレジットは、payment API プロダクト バンドルと payment_standard_plan 料金プランに適用されます。

クレジット リクエストで指定できるクエリ パラメータの一覧については、Credits 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"
}

credits API のクエリ パラメータ

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

名前	説明	デフォルト	必須
billingMonth	クレジットが適用される請求月（APRIL など）。	なし	いいえ
billingYear	クレジットが適用される請求年（2018 年など）。	なし	いいえ
currencyId	クレジットに使用される通貨。通貨は、デベロッパーが購入した API プロダクト バンドルの料金プラン用に構成されており、変更できません。	なし	はい
developerId	クレジットが適用されるデベロッパーまたは会社名。	なし	はい
productId	クレジットが適用される API プロダクト。プロダクト ID を指定しない場合、クレジットは API プロダクト バンドル内のすべての API プロダクトに適用されます。	なし	いいえ
transactionAmount	クレジットの金額（指定した通貨）。正または負の値を指定します。値をゼロにすることはできません。	なし	はい
transactionNote	クレジットの理由を説明するメモ。	なし	はい