Cómo migrar a los desarrolladores a la monetización

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

Si tienes desarrolladores existentes que necesitas migrar a Monetization, sigue estos pasos:

  1. Crea los productos de API, los paquetes de API y los planes de tarifas para los desarrolladores que estás migrando, si aún no existen. Para obtener más información, consulta lo siguiente:
  2. Publica los planes de tarifas, como se describe en Publica planes de tarifas.
  3. Agrega los nuevos desarrolladores a tu organización, como se describe en Registra desarrolladores de apps.
  4. Recarga el saldo prepagado de cada desarrollador, como se describe en Administra saldos de cuentas prepagadas.
  5. Acepta el plan de tarifas, como se describe en Compra planes de tarifas con la API.

    Nota: Para eximir las tarifas de configuración, si ya se le cobró a un desarrollador, establece el waivefees parámetro de consulta en true.

  6. Si un desarrollador que estás migrando tiene transacciones existentes, puedes transferir manualmente el uso de la transacción con el siguiente recurso:
    /organizations/{org_name}/transactions, donde {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 actual de la transacción y actualiza todos los contadores internos para reflejar este nuevo valor.

    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 la transacción en 1,000 llamando al transactions y estableciendo la propiedad batchSize 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
    batchSize

    Es la cantidad de transacciones que deseas 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 debe especificarse como un valor entero o decimal positivo (hasta cuatro decimales). No se permiten valores negativos.

    El atributo personalizado debe definirse en lo siguiente:

    N/A
    product

    Es el ID del producto de API.

    N/A
    type

    Debe establecerse 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 force parámetro de consulta en true (por ejemplo, ?force=true). De forma predeterminada, ?force=false y se ejecutan los pasos de validación. Por ejemplo, si un desarrollador prepagado tiene un saldo cero y la actividad de la cuenta está suspendida, 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
    

    La siguiente solicitud establece el uso de la transacción en 12.5 para la aplicación y el producto de API especificados. En la solicitud, batchSize se establece en 125 y el valor para el primer atributo personalizado definido para el producto de API se establece en 0.1. Cuando se multiplican, 125 * 0.1 es 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
    
  7. Si a un desarrollador no se le cobraron las tarifas de configuración o recurrentes necesarias, puedes cobrar manualmente cobrar una tarifa de configuración o recurrente para un plan de tarifas con el siguiente recurso:
    /organizations/{org_name}/transactions, donde {org_name} es el nombre de la organización.

    Nota: Si ya se le cobraron al desarrollador las tarifas de configuración o recurrentes, puedes omitir este paso. Llamar al recurso transactions no afectará las tarifas de configuración o 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 para 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 el dólar estadounidense o chf para el franco suizo.

    N/A
    developer

    Es el ID del desarrollador.

    N/A
    rate

    Es la tarifa de configuración o recurrente que se cobrará.

    N/A
    ratePlan

    Es el ID del plan de tarifas.

    N/A
    type

    Se establece en SETUPFEES o RECURRINGFEES.

    CHARGE

    Para omitir los pasos de validación y cobrar de forma forzosa la tarifa, establece el force parámetro de consulta en true (por ejemplo, ?force=true). De forma predeterminada, ?force=false y se ejecutan los pasos de validación. Por ejemplo, si un desarrollador prepagado tiene un saldo cero y la actividad de la cuenta está suspendida, si ?force=false la solicitud fallará durante la validación.

    Por ejemplo, la siguiente solicitud cobra una tarifa de configuración de 10 dólares estadounidenses al desarrollador suscrito 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