Apigee Edge のドキュメントを表示しています。
Apigee X のドキュメントに移動。 情報
はじめに
収益化の初期設定の一環として、Apigee Edge 構成チームは、組織でサポートされている通貨とデフォルトの通貨を構成します。
組織でサポートされている通貨を表示したり、サポートされている通貨を追加したり、サポートされている通貨を削除したりできます（通貨がデベロッパーまたは料金プランで使用されていない場合）。
UI を使用したサポートされている通貨の管理
サポートされている通貨を管理し、組織のプロフィール ページの [税金と通貨] セクションでデフォルトの通貨を設定します。詳細については、UI を使用して組織プロファイルを管理するをご覧ください。
API を使用したサポートされている通貨の管理
以降のセクションで説明するように、API を使用してサポートされている通貨を管理します。
API を使用してサポートされている通貨を表示する
組織でサポートされている個々の通貨、または組織でサポートされているすべての通貨を表示できます。
組織でサポートされている個々の通貨を表示するには、/mint/organizations/{org_name}/supported-currencies/{supportedCurrencyId} に対して GET リクエストを発行します。ここで、{supportedCurrency_id} は表示するサポートされている通貨の ID です。例:
curl -X GET -H "Accept: application/json" \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/supported-currencies/usd" \
-u email:password
組織でサポートされているすべての通貨を表示するには、/mint/organizations/{org_name}/supported-currencies に GET リクエストを送信します。例:
curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/supported-currencies" \
-H "Accept: application/json" \
-u email:password
レスポンスの例を次に示します。
{
"supportedCurrency" : [ {
"description" : "US Dollar",
"displayName" : "US Dollar",
"id" : "usd",
"name" : "USD",
"organization" : {
...
"status" : "ACTIVE",
"virtualCurrency" : false
}, {
"creditLimit" : 5000.0000,
"description" : "Euro",
"displayName" : "Euro",
"id" : "eur",
"name" : "EUR",
"organization" : {
...
},
"status" : "INACTIVE",
"virtualCurrency" : false
} ],
"totalRecords" : 2
}
API を使用してサポートされている通貨を追加する
/mint//organizations/{org_name}/supported-currencies に POST リクエストを発行して、サポートされている通貨を追加します。追加するサポートされている通貨ごとに、リクエスト本文で次の情報を指定する必要があります。
- サポートされている通貨の名前。名前は、通貨の ISO 4217 コードです（米ドルの場合は USD など）。
- 表示名。
- 説明。
- 通貨が仮想通貨かどうか。
- 通貨のステータス、つまり通貨が使用可能かどうかを表します。
- サポート対象の通貨が追加される組織。
必要に応じて、次の設定を行うことができます。
- サポートされている通貨での利用限度額（後払いデベロッパーのみ）。
- サポートされている通貨の最小チャージ額（前払いデベロッパーのみ）。
詳細については、サポートされている通貨の構成プロパティをご覧ください。
次の例では、組織でサポートされている通貨を追加します。
curl -H "Content-Type: application/json" -X POST -d \
'{
"description": "US Dollar",
"displayName": "US Dollar",
"virtualCurrency": "false",
"name": "USD",
"organization": {
"id": "{org_name}"
},
"status": "ACTIVE"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/supported-currencies" \
-u email:password
API を使用してデフォルトの通貨を設定する
組織のデフォルトの通貨を設定するには、API を使用した組織プロファイルの管理で説明されているように、組織プロファイルを編集するときに、サポートされている ISO 4217 通貨コードを currency 値に設定します。
API を使用したサポートされている通貨の編集
サポートされている通貨を編集するには、/mint/organizations/{org_name}/{supportedCurrencyId} に PUT リクエストを発行します。ここで、{supportedCurrency_id} は更新するサポートされている通貨の識別子です。リクエストの本文で、更新したプロパティとサポートされている通貨 ID を指定する必要があります。たとえば、次の API 呼び出しは、サポートされている通貨の説明と表示名を編集します（更新されたプロパティは例でハイライト表示されています）。
curl -H "Content-Type: application/json" -X PUT -d \
'{
"description": "United States Dollar",
"displayName": "United States Dollar",
"id": "usd",
"name": "USD",
"organization": {
"id": "{org_name}"
},
"status" : "ACTIVE",
"virtualCurrency": "false"
}' \
"https://api.enterprise.apigee.com/v1/mint/organization/{org_name}/supported-currencies/usd" -d \
-u email:password
API を使用してサポートされている通貨を削除する
/mint/organizations/{org_name}/supported-currencies/{currency_id} に DELETE リクエストを送信して、サポートされている通貨を削除します。ここで、{currency_id} は削除するサポートされている通貨の ID です。次に例を示します。
curl -X DELETE -H "Accept: application/json" \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/supported-currencies/usd" \
-u email:password
API の通貨構成プロパティ
次の表に、API を使用して設定できる構成プロパティを示します。
| 名前 | 説明 | デフォルト | 必須 |
|---|---|---|---|
| creditLimit |
このプロパティは後払いデベロッパーのみに適用されます。サポートされている通貨のクレジット上限。 |
なし | いいえ |
| description |
サポートされている通貨の説明。 |
なし | はい |
| displayName |
サポートされている通貨で表示される名前。 |
なし | はい |
| minimumTopupAmount |
このプロパティは、前払いのデベロッパーにのみ適用されます。デベロッパーが指定の通貨で前払いアカウント残高に追加できる最低額です。 |
なし | いいえ |
| name |
通貨の ISO 4217 コード（米ドルの場合は USD など）。 |
なし | はい |
| 組織 |
サポートされている通貨の組織。 |
なし | はい |
| status |
サポートされている通貨のステータス。有効な値は次のとおりです。
|
なし | はい |
| virtualCurrency |
サポートされている通貨が仮想通貨かどうかを指定します。有効な値は次のとおりです。
|
なし | はい |