サポートされている通貨を管理する

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

はじめに

収益化の初期設定の一環として、Apigee Edge 構成チームは では、組織でサポートされている通貨とデフォルトの通貨を構成します。

組織でサポートされている通貨を表示したり、サポートされている通貨を追加したり、 サポートされている通貨を削除する(通貨がデベロッパーまたは料金プランで使用されていない場合)。

UI を使用したサポートされている通貨の管理

サポートされている通貨を管理し、[税金] と [通貨] でデフォルトの通貨を設定します セクションにある [組織プロフィール] ページで確認できます。詳細については、 UI で組織プロファイルを確認するをご覧ください。

API を使用した、サポートされている通貨の管理

ここでは、API を使用してサポートされている通貨を管理する方法について説明します。

API を使用したサポートされている通貨の表示

組織でサポートされている個々の通貨またはすべての通貨を表示する 組織によってサポートされている必要があります。

組織でサポートされている個々の通貨を表示するには、次の宛先に GET リクエストを発行してください。 /mint/organizations/{org_name}/supported-currencies/{supportedCurrencyId}、ここで {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

組織でサポートされているすべての通貨を表示するには、次の宛先に GET リクエストを発行してください。 /mint/organizations/{org_name}/supported-currencies。例:

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 を使用してデフォルトの通貨を設定する

currency の値をサポートされている ISO 4217 通貨に設定して、組織のデフォルトの通貨を設定します。 組織の管理 プロファイルを使用することもできます。

API を使用したサポートされている通貨の編集

サポートされている通貨を編集するには、次の国に PUT リクエストを発行します。 /mint/organizations/{org_name}/{supportedCurrencyId}、ここで {supportedCurrency_id} は、サポートされている通貨の 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}、ここで {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

サポートされている通貨のステータス。有効な値は次のとおりです。

  • ACTIVE: サポートされている通貨を使用できます。
  • INACTIVE: サポートされている通貨は使用できません。
なし
virtualCurrency

サポートされている通貨が仮想通貨かどうかを指定します。有効な値は次のとおりです。

  • true: サポートされている通貨は仮想通貨です。
  • false: サポートされている通貨は仮想通貨ではありません。
なし はい