Управление поддерживаемыми валютами

Вы просматриваете документацию Apigee Edge .
Перейдите в документацию Apigee X.info

Введение

В рамках первоначальной настройки монетизации команда конфигурации Apigee Edge настраивает валюты, в том числе валюту по умолчанию, поддерживаемую вашей организацией.

Вы можете просмотреть валюты, поддерживаемые вашей организацией, добавить поддерживаемые валюты или удалить поддерживаемые валюты (если эти валюты не используются разработчиком или тарифным планом).

Управление поддерживаемыми валютами с помощью пользовательского интерфейса.

В разделе «Налоги и валюта» на странице «Профиль организации» вы можете управлять поддерживаемыми валютами и установить валюту по умолчанию. Подробную информацию см. в разделе «Управление профилем организации с помощью пользовательского интерфейса» .

Управление поддерживаемыми валютами с помощью API

Управляйте поддерживаемыми валютами с помощью API, как описано в следующих разделах.

Просмотр поддерживаемых валют с помощью API

Просмотрите список валют, поддерживаемых вашей организацией, или список всех валют, поддерживаемых вашей организацией.

Чтобы просмотреть информацию о валюте, поддерживаемой вашей организацией, отправьте GET-запрос по адресу /mint/organizations/{org_name}/supported-currencies/{supportedCurrencyId} , где {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

Чтобы просмотреть все валюты, поддерживаемые вашей организацией, отправьте 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» .

Редактирование поддерживаемой валюты с помощью API

Изменить поддерживаемую валюту можно, отправив PUT-запрос по адресу /mint/organizations/{org_name}/{supportedCurrencyId} , где {supportedCurrency_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.

Удалите поддерживаемую валюту, отправив запрос DELETE по адресу /mint/organizations/{org_name}/supported-currencies/{currency_id} , где {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.