Administra planes de tarifas

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

Administra los planes de tarifas con la IU y la API, como se describe en las siguientes secciones.

Explora la página de planes de tarifas

Accede a la página de planes de tarifas, como se describe a continuación.

Conexión de integración

Para ver los planes de tarifas en la IU de Edge, accede a la página Planes de tarifas:

  1. Accede a apigee.com/edge.
  2. Selecciona Publicar > Monetización > Planes de tarifas en la barra de navegación izquierda.

Se mostrará la página Planes de tarifas.

Como se destaca en la imagen, la página Planes de tarifas te permite hacer lo siguiente:

Versión clásica de Edge (nube privada)

Para ver los planes de tarifas con la IU de Edge clásica, accede a la página Paquetes de API:

  1. Accede a http://ms-ip:9000, donde ms-ip es la dirección IP o el nombre de DNS del nodo del servidor de administración.
  2. Selecciona Publish > Packages en la barra de navegación superior.

La página Paquetes de API muestra los planes de tarifas definidos para cada paquete.

La página Planes de tarifas te permite hacer lo siguiente:

Crea un plan de tarifas

Sigue estos pasos para crear un plan de tarifas:

  1. Accede a la página Planes de tarifas.
  2. Haz clic en + Plan de tarifas.
  3. Configura los siguientes campos en el panel superior:
    Campo Descripción Predeterminada Obligatorias
    Nombre del plan de tarifas El nombre de tu plan de tarifas.

    NOTA: El nombre debe ser único dentro de un paquete de productos de API. Dos planes del mismo paquete de productos no pueden tener el mismo nombre.

    No disponible
    Tipo de plan de tarifas Tipo de plan de tarifas. Selecciona un valor de la lista desplegable. Para obtener una lista de los tipos de planes de tarifas válidos, consulta Tipos de planes de tarifas admitidos. No disponible
    Paquete de productos Paquete de productos de API. Selecciona un valor de la lista desplegable. Para obtener más información sobre los paquetes de productos de API, consulte Cómo administrar paquetes de productos de API.

    Si seleccionas un paquete de productos que contiene más de un producto de API, debes elegir si deseas configurar planes de tarifas individuales para cada producto de API o un plan de tarifas genérico que se aplique a todos los productos de API.

    No disponible
    Público Público que puede acceder al plan de tarifas. Selecciona uno de los siguientes valores de la lista desplegable:
    • Todos: Todos los desarrolladores.
    • Desarrollador: El desarrollador o la empresa. Ingresa el nombre del desarrollador o la empresa. A medida que escribas, aparecerá una lista de los desarrolladores o las empresas que contengan la cadena en un menú desplegable. Haz clic en el nombre del desarrollador o de la empresa en la lista desplegable.
    • Categoría de desarrollador: Es la categoría de desarrollador. Selecciona la categoría de desarrollador de la lista desplegable.

      Configura las categorías de desarrollador según sea necesario, según se describe en Cómo administrar las categorías de desarrollador.

    Todos No
    Fecha de inicio Fecha en la que entra en vigencia el plan de tarifas. Ingresa una fecha de inicio o selecciona una fecha con el calendario. Hoy No
    Fecha de finalización Fecha de finalización del plan de tarifas. Para especificar una fecha de finalización, habilita el interruptor Tiene una fecha de finalización y, luego, ingresa una fecha de finalización, o bien selecciona una fecha mediante el calendario.

    NOTA: El plan de tarifas estará vigente hasta el fin del día en la fecha especificada. Por ejemplo, si quieres que un plan de tarifas venza el 1 de diciembre de 2018, debes establecer el valor endDate en 2018-11-30. En este caso, el plan de tarifas vencerá al final del día el 30 de noviembre de 2018 y se bloquearán todas las solicitudes del 1 de diciembre de 2018.

    Ninguna No
    Visible para los portales Establece si el plan de tarifas es público o privado. Consulta Planes de tarifas públicos frente a planes privados. Habilitada No
  4. Configura las tarifas del plan de tarifas. Consulta Configura las tarifas de un plan de tarifas.
    NOTA: No es aplicable a los planes de notificación ajustables.
  5. Si seleccionas un paquete de productos que contiene más de un producto de API, configura las siguientes preferencias en la sección Plan de tarifas específico o genérico:
    NOTA: Este paso no es aplicable a los planes de notificación ajustables.
    Campo Descripción Predeterminada
    Configura cada producto de forma individual Marca que especifica si se debe configurar un plan de tarifas individual para cada producto de API. Inhabilitado
    Configura la oferta freemium de cada producto de forma individual Marca que especifica si se debe configurar un plan freemium para cada producto de API. Inhabilitado
    Seleccionar un producto Si habilitas una o ambas marcas, debes seleccionar cada producto de forma individual de la lista desplegable y configurar los detalles de su plan de tarifas.

    NOTA: Asegúrate de configurar todos los productos del paquete de productos.

    No disponible
  6. Configura los detalles del plan de tarifas según el tipo de plan de tarifas seleccionado:
  7. Haz clic en una de las siguientes opciones:
    Botón Descripción
    Guardar como borrador Guarda el plan de tarifas como borrador.

    Los desarrolladores de apps no podrán ver el plan de tarifas hasta que lo publiques. Puedes editar cualquier campo en un borrador del plan de tarifas.

    Publicar plan nuevo Publica el plan.

    NOTA: Después de publicar un plan de tarifas, solo puedes modificar la fecha de finalización si aún no está establecida. No puedes borrar un plan de tarifas después de publicarlo, pero puedes vencerlo y reemplazarlo por uno futuro, como se describe en Cómo vencer un plan de tarifas publicado.

  8. Adjunta la política de verificación de límites de monetización a los proxies de API asociados con los productos de API incluidos en el plan de tarifas. La política de verificación de límites de monetización aplica límites de monetización a los proxies de API y garantiza que cualquier falla se capture con precisión en los informes de estadísticas y de monetización. Para obtener más información, consulta Aplica límites de monetización en proxies de API.

Edita un plan de tarifas

En un borrador de plan de tarifas, puedes editar todos los campos, excepto el paquete de producto, el tipo y el público. Después de publicar un plan de tarifas, puedes editar la fecha de finalización solo si no se especificó una fecha de finalización.

Sigue estos pasos para editar un plan de tarifas:

  1. Accede a la página Planes de tarifas.
  2. Haz clic en la fila del plan de tarifas que deseas editar.
    Se mostrará el panel del plan de tarifas.
  3. Edita los campos del plan de tarifas según sea necesario.
    NOTA: Después de publicar un plan de tarifas, solo puedes modificar la fecha de finalización si aún no está establecida.
  4. Haz clic en una de las siguientes opciones:
    Botón Descripción
    Actualizar borrador (borradores de planes de tarifas) Guarda el plan de tarifas como borrador.

    Los desarrolladores de apps no podrán ver el plan de tarifas hasta que lo publiques. Puedes editar cualquier campo en un borrador del plan de tarifas.
    Publicar borrador (borradores de planes de tarifas) Publica el plan de tarifas.

    NOTA: Después de publicar un plan de tarifas, solo puedes modificar la fecha de finalización si aún no está establecida. No puedes borrar un plan de tarifas después de publicarlo, pero puedes vencerlo y reemplazarlo por uno futuro, como se describe en Cómo vencer un plan de tarifas publicado.
    Fecha de finalización actualizada (planes de tarifas publicados) Establece la fecha de finalización de un plan publicado.

    NOTA: Después de establecer la fecha de finalización para un plan de tarifas publicado, ya no se podrá modificar.

Cómo eliminar un borrador del plan de tarifas

Borra un plan de tarifas preliminar si ya no es necesario.

NOTA: No puedes borrar un plan de tarifas publicado.

Sigue estos pasos para borrar un borrador de plan de tarifas:

  1. Accede a la página Planes de tarifas.
  2. Coloca el cursor sobre el plan de tarifas que deseas borrar para que se muestre el menú de acciones.
  3. Haz clic en .
  4. Haz clic en Borrar para confirmar la acción.

Administra planes de tarifas con la API

En las siguientes secciones, se describe cómo administrar planes de tarifas con la API.

Crea planes de tarifas con la API

Para crear un plan de tarifas, emite una solicitud POST a /organizations/{org_name}/monetization-packages/{monetizationpackage_id}/rate-plans, en la que {monetizationpackage_id} es el ID del paquete de productos de la API para el que creas el plan de tarifas (el ID se muestra en la respuesta cuando creas el paquete de productos de la API).

Cuando creas un plan de tarifas, debes especificar lo siguiente en el cuerpo de la solicitud:

  • ID de organización
  • ID del paquete de productos de API
  • Nombre del plan de tarifas
  • Descripción del plan de tarifas
  • Alcance del plan de tarifas (si se aplica a todos los desarrolladores o solo a una categoría de desarrollador, empresa o desarrollador específico)
  • Fecha en la que entra en vigencia el plan de tarifas
  • Moneda del plan de tarifas
  • Si se debe publicar el plan de tarifas
  • Si el plan de tarifas es público o privado

Existen otras opciones de configuración que puedes especificar de manera opcional, como el período en el que vence el pago (por ejemplo, 30 días). Consulta las propiedades de configuración para los planes de tarifas.

Si creas un plan de tarifas (que no sea un plan de solo tarifas) para un paquete de productos de API que tiene más de un producto, puedes aplicar el plan a un producto específico del paquete de productos. Para ello, identifica el producto en la solicitud. Si no identificas un producto, el plan se aplica a todos los productos del paquete de productos de la API.

En las siguientes secciones, se describe cómo crear planes de tarifas:

Crea un plan de tarifas estándar con la API

Para crear un plan de tarifas estándar, configura el atributo type en STANDARD, como se muestra en el siguiente ejemplo.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Simple rate plan",
     "currency": {
      "id" : "usd"
     },
     "description": "Simple rate plan",
     "displayName" : "Simple rate plan",
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },
     "published": true,
     "isPrivate" : false,
     "ratePlanDetails": [
     {
      …
     }
     ],
     "startDate": "2013-09-15",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location_package/rate-plans" \
-u email:password

Crea un plan de tarifas de empresa o desarrollador con la API

Para aplicar el plan de tarifas a un desarrollador o una empresa específicos, establece el valor de type en Developer. También debes identificar al desarrollador o a la empresa en la solicitud, así como al ID, el nombre legal y el nombre del desarrollador de la empresa.

Por ejemplo, en el siguiente extracto, se crea un plan de tarifas para el desarrollador de Dev Five:

...
     "type": "DEVELOPER",
       "developer" : {
        "id" : "0mkKu1PALUGfjUph",
        "legalName" : "DEV FIVE",
        "name" : "Dev Five"
      }
...

Cómo crear un plan de tarifas de la categoría de desarrollador con la API

Para aplicar el plan de tarifas a una categoría de desarrollador, establece el valor de type en Developer_Category. También debes identificar la categoría de desarrollador en la solicitud. Por ejemplo:

...
     "type": "DEVELOPER_CATEGORY",
       "developerCategory" : {
        "id" : "5e172299-8232-45f9-ac46-40076139f373",
        "name" : "Silver",
        "description" : "Silver category"
      }
...

Crea un plan de tarifas específico para un producto de API con la API

Cuando creas un plan de tarifas para paquetes de productos de API que incluyen varios productos de API, puedes especificar los detalles del plan de tarifas para productos de API de forma individual.

Por ejemplo, lo siguiente crea un plan de porcentaje de ingresos con dos productos de API:

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Multi-product rate plan",
     "currency": {
      "id" : "usd"
     },
     "description": "Multi-product rate plan",
     "displayName" : "Multi-product rate plan",
     "monetizationPackage": {
      "id": "mypackage",
      ...
     },
     "organization": {
      "id": "{org_name}",
      ...
     },
     "published": true,
     "isPrivate" : false,
     "ratePlanDetails": [
     {
        "ratePlanRates":[{
            "revshare":0,
            "startUnit":0,
            "type":"REVSHARE",
            "endUnit":null
        }],
       "revenueType":"NET",
       "type":"REVSHARE"
       "currency":{...},
       "product":{"id":"product1","displayName":"Product1"},
       "customPaymentTerm":false
     },
     {
        "ratePlanRates":[{
            "revshare":10,
            "startUnit":0,
            "type":"REVSHARE",
            "endUnit":null
        }],
       "revenueType":"NET",
       "type":"REVSHARE"
       "currency":{...},
       "product":{"id":"product2","displayName":"Product2"},
       "customPaymentTerm":false
     }
     ],
     "startDate": "2019-09-15",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/my-package/rate-plans" \
-u email:password

Para agregar un producto de API al paquete de productos de API my-package, deberás agregar los detalles del plan de tarifas del producto de API en el cuerpo de la solicitud, como se describe en Agrega un producto de API a un paquete de productos de API con planes de tarifas específicos de productos de API.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
    "ratePlan": [
    {
        "id": "my-package_multi-product-rate-plan",
        "ratePlanDetails": [
        {
            "ratePlanRates":[{
                "revshare":20,
                "startUnit":0,
                "type":"REVSHARE",
                "endUnit":null
             }],
             "revenueType":"NET",
             "type":"REVSHARE"
             "currency":{...},
             "customPaymentTerm":false
         }]
    }]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/my-package/products/product3" \
-u email:password

Configura el plan de tarifas como público o privado con la API

Cuando creas un plan de tarifas, puedes especificar si es público o privado con el atributo isPrivate en el cuerpo de la solicitud. Si se configura como true, el plan de tarifas será privado. Para obtener más información, consulta Planes de tarifas públicos frente a planes privados.

Por ejemplo, lo siguiente crea un plan de tarifas privado:

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Simple rate plan",
     "currency": {
      "id" : "usd"
     },
     "description": "Simple rate plan",
     "displayName" : "Simple rate plan",
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },
     "published": true,
     "isPrivate" : true,
     "ratePlanDetails": [
     {
      …
     }
     ],
     "startDate": "2013-09-15",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location_package/rate-plans" \
-u email:password

Publicar un plan de tarifas con la API

Para publicar un plan de tarifas, configura el valor de la propiedad published como verdadero cuando lo crees. Los desarrolladores podrán ver el plan de tarifas a partir de la fecha especificada en la propiedad startDate del plan.

Por ejemplo, lo siguiente crea un plan de hoja de tarifas y lo publica (solo se muestra una parte de la solicitud):

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Flat rate card plan",
     "developer":null,
     "developerCategory":null,
     "advance": "false",
     …
     "published": "true",
     "ratePlanDetails": [
     …
      ],
     …
     "type": "RATECARD"
     }],
     …
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

Guarda un borrador de plan de tarifas con la API

Para guardar un plan de tarifas sin publicarlo, establece el valor de la propiedad published en falso cuando lo crees.

Por ejemplo, lo siguiente crea un plan de hoja de tarifas y lo guarda como borrador (solo se muestra una parte de la solicitud):

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Flat rate card plan",
     "developer":null,
     "developerCategory":null,
     "advance": "false",
     …
     "published": "false",
     "ratePlanDetails": [
     …
      ],
     …
     "type": "RATECARD"
     }],
     …
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

Editar un borrador del plan de tarifas con la API

Para actualizar un borrador de plan de tarifas, emite una solicitud PUT a /organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_Id}, en la que {package_id} es la identificación del paquete de la API y {plan_Id} es la identificación del plan de tarifas. Cuando realices la actualización, debes especificar en el cuerpo de la solicitud la configuración actualizada y el ID del plan de tarifas. Si actualizas una tarifa del plan de tarifas, también debes especificar el ID de la tarifa. Por ejemplo, la siguiente solicitud actualiza la tarifa del plan de tarifas de un plan de tarifas cuyo ID es location_flat_rate_card_plan (la actualización está destacada):

$ curl -H "Content-Type: application/json" -X PUT -d \
 '{
      "id" : "location_flat_rate_card_plan",
      "name": "Flat rate card plan",
      "advance": "false",
      "currency": {
       "id" : "usd"
      },
      "description": "Flat rate card plan",
      "displayName" : "Flat rate card plan",
      "frequencyDuration": "30",
      "frequencyDurationType": "DAY",
      "earlyTerminationFee": "10",
      "monetizationPackage": {
       "id": "location"
      },
      "organization": {
       "id": "{org_name}"
      },
      "paymentDueDays": "30",
      "prorate": "false",
      "published": "false",
      "ratePlanDetails": [
      {
       "currency": {
        "id" : "usd"
       },
       "paymentDueDays": "30",
       "meteringType": "UNIT",
       "organization": {
        "id": "{org_name}"
       },
       "ratePlanRates": [
        {
         "id" : "26b69b0b-9863-48c9-ba73-74a5b918fcec",
         "type": "RATECARD",
         "rate": "0.15",
         "startUnit": "0"
        }
       ],
      "ratingParameter": "VOLUME",
      "type": "RATECARD"
      }],
      "recurringStartUnit": 1,
      "recurringType": "CALENDAR",
      "recurringFee": "10",
      "setUpFee": "10",
      "startDate": "2013-09-15 00:00:00",
      "type": "STANDARD"
 }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans/location_flat_rate_card_plan" \
-u email:password

La respuesta incluye la tarifa actualizada del plan de tarifas (solo se muestra una parte):

…
"ratePlanRates" : [ {
  "id" : "26b69b0b-9863-48c9-ba73-74a5b918fcec",
  "rate" : 0.15,
  "startUnit" : 0,
  "type" : "RATECARD"
} ],
…

Visualiza planes de tarifas con la API

Para ver los planes de tarifas con la API de monetización, sigue los pasos que se indican en las siguientes secciones.

Visualiza todos los planes de tarifas de una organización que usa la API

Para ver todos los planes de tarifas de una organización, envía una solicitud GET a /mint/organizations/{org_name}/rate-plans, en la que {org_name} es el nombre de la organización.

Puedes pasar los siguientes parámetros de consulta para filtrar los resultados:

Parámetro de consulta Descripción
all Marca que especifica si se muestran todos los planes de tarifas. Si se configura como false, el parámetro de consulta size define la cantidad de planes de tarifas que se muestran por página. La configuración predeterminada es true.
size Cantidad de paquetes de API que se muestran por página. Si el parámetro de consulta all se configura como true, se ignora este parámetro.
page Número de la página que deseas mostrar (si el contenido está paginado). Si el parámetro de consulta all se configura como true, se ignora este parámetro.

Por ejemplo:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/rate-plans" \
  -u email:password

Ver todos los planes de tarifas de un paquete de productos de API mediante la API

Para ver todos los planes de tarifas de un paquete de API, emite una solicitud GET a /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans, en la que {package_id} es el ID del paquete de API (este se muestra cuando creas el paquete de monetización).

Según la configuración predeterminada, solo se muestran en los resultados los planes de tarifas activos, públicos y estándar. Para incluir:

  • En los planes de tarifas borradores o vencidos, establece el parámetro de consulta current en false (por ejemplo, ?current=false).
  • En los planes de tarifas privadas, establece el parámetro de consulta showPrivate en true (por ejemplo, ?showPrivate=true).
  • En todos los planes de tarifas estándar, establece el parámetro de consulta standard en true (por ejemplo, ?standard=true).

Por ejemplo:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/communications/rate-plans" \
  -u email:password

Ver un plan de tarifas para un paquete de API mediante la API

Para ver un plan de tarifas de un paquete de API, emite una solicitud GET a /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_id}, en la que {package_id} es el ID del paquete de la API y {plan_id} es el ID del plan de tarifas (el ID del paquete se muestra cuando creas el paquete de monetización y el ID del plan de tarifas se muestra cuando creas el plan de tarifas).

Por ejemplo:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/communications/rate-plans/communications_standard_fixed_plan" \
  -u email:password

A continuación, se proporciona un ejemplo de la respuesta.

{
   "advance" : true,
   "contractDuration" : 1,
   "contractDurationType" : "YEAR",
   "currency" : {
     "id" : "usd",
     ...
     "organization" : {
       ...
     },
     ...
   },
   "description" : "Standard Fixed Plan",
   "displayName" : "Standard Fixed Plan",
   "earlyTerminationFee" : 0.0000,
   "frequencyDuration" : 1,
   "frequencyDurationType" : "MONTH",
   "id" : "communications_standard_fixed_plan",
   "isPrivate" : false,
   "monetizationPackage" : {
     "description" : "Communications",
     "displayName" : "Communications",
     "id" : "communications",
     "name" : "Communications",
     "organization" : {
      ...
     },
     "product" : [ {
       "customAtt1Name" : "user",
       "description" : "Location",
       "displayName" : "Location",
       "id" : "location",
       "name" : "location",
       "organization" : {
       ...
       },
       "status" : "CREATED"
     }, {
       "customAtt1Name" : "user",
       "description" : "Messaging",
       "displayName" : "Messaging",
       "id" : "messaging",
       "name" : "messaging",
       "organization" : {
         ...
       },
       "status" : "CREATED"
     } ],
     "status" : "CREATED"
   },
   "name" : "Standard Fixed Plan",
   "organization" : {
     ...
   },
   "paymentDueDays" : "30",
   "prorate" : true,
   "published" : true,
   "ratePlanDetails" : [ {
     "aggregateFreemiumCounters" : true,
     "aggregateStandardCounters" : true,
     "currency" : {
       "id" : "usd",
       "name" : "USD",
       "organization" : {
        ...
       },
       "status" : "ACTIVE",
       "virtualCurrency" : false
     },
     "id" : "cb92f7f3-7331-446f-ad63-3e176ad06a86",
     "meteringType" : "UNIT",
     "organization" : {
      ...
     },
     "paymentDueDays" : "30",
     "ratePlanRates" : [ {
       "id" : "07eefdfb-4db5-47f6-b182-5d606c6051c2",
       "rate" : 0.0500,
       "startUnit" : 0,
       "type" : "RATECARD"
     } ],
     "ratingParameter" : "VOLUME",
     "type" : "RATECARD"
   } ],
   "recurringFee" : 200.0000,
   "recurringStartUnit" : 1,
   "recurringType" : "CALENDAR",
   "setUpFee" : 100.0000,
   "startDate" : "2013-01-11 22:00:00",
   "type" : "STANDARD"
 }

Visualiza todos los planes de tarifas activos para un desarrollador que usa la API

Para ver todos los planes de tarifas activos de un desarrollador, envía una solicitud GET a /mint/organizations/{org_name}/developers/{developer_id}/developer-rateplans, en la que {developer_id} es la dirección de correo electrónico del desarrollador.

Puedes pasar los siguientes parámetros de consulta para filtrar los resultados:

Parámetro de consulta Descripción
all Marca que especifica si se deben mostrar todos los paquetes de API. Si se configura como false, el parámetro de consulta size define la cantidad de paquetes de API que se muestran por página. La configuración predeterminada es false.
size Cantidad de paquetes de API que se muestran por página. La configuración predeterminada es 20. Si el parámetro de consulta all se configura como true, se ignora este parámetro.
page Número de la página que deseas mostrar (si el contenido está paginado). Si el parámetro de consulta all se configura como true, se ignora este parámetro.

Por ejemplo:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans" \
  -u email:password

A continuación, se proporciona un ejemplo de la respuesta.

{
  "ratePlan" : [ {
    "advance" : true,
    "contractDuration" : 1,
    "contractDurationType" : "MONTH",
    "currency" : {
      "description" : "United States Dollar",
      "displayName" : "United States Dollar",
      "id" : "usd",
      "name" : "USD",
      "organization" : {
        ...
      },
      "status" : "ACTIVE",
      "virtualCurrency" : false
    },
    "description" : "Fee Only RatePlan",
    "displayName" : "Fee Only RatePlan",
    "earlyTerminationFee" : 10.0000,
    "freemiumDuration" : 0,
    "freemiumDurationType" : "MONTH",
    "freemiumUnit" : 0,
    "frequencyDuration" : 1,
    "frequencyDurationType" : "WEEK",
    "id" : "messaging_package_fee_only_rateplan",
    "isPrivate" : false,
    "monetizationPackage" : {
      "description" : "messaging package",
      "displayName" : "Messaging Package",
      "id" : "messaging_package",
      "name" : "Messaging Package",
      "organization" : {
        ...
      },
      "product" : [ {
        "customAtt1Name" : "user",
        "customAtt2Name" : "response size",
        "customAtt3Name" : "content-length",
        "description" : "messaging api product",
        "displayName" : "messaging",
        "id" : "messaging",
        "name" : "messaging",
        "organization" : {
         ...
        },
        "status" : "CREATED",
        "transactionSuccessCriteria" : "status == 'SUCCESS'"
      } ],
      "status" : "CREATED"
    },
    "name" : "Fee Only RatePlan",
    "organization" : {
     ...
    },
    "paymentDueDays" : "30",
    "prorate" : false,
    "published" : true,
    "ratePlanDetails" : [ ],
    "recurringFee" : 10.0000,
    "recurringStartUnit" : 1,
    "recurringType" : "CALENDAR",
    "setUpFee" : 20.0000,
    "startDate" : "2013-02-20 00:00:00",
    "type" : "STANDARD"
  } ],
  "totalRecords" : 1
}

Ver un plan de tarifas aceptado para un desarrollador que usa la API

Si quieres ver un plan de tarifas activo para un desarrollador, envía una solicitud GET a /mint/organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id}, en la que {developer_id} es la dirección de correo electrónico del desarrollador y {developer_rateplan_id} es el ID del plan de tarifas aceptado que se muestra en la respuesta cuando aceptas el plan de tarifas publicado.

Por ejemplo:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/messaging_package_fee_only_rateplan" \
  -u email:password

A continuación, se proporciona un ejemplo de la respuesta.

{
    "created" : "2018-01-25 20:01:54",
    "developer" : {
    },
    "id" : "a73s104-276f-45b3-8075-83d1046ea550",
    "nextCycleStartDate" : "2018-02-19 00:00:00",
    "nextRecurringFeeDate" : "2018-02-19 00:00:00",
    "prevRecurringFeeDate" : "2018-01-25 00:00:00",
    "ratePlan" : {
      "frequencyDuration" : 1,
      "frequencyDurationType" : "MONTH",
      "recurringFee" : 0.0000,
      "recurringStartUnit" : 19,
      "recurringType" : "CALENDAR",
      "setUpFee" : 0.0000,
      "type" : "STANDARD"
    },
    "startDate" : "2018-01-25 20:01:54",
    "updated" : "2018-01-25 20:01:54"
  }

Ver un plan de tarifas aceptado para un desarrollador que contiene un producto de API que usa la API

Para ver un plan de tarifas aceptado de un desarrollador que contiene un producto de API, envía una solicitud GET a /mint/organizations/{org_id}/developers/{developer_id}/products/{product_id}/rate-plan-by-developer-product, en la que {developer_id} es el ID del desarrollador y /{product_id} es el ID del producto.

De forma predeterminada, solo se muestra un plan de tarifas público en los resultados. Para mostrar un plan de tarifas privado, establece el parámetro de consulta showPrivate en true (por ejemplo, ?showPrivate=true).

Por ejemplo:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/products/location/rate-plan-by-developer-product" \
  -u email:password

Visualiza todos los planes de tarifas que aceptó un desarrollador mediante la API

Para ver los planes de tarifas que aceptó un desarrollador, emite una solicitud GET a /mint/organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans, en la que {developer_id} es el ID del desarrollador.

Puedes pasar los siguientes parámetros de consulta para filtrar los resultados:

Parámetro de consulta Descripción
all Marca que especifica si se deben mostrar todos los paquetes de API. Si se configura como false, el parámetro de consulta size define la cantidad de paquetes de API que se muestran por página. La configuración predeterminada es false.
size Cantidad de paquetes de API que se muestran por página. La configuración predeterminada es 20. Si el parámetro de consulta all se configura como true, se ignora este parámetro.
page Número de la página que deseas mostrar (si el contenido está paginado). Si el parámetro de consulta all se configura como true, se ignora este parámetro.

Por ejemplo:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-accepted-rateplans" \
  -u email:password

A continuación, se proporciona un ejemplo de la respuesta.

{
  "developerRatePlan" : [ {
     "created" : "2018-01-25 20:01:54",
     "developer" : { ...
     },
     "id" : "a73s104-276f-45b3-8075-83d1046ea550",
     "nextCycleStartDate" : "2018-02-19 00:00:00",
     "nextRecurringFeeDate" : "2018-02-19 00:00:00",
     "prevRecurringFeeDate" : "2018-01-25 00:00:00",
     "ratePlan" : {
       "frequencyDuration" : 1,
       "frequencyDurationType" : "MONTH",
       "recurringFee" : 0.0000,
       "recurringStartUnit" : 19,
       "recurringType" : "CALENDAR",
       "setUpFee" : 0.0000,
       "type" : "STANDARD"
     },
     "startDate" : "2018-01-25 20:01:54",
     "updated" : "2018-01-25 20:01:54"
   }],
   "totalRecords" : 1
}

Borrar un borrador del plan de tarifas con la API

Para borrar un borrador de un plan de tarifas, envía una solicitud DELETE a /organizations/{org_name}/monetization-packages/package_id}/rate-plans/{plan_Id}, en la que {plan_Id} es la identificación del plan de tarifas que se borrará y {package_id} es la identificación del paquete de la API para el plan de tarifas. Por ejemplo:

$ curl -H "Accept:application/json" -X DELETE \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans/location_flat_rate_card_plan" \
-u email:password

Propiedades de configuración para los planes de tarifas

Cuando creas un plan de tarifas con la API, puedes especificar los siguientes parámetros de configuración.

Nombre Descripción Predeterminada ¿Obligatorio?
advance

La promoción solo es válida para tarifas recurrentes. Marca que especifica si la tarifa recurrente se cobra por adelantado o no. Estos son algunos de los valores válidos:

  • true: La tarifa recurrente se cobra por adelantado. Por ejemplo, si el período es de 1 mes, la tarifa recurrente se cobra en la factura generada cuando finaliza el mes de facturación anterior.
  • false: La tarifa recurrente se cobra al final del período. Por ejemplo, si el período es de 1 mes, se cobrará la tarifa recurrente en la factura cuando finalice el mes de facturación en curso. Esta es la opción predeterminada.
false No
contractDuration

Duración del contrato del plan junto con contractDurationType. Por ejemplo, para especificar una duración del contrato de 6 meses, configura contractDuration en 6 y contractDurationType en MONTH.

No disponible No
contractDurationType

Duración del contrato del plan junto con contractDuration. Entre los valores válidos, se incluyen los siguientes:

  • DAY
  • WEEK
  • MONTH
  • QUARTER
  • YEAR
No disponible No
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
description

Descripción del plan de tarifas.

No disponible
developer

ID de desarrollador (dirección de correo electrónico) Especifica solo para los planes de tarifas de desarrolladores.

No disponible No
developerCategory

ID de la categoría del desarrollador. Especifícalo solo para los planes de tarifas de categorías de desarrolladores.

No disponible No
displayName

Es el nombre visible fácil de usar del plan de tarifas.

No disponible
earlyTerminationFee

Tarifa única que se cobra si el desarrollador finaliza el plan antes del período de renovación.

No disponible No
endDate

Fecha de finalización del plan Los desarrolladores no podrán ver el plan de tarifas después de esta fecha. Si no quieres que el plan de tarifas finalice en una fecha específica, establece un valor nulo para endDate.

El plan de tarifas estará vigente hasta el final del día en la fecha especificada. Por ejemplo, si quieres que un plan de tarifas venza el 1 de diciembre de 2016, debes configurar el valor de endDate en 2016-11-30. En este caso, el plan de tarifas vencerá al final del día el 30 de noviembre de 2016 y se bloquearán todas las solicitudes del 1 de diciembre de 2016.

NOTA: Cuando visualizas el plan de tarifas con la API, la marca de tiempo endDate se especifica como YYYY-MM-DD 00:00:00, lo que puede ser engañoso.

No disponible No
freemiumDuration

Período del período freemium junto con freemiumDurationType. Por ejemplo, para especificar que el período freemium es de 30 días, establece freemiumDuration en 30 y freemiumDurationType en DAY.

No disponible No
freemiumDurationType

Período del período freemium junto con freemiumDuration. Estos son algunos de los valores válidos:

  • DAY
  • WEEK
  • MONTH
  • QUARTER
  • YEAR
No disponible No
freemiumUnit

Cantidad freemium. El valor puede ser el número de transacciones o la cantidad de unidades correspondientes a un atributo personalizado registrado en la política de registro de transacciones.

No disponible No
frequencyDuration

La promoción solo es válida para tarifas recurrentes. Período entre los cargos recurrentes de tarifas junto con el valor frequencyDurationType. Por ejemplo, para especificar que el período entre los cargos de tarifa es de 30 días, establece frequencyDuration en 30 y frequencyDurationType en DAY.

No disponible No
frequencyDurationType La promoción solo es válida para tarifas recurrentes. Período entre los cargos recurrentes de tarifas junto con el valor frequencyDuration. Entre los valores válidos, se incluyen los siguientes:
  • DAY
  • WEEK
  • MONTH
  • QUARTER
  • YEAR
No disponible No
isPrivate Marca que especifica si el plan de tarifas es público o privado. La configuración predeterminada es false (pública). Para obtener más información, consulta Planes de tarifas públicos versus privados. No disponible No
monetizationPackage

Es el ID del paquete de productos de la API para el plan de tarifas.

No disponible No
name

Es el nombre del plan de tarifas.

No disponible
organization

Es el ID de organización del plan de tarifas.

No disponible
paymentDueDays

La promoción solo es válida para tarifas recurrentes. La cantidad de días que vencen las tarifas. Por ejemplo, configura el valor en 30 para indicar que las tarifas vencen en 30 días.

No disponible No
proRate

La promoción solo es válida para tarifas recurrentes. Marca que especifica si se prorratea la tarifa recurrente cuando un desarrollador inicia o finaliza un plan a lo largo de un mes. Entre los valores válidos, se incluyen los siguientes:

  • true: La tarifa inicial se prorratea en función de la cantidad de días hasta el final del período (o la cantidad de días que se usan en el período).
  • false: Se cobra la tarifa inicial completa al desarrollador, independientemente de cuándo inicia (o finaliza) el plan. Esta es la opción predeterminada.
false No
published

Marca que especifica si se debe publicar o no el plan de tarifas para que lo vean los desarrolladores. Estos son algunos de los valores válidos:

  • true: Publica el plan de tarifas.
  • false: No se publica el plan de tarifas.
No disponible
ratePlanDetails

Detalles del plan de tarifas (consulta las propiedades de configuración para ver los detalles del plan de tarifas).

No disponible
recurringFee

Tarifa que se le cobra al desarrollador de manera continua hasta que finaliza el plan.

No disponible No
recurringStartUnit

La promoción es válida solo si se configura recurringType como CALENDAR. Día del mes en el que se cobra la tarifa recurrente. Por ejemplo, si la tarifa recurrente se cobra de forma mensual y el valor de recurringStartUnit se establece en 1, esta se cobrará el primer día de cada mes.

No disponible No
recurringType

Programar para la tarifa recurrente. Estos son algunos de los valores válidos:

  • CALENDAR: Programado en función de un calendario.
  • CUSTOM: Programada en función de un parámetro de configuración de fecha personalizado.
No disponible No
setUpFee

Tarifa única que se cobra a cada desarrollador en la fecha de inicio del plan (es decir, la fecha en la que el desarrollador compra el plan).

No disponible No
startDate

Fecha de inicio del plan. Los desarrolladores pueden ver el plan de tarifas a partir de esta fecha.

No disponible
type

Es el tipo de plan de tarifas. Especifica una de las siguientes opciones:

  • STANDARD. Se aplica a todos los desarrolladores.
  • DEVELOPER_CATEGORY: Se aplica a todos los desarrolladores de la categoría seleccionada.
  • DEVELOPER. Se aplica a un desarrollador o a una empresa específica.
No disponible

Propiedades de configuración para los detalles del plan de tarifas

Puedes especificar cualquiera de las siguientes propiedades de configuración como parte del arreglo ratePlanDetails cuando creas el plan de tarifas.

Nombre Descripción Predeterminada ¿Obligatorio?
aggregateFreemiumCounters

Marca que especifica si los contadores agregados están habilitados para determinar si el uso de un producto de API está dentro del rango libre. Los contadores agregados deben habilitarse para configurar un plan freemium para un producto. Estos son algunos de los valores válidos:

  • true: Habilita contadores agregados.
  • false: No habilita los contadores agregados.
No disponible No
aggregateStandardCounters

Marca que especifica si se deben usar los contadores agregados para determinar la banda de uso (como una banda de volumen para un plan de hoja de tarifas). El valor puede ser uno de los siguientes:

  • true: Usa contadores agregados.
  • false: No usa contadores agregados.
No disponible No
aggregateTransactions

NOTA: Actualmente, la monetización no usa esta propiedad, por lo que puedes ignorarla.

true No
currency

Moneda.

No disponible No
duration

Período para la frecuencia del cálculo, junto con durationType, en el que los valores duration permitidos son del 1 al 24.

Por ejemplo, configura duration en 2 y durationType en MONTH para especificar una frecuencia de cálculo de 2 meses.

No disponible No
durationType

Período para la frecuencia del cálculo, junto con duration. El único valor válido es MONTH.

Consulta duration para ver un ejemplo de uso.

No disponible No
freemiumDuration

Período del período freemium para un producto de API individual, junto con freemiumDurationType. Por ejemplo, para especificar que el período freemium de un producto de API es de 30 días, establece freemiumDuration en 30 y freemiumDurationType en DAY.

No disponible No
freemiumDurationType

Período del período freemium para un producto de API individual, junto con freemiumDuration. Estos son algunos de los valores válidos:

  • DAY
  • WEEK
  • MONTH
  • QUARTER
  • YEAR

Por ejemplo, para especificar que el período freemium de un producto de API es de 30 días, establece freemiumDuration en 30 y freemiumDurationType en DÍA.

No disponible No
freemiumUnit

Cantidad freemium para un producto de API. El valor puede ser la cantidad de transacciones o la cantidad de unidades pertenecientes a un atributo personalizado registrado en la política de registro de transacciones.

No disponible No
meteringType

Modelo de cobro por un plan de hoja de tarifas. Estos son algunos de los valores válidos:

  • UNIT: modelo de carga de tarifa plana.
  • VOLUME: modelo de carga con bandas de volumen.
  • STAIR_STEP: Modelo de carga en paquetes.
  • DEV_SPECIFIC: Modelo de carga de notificaciones ajustable. No es válido para ningún otro modelo de ingresos.
No disponible
organization

ID de la organización

No disponible No
paymentDueDays

Fecha límite de pago para un desarrollador de pospago. Por ejemplo, establece el valor en 30 para indicar que el pago vence en 30 días.

No disponible No
product

Información del producto de la API, como el ID

No disponible No
ratePlanRates

Detalles del plan de tarifas, como el tipo de plan de tarifas (REVSHARE o RATECARD), la tarifa de un plan de hoja de tarifas, el porcentaje de ingresos de un plan de porcentaje de ingresos y el rango (unidad inicial y final para el que se aplica la tarifa del plan de tarifas).

No disponible
ratingParameter

Base del plan de tarifas. El plan de tarifas se basa en transacciones o en un atributo personalizado. Estos son algunos de los valores válidos:

  • VOLUME: El plan de tarifas se basa en el volumen de transacciones.
  • custom_attribute : nombre de un atributo personalizado que está definido en la política de registro de transacciones del producto de API y es válido solo para los planes de hojas de tarifas. El nombre del atributo personalizado no se puede definir como VOLUME.
VOLUME
ratingParameterUnit

La unidad que se aplica al ratingParameter. Only required if ratingParameter se configura como un atributo personalizado (es decir, no se establece en VOLUME).

No disponible
revenueType

Es la base del porcentaje de ingresos de un plan de porcentaje de ingresos. Estos son algunos de los valores válidos:

  • GROSS: El porcentaje de ingresos se basa en un porcentaje del precio bruto de una transacción.
  • NET: El porcentaje de ingresos se basa en un porcentaje del precio neto de una transacción.
No disponible No
type

Tipo de plan de tarifas. Estos son algunos de los valores válidos:

  • REVSHARE: modelo de porcentaje de ingresos.
  • RATECARD: Modelo de hoja de tarifas.
  • REVSHARE_RATECARD: Porcentaje de ingresos y modelo de hoja de tarifas.
  • USAGE_TARGET: Modelo de notificación ajustable.

Para obtener más información sobre los tipos de planes de tarifas, consulta Tipos de planes de tarifas admitidos.

No disponible