現在、Apigee Edge のドキュメントを表示しています。
Apigee X のドキュメントをご確認ください。 情報
はじめに
収益化により、デベロッパー クレジットを柔軟に発行できます。
プリペイド デベロッパーの場合、クレジットは使用量が減ったものとして表示され、これによってデベロッパーの前払い残高が増減します。デビットカードを使用する場合と同様に、デベロッパーが API プロダクト バンドルを購入すると、デベロッパーのプリペイド残高から金額が引き落とされます。デベロッパーは、購入に十分な残高を維持する必要があります。詳しくは、前払い残高の算出方法をご覧ください。
後払い式デベロッパーの場合、クレジットは請求書に個別の行として表示されるため、請求書の料金が減ります。
[Credits] ページの操作
以下で説明するように、[Credits] ページにアクセスして操作します。
エッジ
Edge UI を使用して [クレジット] ページにアクセスするには:
- apigee.com/edge にログインします。
- 左側のナビゲーション バーで [Publish] > [Monetization] > [Credits] を選択します。
[Credits] ページが表示されます。
図でハイライト表示されているように、[クレジット] ページでは次のことができます。
- すべてのクレジットの概要情報(受取人名、クレジット金額、クレジットの有効期間、クレジットが適用される API プロダクト バンドルと API プロダクト、追加されたメモなど)を表示する
- クレジットを発行する
- クレジットのリストを検索する
従来の Edge(Private Cloud)
Classic Edge UI を使用して [クレジット] ページにアクセスするには:
http://ms-ip:9000
にログインします。ここで、ms-ip は Management Server ノードの IP アドレスまたは DNS 名です。- 上部のナビゲーション バーで [Monetization] > [Monetization Reports] を選択します。
[クレジット] ページでは、次のことができます。
- すべてのクレジットの概要情報(受取人名、クレジット金額、クレジットの有効期間、クレジットが適用される API プロダクト バンドルと API プロダクト、追加されたメモなど)を表示する
- クレジットを発行する
- クレジットのリストを検索する
クレジットの発行
- [Credits] ページにアクセスします。
- [+ Credit] をクリックします。
- 次の情報を入力します。
項目 説明 請求月 クレジットが適用される請求月。リストから月を選択します。
デベロッパー クレジットが適用されるデベロッパー名または会社名。テキスト ボックスに名前を入力します。 入力を始めると、その文字列を含むデベロッパー/会社のリストがプルダウンに表示されます。 プルダウン リストからデベロッパーまたは会社の名前をクリックします。
注: デベロッパーまたは会社を選択すると、残りのフィールドが表示されます。料金プランに同意していない会社またはデベロッパーを選択した場合、クレジットを発行することはできません。
一括販売商品 クレジットが適用される API プロダクト バンドル。利用可能な API プロダクト バンドルのリストから選択します。
商品 クレジットが適用される選択した API プロダクト バンドルの API プロダクト。[All Products] またはリストから 1 つの API プロダクトを選択します。
通貨 クレジットに使用される通貨。通貨は、デベロッパーが購入した API プロダクト バンドルの料金プランに対して構成されており、変更することはできません。料金プランに複数の通貨が定義されている場合は、いずれかの通貨を選択できます。
金額 クレジットの金額(指定された通貨)。正または負の値を指定します。値をゼロにすることはできません。
注 クレジットの理由を説明するメモ(省略可)。
- [クレジットを保存] をクリックします。
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 プロダクトに適用されます。
たとえば、次のリクエストでは、2018 年 4 月の請求月に $100 のクレジットを、dev1@myorg.com
として識別されるデベロッパーに発行します。このクレジットは、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" }
クレジット API のクエリ パラメータ
Credit API では、次のクエリ パラメータを使用できます。
名前 | 説明 | デフォルト | 必須 / 任意 |
---|---|---|---|
billingMonth |
クレジットが適用される請求月(4 月など)。 |
なし | × |
billingYear |
クレジットが適用される請求年(2018 年など)。 |
なし | × |
currencyId |
クレジットに使用される通貨。通貨は、デベロッパーが購入した API プロダクト バンドルの料金プランに対して設定されており、変更できません。 |
なし | ○ |
developerId |
クレジットが適用されるデベロッパー名または会社名。 |
なし | ○ |
productId |
クレジットが適用される API プロダクト。プロダクト ID を指定しない場合、クレジットは API プロダクト バンドル内のすべての API プロダクトに適用されます。 |
なし | × |
transactionAmount |
クレジットの金額(指定された通貨)。正または負の値を指定します。値をゼロにすることはできません。 |
なし | ○ |
transactionNote |
クレジットの理由を記載します。 |
なし | ○ |