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

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

Введение

В рамках первоначальной настройки монетизации группа настройки 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.