Esta página se aplica à Apigee e à Apigee híbrida.
Confira a documentação da
Apigee Edge.
Antes de usar a monetização da Apigee, é necessário comprá-la e ativá-la na organização. A monetização da Apigee é compatível com ambientes da Apigee e da Apigee híbrida.
Comprar a monetização da Apigee
Para comprar a monetização da Apigee para organizações por assinatura, entre em contato com o setor de vendas da Apigee e ative a monetização da Apigee na sua organização.
A monetização da Apigee não está disponível para organizações de pagamento por uso.
As organizações de avaliação da Apigee incluem automaticamente um teste de monetização da Apigee para o período de teste. Você não precisa entrar em contato com a equipe de vendas da Apigee para adicionar monetização. Acesse Ativar a monetização da Apigee na sua organização.
Ativar a monetização da Apigee na organização
Para ativar a monetização da Apigee em uma organização existente, envie uma solicitação POST
para a seguinte API,
transmitindo a configuração do complemento no corpo da solicitação:
https://apigee.googleapis.com/v1/organizations/ORG_NAME:setAddons
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> } }'
Em que $TOKEN
está definido como seu token de acesso OAuth 2.0, conforme descrito em
Como receber um token de acesso OAuth 2.0. Para informações sobre as opções de curl
usadas neste exemplo, consulte
Como usar curl. Para uma descrição das variáveis de ambiente que podem ser usadas, consulte
Como definir
variáveis de ambiente para solicitações de API da Apigee.
Veja a seguir um exemplo de resposta que mostra que a operação está em andamento:
{ "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 a API de complementos da organização.
Verifique o perfil da organização para confirmar que a monetização foi ativada. Exemplo:
curl "https://apigee.googleapis.com/v1/organizations/ORG_NAME" \ -X GET \ -H "Authorization: Bearer $TOKEN"
Veja um exemplo de resposta que mostra que a monetização está ativada.
{ "name": ORG_NAME, ... "addonsConfig": { "monetizationConfig": { "enabled": true } } }
Desativar a monetização da Apigee na sua organização
Para desativar a monetização da Apigee na organização, envie uma solicitação POST
para a
seguinte API, transmitindo a configuração do complemento no corpo da solicitação:
https://apigee.googleapis.com/v1/organizations/ORG_NAME:setAddons
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> } }'
Veja a seguir um exemplo de resposta que mostra que a operação está em andamento:
{ "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 Configurar a API de complementos da organização.
Veja o perfil da organização para confirmar que a monetização foi desativada. Exemplo:
curl "https://apigee.googleapis.com/v1/organizations/ORG_NAME" \ -X GET \ -H "Authorization: Bearer $TOKEN"
Veja um exemplo de resposta que mostra que a monetização está ativada.
{ "name": ORG_NAME, ... "addonsConfig": { "monetizationConfig": { "enabled": false } } }
Solução de problemas da ativação da monetização da Apigee
Se você não tiver comprado a monetização da Apigee e tentar ativá-la, o seguinte erro será retornado:
{ "error": { "code": 400, "message": "failed to validate addons config: [Apigee Monetization] addon(s) are not entitled to the subscription", "status": "FAILED_PRECONDITION" } }