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

現在、Apigee Edge のドキュメントを表示しています。
Apigee X のドキュメントをご確認ください
情報

はじめに

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

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

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

[Organization Profile] ページの [Tax and Currency] セクションで、サポートされる通貨を管理し、デフォルトの通貨を設定します。詳細については、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 を使用した組織プロファイルの管理で説明されているように、組織プロファイルを編集するときに、currency 値をサポートされている ISO 4217 通貨コードに設定します。

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

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

なし
organization

サポートされている通貨の組織。

なし
獲得する

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

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

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

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