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

Estás consultando la documentación de Apigee Edge.
Consulta la documentación de Apigee X.
Información

Si tienes desarrolladores que deban migrar a la función de monetización, ten en cuenta lo siguiente:

  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 los siguientes vínculos:
  2. Publica los planes de tarifas, como se describe en Cómo publicar los planes de tarifas.
  3. Agrega los desarrolladores nuevos a tu organización, como se describe en Registra desarrolladores de apps.
  4. Agrega dinero al saldo prepagado de cada desarrollador según se describe en Administra saldos de cuentas prepagas.
  5. Acepta el plan de tarifas, como se describe en Planes de porcentaje de compra con la API.

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

  6. Si un desarrollador que migras tiene transacciones existentes, puedes transferir manualmente el uso de transacciones mediante 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 actual de la transacción 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 la transacción en 1,000. Para ello, llama al recurso transactions y configura 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 configurar de forma manual la cantidad de transacciones, sus valores predeterminados y si son obligatorias o no.

    Propiedad Descripción Predeterminada ¿Obligatorio?
    application

    ID de la app del desarrollador.

    No disponible
    batchSize

    Cantidad de transacciones que quieres transferir.

    1 No
    custAttn

    Valor del atributo personalizado que se usa con batchSize para calcular el uso de la transacción.

    El número de atributo personalizado del mensaje debe especificarse como un valor entero positivo o decimal (hasta cuatro decimales). No se permiten valores negativos.

    El atributo personalizado se debe definir de la siguiente manera:

    No disponible
    product

    ID del producto de API.

    No disponible
    type

    Debe configurarse en CHARGE (que es la opción predeterminada).

    CHARGE No

    Para omitir los pasos de validación y forzar la cantidad de transacciones, establece el parámetro de consulta force en true (por ejemplo, ?force=true). De forma predeterminada, se ejecutan ?force=false y los pasos de validación. Por ejemplo, si un desarrollador prepagado tiene un saldo de cero y la actividad en la cuenta se suspende, 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 transacciones en 12.5 para la aplicación y el producto de API especificados. En la solicitud, batchSize se establece en 125, y el valor del 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 cobró la configuración necesaria ni las tarifas recurrentes, puedes cobrar de forma manual una configuración o una tarifa recurrente por un plan de tarifas mediante el siguiente recurso:
    /organizations/{org_name}/transactions, donde {org_name} es el nombre de la organización.

    Nota: Si ya se le cobró al desarrollador la configuración o las tarifas recurrentes, puedes omitir este paso. Llamar al recurso transactions no afectará la configuración ni las tarifas recurrentes definidas en 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 de forma manual una configuración o una tarifa recurrente en un plan de tarifas, sus valores predeterminados y si son necesarios o no.

    Propiedad Descripción Predeterminada ¿Obligatorio?
    currency

    Es la moneda que se usa para el plan de tarifas. Especifica el código ISO 4217 para la moneda, como usd para el dólar estadounidense o chf para el franco suizo.

    No disponible
    developer

    ID del desarrollador.

    No disponible
    rate

    Configuración o tarifa recurrente que se cobrará.

    No disponible
    ratePlan

    ID del plan de tarifas.

    No disponible
    type

    Establecido en SETUPFEES o RECURRINGFEES.

    CHARGE

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

    Por ejemplo, en la siguiente solicitud, se 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