Habilitar la monetización de Apigee

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

Consulta la documentación de Apigee Edge.

Para poder usar la monetización de Apigee, debe comprarla y habilitarla en su organización. La monetización de Apigee es compatible con los entornos de Apigee y Apigee Hybrid.

Comprar la monetización de Apigee

Para comprar la monetización de Apigee para organizaciones con suscripción, ponte en contacto con el equipo de ventas de Apigee y, a continuación, habilita la monetización de Apigee en tu organización.

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

Las organizaciones de evaluación de Apigee incluyen automáticamente una prueba de monetización de Apigee durante el periodo de prueba. No es necesario que te pongas en contacto con el equipo de Ventas de Apigee para añadir la monetización. Ve a Habilitar la monetización de Apigee en tu organización.

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

Para habilitar la monetización de Apigee en una organización, envía una solicitud POST a la siguiente API: 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": "true"
      }
      <Include existing add-on configuration>
    }
  }'

Donde $TOKEN es tu token de acceso OAuth 2.0, tal como se describe en Obtener un token de acceso OAuth 2.0. Para obtener información sobre las opciones de curl que se usan en este ejemplo, consulta Usar curl. Para ver una descripción de las variables de entorno que puedes usar, consulta Definir variables de entorno para solicitudes a la API de Apigee.

A continuación se muestra un ejemplo de la respuesta que indica 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 el artículo sobre la API para configurar complementos de la organización.

Consulta el perfil de la organización para confirmar que la monetización se ha habilitado. 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 la monetización está habilitada.

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

Inhabilitar 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 e incluye 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 muestra un ejemplo de la respuesta que indica 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"
  }
}

Para obtener más información, consulta la API Configure organization add-ons.

Consulta el perfil de la organización para confirmar que la monetización se ha inhabilitado. 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 la monetización está habilitada.

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

Solucionar problemas al habilitar la monetización de Apigee

Si no has comprado la monetización de Apigee e intentas habilitarla, se devuelve 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"
  }
}