Vous consultez la documentation d'Apigee Edge.
Consultez la
documentation Apigee X. en savoir plus
Introduction
Une fois qu'un plan tarifaire existant est publié, vous ne pouvez modifier que sa date de fin. Toutefois, vous pouvez créer une autre version du plan incluant les propriétés modifiées, telles que les changements de tarifs. Vous pouvez configurer la révision pour qu'elle prenne effet à une date ultérieure. Le plan tarifaire d'origine prend fin lorsque la révision entre en vigueur.
Par exemple, supposons que vous ayez créé un plan tarifaire standard qui expire le 31 décembre 2019 et que vous souhaitez le remplacer par un autre forfait prenant effet le 1er janvier 2020. Pour ce faire, vous devez créer un plan tarifaire futur et le configurer pour qu'il entre en vigueur le 1er janvier 2020.
Si aucune date de fin n'est définie pour le plan tarifaire actuel, vous pouvez remplacer un plan existant par un plan tarifaire futur commençant dès aujourd'hui. Vous devez faire expirer le plan tarifaire actuel, comme décrit dans la section Faire expirer un plan tarifaire publié.
Les développeurs sont informés du plan tarifaire révisé. Les développeurs qui acceptent le plan tarifaire d'origine sont automatiquement inscrits pour la révision (mais ont la possibilité de la refuser).
Vous pouvez créer un plan tarifaire futur à l'aide de l'interface utilisateur de gestion ou de l'API de monétisation, comme décrit dans les sections suivantes.
Créer un plan tarifaire futur à l'aide de l'UI
Créez un plan tarifaire futur, comme décrit ci-dessous.
Périphérie
Pour créer une version future d'un plan tarifaire qui commence quelque temps après la date du jour à l'aide de l'interface utilisateur Edge, procédez comme suit.
- Sur la page Plans tarifaires, placez le curseur sur la ligne associée au plan tarifaire pour lequel vous souhaitez créer un plan tarifaire futur.
Le plan tarifaire doit avoir une date de fin. - Cliquez sur +Plus tard.
- Dans la section Plan tarifaire futur, sélectionnez l'une des options suivantes :
- Redémarrer la période complète du contrat à la nouvelle date d'entrée en vigueur: le plan tarifaire futur prend effet à la date d'entrée en vigueur. La durée de renouvellement du plan tarifaire futur est la même que celle du plan tarifaire actuel.
- Déduire le temps consacré au contrat précédent de la nouvelle période, à la date d'entrée en vigueur: le plan tarifaire futur prend effet à la date d'entrée en vigueur. La durée d'utilisation du plan tarifaire actuel est déduite de la durée de renouvellement du plan tarifaire futur. Cela signifie que si un développeur utilise le forfait actuel pendant trois mois et que la période de renouvellement est réduite de trois mois.
- Configurez les champs suivants dans le panneau supérieur:
Remarque: Les autres champs sont en lecture seule.Champ Description Par défaut Obligatoire Nom du plan tarifaire Nom de votre plan tarifaire.
Remarque: Il n'est pas nécessaire que le nom corresponde à celui d'origine du plan tarifaire.
Nom du forfait existant Oui Date de début Date d'entrée en vigueur du plan tarifaire. Saisissez une date de début ou sélectionnez-en une dans le calendrier. Aujourd'hui Non Date de fin Date de fin du plan tarifaire. Pour spécifier une date de fin, activez l'option Comporte une date de fin,puis saisissez une date de fin ou sélectionnez-en une à l'aide du calendrier. Remarque: Le plan tarifaire s'applique jusqu'à la fin de la journée à la date spécifiée. Par exemple, si vous voulez qu'un plan tarifaire expire le 1er décembre 2018, définissez la valeur "endDate" sur "2018-11-30". Dans ce cas, le plan tarifaire expirera le 30 novembre 2018 à la fin de la journée. Toutes les demandes du 1er décembre 2018 seront bloquées.
Aucun Non Visible par les portails Indiquez si le plan tarifaire est public ou privé. Consultez la section Forfaits publics/privés. Activées Non - Configurez les frais pour le plan tarifaire. Consultez la section Configurer des frais.
Remarque: Non applicable aux plans de notification ajustables. - Si vous sélectionnez un lot de produits contenant plusieurs produits d'API, définissez les préférences suivantes dans la section Plan tarifaire spécifique ou générique:
Remarque: Cette étape ne s'applique pas aux plans de notification ajustables.
Champ Description Par défaut Configurer chaque produit individuellement Indicateur spécifiant si un plan tarifaire individuel doit être configuré pour chaque produit d'API. Désactivé Configurer l'offre freemium de chaque produit individuellement Indicateur spécifiant s'il faut configurer un plan freemium pour chaque produit d'API. Désactivé Sélectionnez un produit Si vous activez l'une des options ou les deux, vous devez sélectionner chaque produit individuellement dans la liste déroulante et configurer les détails de son plan tarifaire. Remarque: Veillez à configurer tous les produits du lot de produits.
N/A - Configurez les détails du plan tarifaire en fonction du type de plan tarifaire sélectionné:
- Cliquez sur l'une des options suivantes:
Bouton Description Mettre à jour le brouillon Enregistrez le plan tarifaire en tant que brouillon. Les développeurs d'applications ne pourront pas voir le plan tarifaire tant que vous ne l'aurez pas publié. Vous pouvez modifier n'importe quel champ dans un plan tarifaire brouillon.
Publier le brouillon Publiez le plan. Remarque: Après avoir publié un plan tarifaire, vous ne pouvez modifier sa date de fin que si elle n'est pas déjà définie. Vous ne pouvez pas supprimer un plan tarifaire après sa publication, mais vous pouvez le faire expirer et le remplacer par un plan tarifaire futur, comme décrit dans la section Expiration d'un plan tarifaire publié.
Classic Edge (cloud privé)
Pour créer une version ultérieure d'un plan tarifaire qui commence quelque temps après la date du jour à l'aide de l'interface utilisateur Classic Edge, procédez comme suit.
- Dans le catalogue de packages, cliquez sur +Future dans la colonne "Brouillon/Future" pour le plan tarifaire que vous souhaitez remplacer.
Une fenêtre Plan tarifaire future s'ouvre.
La principale différence entre une période de plan tarifaire futur et une période de plan tarifaire actuelle réside dans l'ajout d'une section "Abonnés existants".
- Comme pour n'importe quel plan tarifaire :
- Saisissez un nom pour le plan dans le champ Nom du plan tarifaire. Le nom ne doit pas nécessairement correspondre à celui du plan tarifaire d'origine.
- Configurer les frais pour un plan tarifaire (facultatif)
- Configurez les détails du plan tarifaire en fonction du type de plan tarifaire sélectionné :
- Spécifiez une date d'entrée en vigueur du plan futur (voir Publier des plans tarifaires) et une date de fin (vous pouvez également sélectionner "Aucune date de fin" si vous ne souhaitez pas que le plan tarifaire futur se termine à une date spécifique). Si une date de fin est définie pour le plan actuel, la date d'entrée en vigueur du plan futur doit être postérieure à la date de fin du plan actuel.
- Dans la section "Abonnés existants", sélectionnez l'une des options suivantes :
- Relancer la période complète du contrat à la nouvelle date d'entrée en vigueur. Le plan tarifaire futur prendra effet à la date d'entrée en vigueur. La durée de renouvellement du plan tarifaire futur est la même que celle du plan tarifaire actuel.
- Déduisez le temps consacré au contrat précédent de la nouvelle période, à la date d'entrée en vigueur. Le plan tarifaire futur prendra effet à la date d'entrée en vigueur. La durée d'utilisation du plan tarifaire actuel est déduite de la durée de renouvellement du plan tarifaire futur. Cela signifie que si un développeur utilise le forfait actuel pendant trois mois et que la période de renouvellement est réduite de trois mois.
- Dans le champ "Date d'entrée en vigueur", saisissez une date de début postérieure à la date de fin du plan tarifaire existant.
Créer un plan tarifaire futur à l'aide de l'API
Pour créer un plan tarifaire futur à l'aide de l'API, envoyez une requête POST à /organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_Id}/revision.
Où :
{org_id}est le nom de l'organisation.{package_id}est l'identification du package d'API.{plan_Id}est l'identification du plan tarifaire.
parentRatePlanspécifie l'ID du plan tarifaire d'origine.startDateindique la date d'entrée en vigueur du nouveau forfait.
Le nom du plan tarifaire futur ne doit pas nécessairement correspondre à celui du plan d'origine. Si vous souhaitez que la date de début d'origine reste enregistrée pour les développeurs, définissez l'indicateur keepOriginalStartDate sur true. Cette option est définie par défaut sur false.
Pour en savoir plus sur les paramètres de configuration, consultez la section Paramètres de configuration des plans tarifaires.
Par exemple, la requête suivante crée un plan tarifaire futur:
$ curl -H "Content-Type:application/json" -X POST -d \
'{
"parentRatePlan": {
"id": "monetization_package_flat_rate_card_plan_1379513833409"
},
"name": "Flat rate card plan",
"developer":null,
"developerCategory":null,
"advance": "false",
"currency": {
"id" : "usd"
},
"description": "Flat rate card plan",
"displayName" : "Flat rate card plan",
"frequencyDuration": "30",
"frequencyDurationType": "DAY",
"earlyTerminationFee": "10",
"monetizationPackage": {
"id": "location"
},
"organization": {
"id": "{org_name}"
},
"paymentDueDays": "30",
"prorate": "false",
"published": "true",
"ratePlanDetails": [
{
"currency": {
"id" : "usd"
},
"paymentDueDays": "30",
"meteringType": "UNIT",
"organization": {
"id": "myorg"
},
"ratePlanRates": [
{
"type": "RATECARD",
"rate": "0.05",
"startUnit": "0"
}
],
"ratingParameter": "VOLUME",
"type": "RATECARD"
}],
"recurringStartUnit": 1,
"recurringType": "CALENDAR",
"recurringFee": "10",
"setUpFee": "10",
"startDate": "2014-01-01 00:00:00",
"type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans/monetization_package_flat_rate_card_plan_1379513833409/revision" \
-u email:password