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

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

はじめに

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

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

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

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

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

以降のセクションで説明するように、API を使用してサポートされている通貨を管理します。

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

組織でサポートされている個々の通貨またはすべての通貨を表示します。

組織でサポートされている個々の通貨を表示するには、/mint/organizations/{org_name}/supported-currencies/{supportedCurrencyId} に GET リクエストを発行します。ここで、{supportedCurrency_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 を使用して組織プロファイルを管理するで説明されているように、組織プロファイルを編集するときに currency 値をサポートされている ISO 4217 通貨コードに設定して、組織のデフォルトの通貨を設定します。

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} は削除するサポートされている通貨の識別子です。次に例を示します。

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 を使用して設定できる構成プロパティをまとめます。