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. Notez que la monétisation Apigee n'est actuellement pas compatible avec les environnements hybrides.

Souscrire à la monétisation Apigee

Pour souscrire à la monétisation Apigee pour des organisations basées sur un abonnement, procédez comme suit :

  1. Vérifiez que la monétisation Apigee est incluse dans votre abonnement Apigee. Pour en savoir plus, consultez Droits pour Apigee.
  2. Si nécessaire, contactez le service commercial d'Apigee pour souscrire à des fonctionnalités de monétisation Apigee.

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

Exemple :

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

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 utilisées, consultez la section 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/operations/1ae3ed56-b38f-4cc1-ba33-e7d89557075d",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
    "operationType": "UPDATE",
    "targetResourceName": "organizations/$ORG",
    "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" \
  -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,
    ...
    "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:setAddons

Exemple :

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

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

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

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" \
  -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,
    ...
    "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"
  }
}