Estás viendo la documentación de Apigee Edge.
Ve a la documentación de Apigee X. Más 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 monedas compatibles o borrarlas (si un desarrollador o un plan de tarifas no las usa).
Cómo administrar las monedas admitidas con la IU
Administra las monedas admitidas y configura la moneda predeterminada en la sección Impuesto y moneda de la página Perfil de la organización. Consulta Cómo administrar el perfil de la organización con la IU para obtener más información.
Cómo administrar las monedas admitidas con la API
Administra las monedas admitidas con la API, como se describe en las siguientes secciones.
Cómo ver las monedas admitidas con la API
Consulta una moneda individual que admita tu organización o todas las monedas que admita.
Para ver una moneda individual compatible con 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 compatible que se mostrará. 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 corresponde al código ISO 4217 de la moneda, como USD para el dólar de los Estados Unidos.
- 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 establecer lo siguiente:
- Límite de crédito para una moneda admitida (solo para desarrolladores con pospago).
- Es la recarga mínima para una moneda admitida (solo para desarrolladores de prepago).
Consulta Propiedades de configuración de moneda compatibles para obtener más información.
Por ejemplo, lo siguiente 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
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 Cómo administrar el perfil de la organización con la API.
Cómo editar una moneda admitida 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 compatible. 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 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 la 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 | Predeterminado | ¿Obligatorio? |
|---|---|---|---|
| creditLimit |
Esta propiedad solo se aplica a los desarrolladores de pospago. Es el límite de crédito de la moneda admitida. |
N/A | No |
| descripción |
Es una descripción de la moneda admitida. |
N/A | Sí |
| displayName |
Es el nombre que se mostrará para la moneda admitida. |
N/A | Sí |
| minimumTopupAmount |
Esta propiedad se aplica solo a los desarrolladores con suscripciones prepagadas. Es el importe mínimo que los desarrolladores pueden agregar al saldo de su cuenta prepagada en la moneda especificada. |
N/A | No |
| nombre |
El código ISO 4217 de la moneda, como USD para dólares estadounidenses. |
N/A | Sí |
| organización |
Es la organización de la moneda admitida. |
N/A | Sí |
| estado |
Es el estado de la moneda admitida. Estos son algunos de los valores válidos:
|
N/A | Sí |
| virtualCurrency |
Indica si la moneda admitida es virtual. Estos son algunos de los valores válidos:
|
N/A | Sí |