Ative a rentabilização do Apigee

Esta página aplica-se ao Apigee e ao Apigee Hybrid.

Veja a documentação do Apigee Edge.

Antes de poder usar a rentabilização do Apigee, tem de a comprar e ativar na sua organização. A rentabilização do Apigee é suportada para ambientes do Apigee e do Apigee Hybrid.

Nota: consulte o problema conhecido 355714868 para ver um problema relacionado com os dados de taxas recorrentes, de configuração e de recarga da rentabilização do Apigee em ambientes híbridos.

Compre a rentabilização do Apigee

Para comprar a rentabilização do Apigee para organizações de subscrição, contacte as vendas do Apigee e, de seguida, ative a rentabilização do Apigee na sua organização.

A rentabilização do Apigee não está disponível para organizações com pagamento conforme o uso.

As organizações de avaliação do Apigee incluem automaticamente uma avaliação da rentabilização do Apigee durante o período de avaliação. Não precisa de contactar a equipa de vendas do Apigee para adicionar a rentabilização. Continue para ativar a rentabilização do Apigee na sua organização.

Ative a rentabilização do Apigee na sua organização

Para ativar a rentabilização do Apigee numa organização existente, emita um pedido POST para a seguinte API, transmitindo a configuração do suplemento no corpo do pedido:

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

Aviso: A configuração do suplemento que transmite no corpo do pedido substitui a configuração do suplemento existente. Veja a configuração do suplemento existente no perfil da organização do Apigee e certifique-se de que a inclui no payload do pedido.

Por exemplo:

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>
    }
  }'

Onde $TOKEN está definido como a sua chave de acesso OAuth 2.0, conforme descrito em Obter uma chave de acesso OAuth 2.0. Para informações sobre as opções de curl usadas neste exemplo, consulte a secção Usar o curl. Para uma descrição das variáveis de ambiente que pode usar, consulte o artigo Definir variáveis de ambiente para pedidos de API Apigee.

Segue-se um exemplo da resposta que mostra que a operação está em 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 mais informações, consulte o artigo Configure a API de suplementos da organização.

Veja o perfil da organização para confirmar que a rentabilização foi ativada. Por exemplo:

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

Segue-se um exemplo da resposta que mostra que a rentabilização está ativada.

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

Desative a rentabilização do Apigee na sua organização

Para desativar a rentabilização do Apigee na sua organização, emita um pedido POST para a seguinte API, transmitindo a configuração do suplemento no corpo do pedido:

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

Aviso: A configuração do suplemento que transmite no corpo do pedido substitui a configuração do suplemento existente. Veja a configuração do suplemento existente no perfil da organização do Apigee e certifique-se de que a inclui no payload do pedido.

Por exemplo:

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>
    }
  }'

Segue-se um exemplo da resposta que mostra que a operação está em 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 mais informações, consulte o artigo Configure a API de suplementos da organização.

Veja o perfil da organização para confirmar que a rentabilização foi desativada. Por exemplo:

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

Segue-se um exemplo da resposta que mostra que a rentabilização está ativada.

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

Resolva problemas de ativação da rentabilização do Apigee

Se não comprou a rentabilização do Apigee e tentar ativá-la, é devolvido o seguinte erro:

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