Activer la monétisation Apigee

Cette page s'applique à Apigee et à Apigee hybrid.

Consultez la documentation d' Apigee Edge.

Avant de pouvoir utiliser la monétisation Apigee, vous devez l'acheter et l'activer dans votre organisation. La monétisation Apigee est compatible avec les environnements Apigee et Apigee hybrid.

Remarque : Consultez le problème connu 355714868 pour en savoir plus sur un problème lié aux données sur les frais récurrents, de configuration et de recharge d'Apigee Monetization dans les environnements hybrides.

Souscrire à la monétisation Apigee

Pour souscrire à la monétisation Apigee pour les organisations basées sur un abonnement, contactez le service commercial d'Apigee, puis activez la monétisation Apigee dans votre organisation.

La monétisation Apigee n'est pas disponible avec les organisations avec paiement à l'usage.

Les organisations d'évaluation Apigee incluent automatiquement un essai de monétisation Apigee pour la période d'essai. Vous n'avez pas besoin de contacter le service commercial d'Apigee pour ajouter la monétisation. Passez à la section Activer la monétisation Apigee dans votre organisation.

Activer la monétisation Apigee dans votre organisation

Pour activer la monétisation Apigee dans une organisation existante, envoyez une requête POST à l'API suivante, en transmettant la configuration du module complémentaire dans le corps de votre requête :

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

Attention : La configuration du module complémentaire que vous transmettez dans le corps de la requête écrase la configuration existante. Affichez la configuration du module complémentaire existant dans le profil d'organisation Apigee et veillez à l'inclure dans la charge utile de la requête.

Exemple :

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

Où $TOKEN est défini sur votre jeton d'accès OAuth 2.0, comme décrit dans la section Obtenir un jeton d'accès OAuth 2.0. Pour en savoir plus sur les options curl utilisées dans cet exemple, consultez la section Utiliser curl. Pour obtenir une description des variables d'environnement que vous pouvez utiliser, consultez Définir des variables d'environnement pour les requêtes API Apigee.

Voici un exemple de réponse indiquant que l'opération est en cours :

{
  "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"
  }
}

Pour en savoir plus, consultez la page Configurer l'API de modules complémentaires de l'organisation.

Affichez le profil de l'organisation pour vérifier que la monétisation a bien été activée. Exemple :

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

Vous trouverez ci-dessous un exemple de réponse indiquant que la monétisation est activée.

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

Désactiver la monétisation Apigee dans votre organisation

Pour désactiver la monétisation Apigee dans votre organisation, envoyez une requête POST à l'API suivante, en transmettant la configuration du module complémentaire dans le corps de votre requête :

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

Attention : La configuration du module complémentaire que vous transmettez dans le corps de la requête écrase la configuration existante. Affichez la configuration du module complémentaire existant dans le profil d'organisation Apigee et veillez à l'inclure dans la charge utile de la requête.

Exemple :

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

Voici un exemple de réponse indiquant que l'opération est en cours :

{
  "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"
  }
}

Pour en savoir plus, consultez la page Configurer l'API de modules complémentaires de l'organisation.

Affichez le profil de l'organisation pour vérifier que la monétisation a bien été désactivée. Exemple :

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

Vous trouverez ci-dessous un exemple de réponse indiquant que la monétisation est activée.

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

Résoudre les problèmes d'activation de la monétisation Apigee

Si vous n'avez pas souscris à la monétisation Apigee et que vous tentez de l'activer, l'erreur suivante est renvoyée :

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