Habilitar 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. Ten en cuenta que, por el momento, la monetización de Apigee no es compatible con los entornos híbridos.

Compra la monetización de Apigee

Si deseas comprar monetización de Apigee para organizaciones basadas en suscripciones, haz lo siguiente:

  1. Verifica que la monetización de Apigee esté incluida en tu suscripción a Apigee. Consulta Derechos de Apigee.
  2. Comunícate con Ventas de Apigee para adquirir la monetización de Apigee si es necesario.

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:setAddons

Por ejemplo:

curl "https://apigee.googleapis.com/v1/organizations/$ORG: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. Si deseas obtener una descripción de las variables de entorno que se usaron, 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/operations/1ae3ed56-b38f-4cc1-ba33-e7d89557075d",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
    "operationType": "UPDATE",
    "targetResourceName": "organizations/$ORG",
    "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 la monetización se habilitó. Por ejemplo: 

curl "https://apigee.googleapis.com/v1/organizations/$ORG" \
  -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,
    ...
    "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, emite 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:setAddons

Por ejemplo:

curl "https://apigee.googleapis.com/v1/organizations/$ORG: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/operations/06274ffb-8940-41da-836d-781cba190437",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
    "operationType": "UPDATE",
    "targetResourceName": "organizations/$ORG",
    "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" \
  -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,
    ...
    "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"
  }
}