Administrar monedas admitidas

Estás consultando la documentación de Apigee Edge.
Consulta 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 que se admiten o borrarlas (si un desarrollador o un plan de tarifas no las usan).

Cómo administrar las monedas admitidas con la IU

Administra las monedas admitidas y configura la moneda predeterminada en la sección Impuestos y monedas de la página Perfil de la organización. Consulta Cómo administrar el perfil de la organización mediante la IU para obtener más detalles.

Cómo administrar las monedas admitidas mediante la API

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

Cómo ver las monedas admitidas mediante la API

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

Para ver una moneda individual admitida por tu organización, envía una solicitud GET a /mint/organizations/{org_name}/supported-currencies/{supportedCurrencyId}, en la que {supportedCurrency_id} es la identificación de la moneda admitida que se visualizará. 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
}

Cómo agregar monedas admitidas con la API

Para agregar monedas admitidas, envía una solicitud POST a /mint//organizations/{org_name}/supported-currencies. Para cada moneda admitida que agregues, debes especificar la siguiente información en el cuerpo de la solicitud:

  • Es el nombre de la moneda admitida. El nombre es el código ISO 4217 para la moneda, como USD para el dólar estadounidense.
  • Nombre visible.
  • Descripción.
  • Indica si la moneda es virtual o no.
  • Es el estado de la moneda, es decir, si está disponible o no para su uso.
  • Es la organización a la que se agregará la moneda admitida.

De manera opcional, puedes configurar lo siguiente:

  • Límite de crédito en una moneda admitida (solo para desarrolladores de pospago).
  • Recarga mínima para una moneda admitida (solo para desarrolladores prepagados).

Para obtener más información, consulta las Propiedades de configuración de moneda admitidas.

Por ejemplo, en el siguiente fragmento se agrega una moneda compatible con una organización:

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

Cómo configurar la moneda predeterminada con la API

Para establecer la moneda predeterminada de la organización, establece el valor currency en un código de moneda ISO 4217 compatible cuando edites el perfil de la organización, como se describe en Administra el perfil de la organización mediante la API.

Cómo editar una moneda compatible con la API

Para editar una moneda admitida, emite una solicitud PUT a /mint/organizations/{org_name}/{supportedCurrencyId}, en la que {supportedCurrency_id} es la identificación de la moneda admitida que se actualizará. Debes especificar en el cuerpo de la solicitud las propiedades actualizadas y el ID de moneda admitido. Por ejemplo, la siguiente llamada a la API edita la descripción y el nombre visible de una moneda admitida (las propiedades actualizadas se destacan 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}, en la que {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 la moneda para la API

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

Nombre Descripción Predeterminada ¿Obligatorio?
creditLimit

Esta propiedad solo se aplica a los desarrolladores de pospago. Es el límite de crédito de la moneda admitida.

No disponible No
descripción

Es una descripción de la moneda admitida.

No disponible
displayName

El nombre que se mostrará para la moneda admitida.

No disponible
minimumTopupAmount

Esta propiedad solo se aplica a los desarrolladores prepagados. Importe mínimo que los desarrolladores pueden agregar al saldo de su cuenta prepagada en la moneda especificada.

No disponible No
name

Es el código ISO 4217 para la moneda, como USD para el dólar estadounidense.

No disponible
organización

Es la organización correspondiente a la moneda admitida.

No disponible
de reconocimiento

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: las monedas admitidas no se encuentran disponibles.
No disponible
virtualCurrency

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

  • true: La moneda admitida es la moneda virtual.
  • false: La moneda admitida no es una moneda virtual.
No disponible