Habilita la monetización de Apigee

Esta página se aplica a Apigee y Apigee Hybrid.

Consulta la documentación de Apigee Edge.

Antes de que puedas usar la monetización de Apigee, debes comprarla y habilitarla en tu organización. La monetización de Apigee es compatible con los entornos de Apigee y Apigee Hybrid.

Compra la monetización de Apigee

Para comprar la monetización de Apigee para organizaciones basadas en suscripciones, comunícate con Ventas de Apigee y, luego, habilita la monetización de Apigee en tu organización.

La monetización de Apigee no está disponible con las organizaciones de pago por uso.

Las organizaciones de evaluación de Apigee incluyen automáticamente una prueba de monetización de Apigee para el período de prueba. No es necesario que te comuniques con Ventas de Apigee para agregar la monetización. Continúa con Habilita la monetización de Apigee en tu organización.

Habilita la monetización de Apigee en tu organización

Para habilitar la monetización de Apigee en una organización existente, envía una solicitud POST a la siguiente API y pasa la configuración del complemento en el cuerpo de tu solicitud:

https://apigee.googleapis.com/v1/organizations/ORG_NAME:setAddons

Por ejemplo: 

curl "https://apigee.googleapis.com/v1/organizations/ORG_NAME:setAddons" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "addonsConfig": {
      "monetizationConfig": {
          "enabled": "true"
      }
      <Include existing add-on configuration>
    }
  }'

En el ejemplo anterior, $TOKEN está configurado como tu token de acceso de OAuth 2.0, como se describe en Obtén un token de acceso de OAuth 2.0. Para obtener información sobre las opciones de curl que se usan en este ejemplo, consulta Usa curl. Para obtener una descripción de las variables de entorno que puedes usar, consulta Configura variables de entorno para solicitudes a la API de Apigee.

A continuación, se ofrece un ejemplo de la respuesta que muestra que la operación está en curso: 

{
  "name": "organizations/ORG_NAME/operations/1ae3ed56-b38f-4cc1-ba33-e7d89557075d",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
    "operationType": "UPDATE",
    "targetResourceName": "organizations/ORG_NAME",
    "state": "IN_PROGRESS"
  }
}

Para obtener más información, consulta la API de complementos de la organización.

Consulta el perfil de la organización para confirmar que se habilitó la monetización. Por ejemplo: 

curl "https://apigee.googleapis.com/v1/organizations/ORG_NAME" \
  -X GET \
  -H "Authorization: Bearer $TOKEN"

A continuación, se muestra un ejemplo de la respuesta que indica que se habilitó la monetización. 

{
    "name": ORG_NAME,
    ...
    "addonsConfig": {
    "monetizationConfig": {
      "enabled": true
    }
  }
}

Inhabilita la monetización de Apigee en tu organización

Para inhabilitar la monetización de Apigee en tu organización, envía una solicitud POST a la siguiente API y pasa la configuración del complemento en el cuerpo de la solicitud:

https://apigee.googleapis.com/v1/organizations/ORG_NAME:setAddons

Por ejemplo: 

curl "https://apigee.googleapis.com/v1/organizations/ORG_NAME:setAddons" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "addonsConfig": {
      "monetizationConfig": {
          "enabled": "false"
      }
     <Include existing add-on configuration>
    }
  }'

A continuación, se ofrece un ejemplo de la respuesta que muestra que la operación está en curso: 

{
  "name": "organizations/ORG_NAME/operations/06274ffb-8940-41da-836d-781cba190437",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
    "operationType": "UPDATE",
    "targetResourceName": "organizations/ORG_NAME",
    "state": "IN_PROGRESS"
  }
}

Si deseas obtener más información, consulta Configura la API de complementos de la organización.

Consulta el perfil de la organización para confirmar que se inhabilitó la monetización. Por ejemplo: 

curl "https://apigee.googleapis.com/v1/organizations/ORG_NAME" \
  -X GET \
  -H "Authorization: Bearer $TOKEN"

A continuación, se muestra un ejemplo de la respuesta que indica que se habilitó la monetización. 

{
    "name": ORG_NAME,
    ...
    "addonsConfig": {
    "monetizationConfig": {
      "enabled": false
    }
  }
}

Soluciona problemas de habilitación de la monetización de Apigee

Si no compraste la monetización de Apigee e intentas habilitarla, se mostrará el siguiente error:

{
  "error": {
    "code": 400,
    "message": "failed to validate addons config: [Apigee Monetization] addon(s) are not entitled to the subscription",
    "status": "FAILED_PRECONDITION"
  }
}