Administrar monedas admitidas

Estás viendo la documentación de Apigee Edge.
Ve a la Documentación de Apigee X.
información

Introducción

Como parte de la configuración inicial de la monetización, el equipo de configuración de Apigee Edge configura las monedas y la moneda predeterminada que admite tu organización.

Puedes ver las monedas que admite tu organización, agregar las monedas admitidas o Borrar las monedas admitidas (si un desarrollador o un plan de tarifas no usan las monedas)

Cómo administrar las monedas admitidas con la IU

Administra las monedas admitidas y establece la moneda predeterminada en Tax and Currency de la página del perfil de la organización. Consulta Administración el perfil de la organización con la IU para obtener más detalles.

Cómo administrar las monedas admitidas con la API

Administra las monedas admitidas mediante la API, como se describe en las siguientes secciones.

Cómo ver las monedas admitidas con la API

Consulta una moneda individual que admite tu organización o todas las monedas respaldadas por tu organización.

Para ver una moneda individual que admite tu organización, envía una solicitud GET a /mint/organizations/{org_name}/supported-currencies/{supportedCurrencyId}, donde {supportedCurrency_id} es la identificación de la moneda admitida que se visto. Por ejemplo:

curl -X GET -H "Accept: application/json"  \
  "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/supported-currencies/usd" \
-u email:password

Para ver todas las monedas que admite tu organización, envía una solicitud GET a /mint/organizations/{org_name}/supported-currencies Por ejemplo:

curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/supported-currencies" \
  -H "Accept: application/json"  \
-u email:password

A continuación, se proporciona un ejemplo de la respuesta.

{
"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
}

Configura la moneda predeterminada con la API

Establece la moneda predeterminada para la organización configurando el valor currency con una moneda ISO 4217 admitida. código cuando edites el perfil de la organización, como se describe en Cómo administrar la organización con la API.

Cómo editar una moneda admitida mediante la API

Edita una moneda admitida enviando una solicitud PUT a /mint/organizations/{org_name}/{supportedCurrencyId}, donde {supportedCurrency_id} es la identificación de la moneda admitida que se se actualicen. Debes especificar las propiedades actualizadas en el cuerpo de la solicitud. y el ID de moneda admitida. Por ejemplo, la siguiente llamada a la API edita la descripción y el nombre visible de una moneda admitida (las propiedades actualizadas se resaltadas en el ejemplo):

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

Cómo borrar una moneda admitida mediante la API

Para borrar una moneda admitida, envía una solicitud DELETE a /mint/organizations/{org_name}/supported-currencies/{currency_id}, donde {currency_id} es la identificación de la moneda admitida que se borrará. Por ejemplo:

curl -X DELETE -H "Accept: application/json"  \
  "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/supported-currencies/usd" \
  -u email:password

Propiedades de configuración de moneda para la API

En la siguiente tabla, se resumen las propiedades de configuración que se pueden establecer con la API.

Nombre Descripción Predeterminada ¿Obligatorio?
creditLimit

Esta propiedad se aplica solo a los desarrolladores que usan el método de pospago. El límite de crédito del moneda admitida.

N/A No
descripción

Es una descripción de la moneda admitida.

N/A
displayName

Es el nombre que se mostrará para la moneda admitida.

N/A
minimumTopupAmount

Esta propiedad se aplica solo a los desarrolladores con suscripciones prepagadas. Es el importe mínimo que los desarrolladores pueden agregar al saldo prepagado de su cuenta en la moneda especificada.

N/A No
nombre

El código ISO 4217 de la moneda, como USD para dólar estadounidense.

N/A
organización

Es la organización de la moneda admitida.

N/A
estado

Es el estado de la moneda admitida. Estos son algunos de los valores válidos:

  • ACTIVE: la moneda admitida está disponible para su uso.
  • INACTIVE: la moneda admitida no está disponible para su uso.
N/A
virtualCurrency

Indica si la moneda admitida es virtual. Estos son algunos de los valores válidos:

  • true: La moneda admitida es la virtual.
  • false: La moneda admitida no es virtual.
N/A