Как управлять поддерживаемыми валютами

Вы просматриваете документацию по 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

Добавьте поддерживаемые валюты, отправив POST-запрос на адрес /mint//organizations/{org_name}/supported-currencies. Для каждой поддерживаемой валюты, которую вы добавляете, в теле запроса необходимо указать следующую информацию:

• Название поддерживаемой валюты. Название – это код валюты по стандарту 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

Чтобы задать валюту по умолчанию для организации, укажите код валюты в формате ISO 4217 в поле currency при редактировании профиля организации, как описано в статье Как управлять профилем организации с помощью 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.