Administrar monedas admitidas

Estás viendo la documentación de Apigee Edge.
Ir a la documentación de Apigee X. info

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 monedas admitidas o borrar monedas admitidas (si un desarrollador o un plan de tarifas no las usan).

Administra monedas admitidas con la IU

Administra las monedas admitidas y establece la moneda predeterminada en la sección Impuestos y moneda de la página Perfil de la organización. Consulta Administra el perfil de la organización con la IU para obtener más información.

Administra monedas admitidas con la API

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

Visualiza monedas admitidas con la API

Visualiza una moneda individual admitida por tu organización o todas las monedas admitidas por 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}, donde {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 admitidas por 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
}

Agrega 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:

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

De manera opcional, puedes establecer lo siguiente:

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

Consulta Propiedades de configuración de monedas admitidas para obtener más información.

Por ejemplo, el siguiente código agrega una moneda admitida para 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

Establece 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 admitido cuando edites el perfil de la organización, como se describe en Administra el perfil de la organización con la API.

Edita una moneda admitida con la API

Para editar una moneda admitida, envía una solicitud PUT a /mint/organizations/{org_name}/{supportedCurrencyId}, donde {supportedCurrency_id} es la identificación de la moneda admitida que se actualizará. Debes especificar en el cuerpo de la solicitud las propiedades actualizadas así como el ID de la 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 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

Borra una moneda admitida con 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 monedas para la API

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