Estás viendo la documentación de Apigee Edge.
Ve a la
documentación de Apigee X. info
Si tienes desarrolladores existentes que deben migrar a la monetización, haz lo siguiente:
- Crea los productos de API, los paquetes de API y los planes de tarifas para los desarrolladores a los que migrarás, si aún no existen. Para obtener más información, consulta los siguientes vínculos:
- Publica los planes de tarifas, como se describe en Publicación de planes de tarifas.
- Agrega los desarrolladores nuevos a tu organización, como se describe en Registra desarrolladores de apps.
- Recarga el saldo prepagado de cada desarrollador, como se describe en Administra los saldos de cuenta prepaga.
- Acepta el plan de tarifas, como se describe en Planes de tarifas de compra con la API.
Nota: Para renunciar a las tarifas de configuración, si ya se le cobró a un desarrollador, establece el parámetro de consulta
waivefees
entrue
. - Si un desarrollador al que migras tiene transacciones existentes, puedes transferir el uso de las transacciones de forma manual con el siguiente recurso:
/organizations/{org_name}/transactions
, en el que{org_name}
es el nombre de la organización.Nota: Si un desarrollador no tiene transacciones existentes, puedes omitir este paso.
El recurso
transactions
inserta una sola transacción que refleja el uso de la transacción actual y actualiza todos los contadores internos para reflejar este valor nuevo.Por ejemplo, si el desarrollador emitió 1,000 llamadas a la API antes de la migración, para capturar la actividad actual, puedes establecer el uso de transacciones en 1,000 llamando al recurso
transactions
y configurando la propiedadbatchSize
en 1,000 en el cuerpo de la solicitud.En la siguiente tabla, se resumen las propiedades de configuración que puedes especificar en el cuerpo de la solicitud para establecer manualmente la cantidad de transacciones, sus valores predeterminados y si son obligatorias o no.
Propiedad Descripción Predeterminado ¿Obligatorio? application
Es el ID de la app de desarrollador.
N/A Sí batchSize
Cantidad de transacciones que quieres transferir.
1 No custAttn
Es el valor del atributo personalizado que se usa con batchSize para calcular el uso de la transacción.
El número de atributo personalizado en el mensaje se debe especificar como un valor positivo entero o decimal (hasta cuatro decimales). No se permiten valores negativos.
El atributo personalizado se debe definir en los siguientes lugares:
- Política de registro de transacciones para el producto de API. Consulta Configura una política de registro de transacciones.
- Es el plan de tarifas activo para el producto de la API. Consulta Configura un plan de tarifas con atributos personalizados.
N/A Sí product
Es el ID del producto de API.
N/A Sí type
Se debe establecer en
CHARGE
(que es el valor predeterminado).CHARGE
No Para omitir los pasos de validación y establecer de forma forzosa la cantidad de transacciones, establece el parámetro de consulta
force
entrue
(por ejemplo,?force=true
). De forma predeterminada, se ejecutan?force=false
y los pasos de validación. Por ejemplo, si un desarrollador con una cuenta prepagada tiene saldo de cero y se suspende la actividad en la cuenta, si?force=false
la solicitud fallará durante la validación.Por ejemplo, la siguiente solicitud establece la cantidad de transacciones en 50 para la aplicación y el producto de API especificados:
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "application":{ "id":"6a9b1afc-2110-43d6-bae7-1b137aecb05b" }, "product":{ "id":"testproduct" }, "batchSize":50 }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/myOrg/transactions" \ -u email:password
En la siguiente solicitud, se establece el uso de transacciones en 12.5 para la aplicación y el producto de API especificados. En la solicitud,
batchSize
se establece en125
, y el valor del primer atributo personalizado definido para el producto de API se establece en0.1
. Cuando se умножается, 125 × 0.1 = 12.5.$ curl -H "Content-Type:application/json" -X POST -d \ '{ "application":{ "id":"6a9b1afc-2110-43d6-bae7-1b137aecb05b" }, "product":{ "id":"testproduct" }, "batchSize": 125, "custAtt1" : 0.1 }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/myOrg/transactions" \ -u email:password
- Si a un desarrollador no se le cobraron las tarifas recurrentes o de configuración necesarias, puedes cobrar
de forma manual una tarifa de configuración o una tarifa recurrente de un plan de tarifas con el siguiente recurso:
/organizations/{org_name}/transactions
, en el que{org_name}
es el nombre de la organización.Nota: Si ya se le cobraron al desarrollador las tarifas de configuración o las tarifas recurrentes, puedes omitir este paso. Llamar al recurso
transactions
no afectará las tarifas de configuración ni las tarifas recurrentes definidas por el plan de tarifas.En la siguiente tabla, se resumen las propiedades de configuración que puedes especificar en el cuerpo de la solicitud para cobrar manualmente una tarifa de configuración o recurrente por un plan de tarifas, sus valores predeterminados y si son obligatorias o no.
Propiedad Descripción Predeterminado ¿Obligatorio? currency
Es la moneda que se usa para el plan de tarifas. Especifica el código ISO 4217 de la moneda, como usd para dólares estadounidenses o chf para francos suizos.
N/A Sí developer
Es el ID del desarrollador.
N/A Sí rate
Configuración o tarifa recurrente que se cobrará.
N/A Sí ratePlan
ID del plan de tarifas.
N/A Sí type
Establecido en
SETUPFEES
oRECURRINGFEES
.CHARGE
Sí Para omitir los pasos de validación y cobrar la tarifa de forma forzosa, establece el parámetro de consulta
force
entrue
(por ejemplo,?force=true
). De forma predeterminada, se ejecutan?force=false
y los pasos de validación. Por ejemplo, si un desarrollador con una cuenta prepagada tiene saldo de cero y se suspende la actividad en la cuenta, si?force=false
, la solicitud fallará durante la validación.Por ejemplo, la siguiente solicitud cobra una tarifa de configuración de USD 10 al desarrollador que se suscribió al plan de tarifas:
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "developer":{ "id":"dev1@myorg.com" }, "currency":{ "id":"usd" }, "ratePlan":{ "id":"mypackage_rateplan1" }, "rate":10, "type":"SETUPFEES" }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/myOrg/transactions" \ -u email:password