<ph type="x-smartling-placeholder"></ph>
Vous consultez la documentation Apigee Edge.
Accédez à la page
Documentation sur Apigee X. En savoir plus
Introduction
Dans un plan de partage des revenus, le fournisseur d'API partage avec le développeur un pourcentage Revenus générés par chaque transaction (basés sur le prix brut ou net d'une transaction) Quand ? Lorsque vous créez un plan de partage des revenus, vous devez indiquer un modèle de partage, qui peut être ou flexible, et définir une base de tarification (par exemple, si la part des revenus est basée sur le revenu brut ou net, prix d'une transaction). Vous définissez le prix brut ou net de la transaction lorsque vous créez la règle d'enregistrement des transactions.
Dans le modèle de partage fixe, vous partagez avec le développeur un pourcentage fixe des revenus générées par chaque transaction (sur la base du prix brut ou net d'une transaction). Dans flexible, vous partagez avec le développeur un pourcentage variable des revenus. La la part des revenus dépend des revenus générés au cours d'une période donnée. Le pourcentage utilisé dans la Le calcul de la part des revenus peut varier en fonction du montant des revenus générés par les transactions.
Spécifier les détails d'un plan de partage des revenus avec l'UI
Configurez des plans de partage des revenus, comme décrit ci-dessous.
Edge
Pour configurer un plan de partage des revenus à l'aide de l'interface utilisateur Edge, lors de la création ou de la modification un plan tarifaire, sélectionnez le type de plan Part des revenus ou Tableau des tarifs et Partage des revenus, puis configurez les informations suivantes dans la section Part des revenus:
| Champ | Description |
| Modèle de calcul | Sélectionnez l'un des types de tarification suivants:
|
| Fréquence de calcul | Période au cours de laquelle le volume de transactions (ou le volume lié à un attribut personnalisé) est calculé. Sélectionnez un nombre de mois (1 à 24 mois). |
| Modèle de partage | Sélectionnez l'un des modèles de partage des revenus suivants:
|
| Part des revenus fixe | Pour le modèle de partage fixe, indique le pourcentage utilisé pour calculer la part des revenus. Saisissez un nombre décimal (comportant jusqu'à quatre chiffres après la virgule). Par exemple, si vous saisissez 80,5555, la part des revenus est de 80,5555 %. En d'autres termes, en tant que fournisseur d'API, vous payez au développeur 80,5555% du prix facturé pour chaque transaction. |
| Bandes de partage des revenus | Pour le modèle de partage flexible, une ou plusieurs plages de revenus des transactions (chaque plage correspond à une "tranche de revenus"). Chaque tranche de revenus peut se voir attribuer un pourcentage de part des revenus. Les transactions sont agrégées sur la base d'agrégation pour calculer le revenu total et la tranche de revenus pour la transaction. Le pourcentage de part des revenus appliqué à chaque transaction dépend de sa fourchette de revenus. Spécifiez la limite supérieure de la première bande, par exemple jusqu'à 1 000 (la limite inférieure est prédéfinie sur une valeur supérieure à 0). Cliquez sur + Nouveau pour ajouter d'autres bracelets. Laissez la limite supérieure de la bande finale vide pour indiquer toutes les transactions une fois que les revenus cumulés ont dépassé ce niveau. Par exemple, si vous spécifiez deux tranches de revenus dans la section "Tranche de revenus" (>0-1000, 1000 et au-delà), vous pouvez saisir 80,5555 pour la tranche >0-1000 et 90,5 pour la tranche 1000 et au-dessus. Supposons également que la devise est exprimée en dollars américains. Ensuite, pour les transactions qui génèrent jusqu'à 1 000 $de revenus, la part des revenus correspond à 80,5555% du prix de la transaction. Pour les transactions qui génèrent plus de 1 000 $de revenus, la part des revenus correspond à 90,5% du prix de la transaction. |
Classic Edge (cloud privé)
Pour configurer des plans de partage des revenus à l'aide de l'interface utilisateur Classic Edge:
- Suivez les étapes pour créer un plan tarifaire.
- Sélectionnez Part des revenus dans la liste déroulante "Type de plan tarifaire" pour configurer le modèle de revenus.
- Si le package d'API sélectionné inclut plusieurs produits d'API, choisissez l'une des options suivantes:
Remarque: Si le package d'API inclut un seul produit d'API, vous pouvez ignorer cette étape.
- Forfaits spécifiques au produit pour configurer les détails des plans tarifaires individuellement pour chaque produit d'API.
- Forfait générique pour tous les produits : permet de configurer les détails du plan tarifaire pour tous les produits d'API.
- Cliquez sur Part des revenus pour le plan tarifaire générique ou celui spécifique à chaque produit d'API.
Remarque: Lorsque vous configurez des plans spécifiques aux produits d'API, vous devez configurer un plan de partage des revenus. pour chaque produit API.
La fenêtre Partage des revenus s'ouvre.
- Sélectionnez l'un des modèles de partage suivants:
<ph type="x-smartling-placeholder">
- </ph>
- Fixe: dans ce modèle, le fournisseur d'API partage avec le développeur un pourcentage fixe des les revenus générés par chaque transaction (basés sur le prix brut ou net d'une transactionnel).
- Flexible: dans ce modèle, le fournisseur d'API partage avec le développeur une variable un pourcentage des revenus. La part des revenus dépend des revenus générés au cours d'une période. de temps. Le pourcentage utilisé dans le calcul de la part des revenus peut varier en fonction du montant de revenus générés par les transactions.
Pour le modèle de partage fixe:
Si vous sélectionnez le modèle de partage fixe, saisissez les informations suivantes dans le champ de la fenêtre Partage des revenus générique:
Champ Description Opérateur (ou organisation) Nom de votre organisation. Ce champ est prédéfini à l'aide de l'opérateur (ou Organization) dans le profil d'organisation.
Pays Pays d'activité de votre organisation. Ce champ est prédéfini à l'aide du paramètre Valeur du champ "Pays" dans le profil de l'organisation.
Devise La "base" ou la devise comptable utilisée par votre entreprise. Ce champ est prédéfini à l'aide de la valeur du champ "Devise" dans le profil de l'organisation.
Type de tarification Base de la part des revenus. Sélectionnez Brut ou Net. Si vous sélectionnez Brut, le La part des revenus est basée sur un pourcentage du prix brut d’une transaction. Si vous sélectionnez Net, la part des revenus est basée sur un pourcentage du prix net transaction. Remarque: Vous définissez le prix brut ou net de la transaction lorsque vous créez la règle d'enregistrement des transactions.
% de part fixe Pourcentage utilisé pour calculer la part des revenus. Saisissez un nombre décimal (avec jusqu'à quatre décimales). Par exemple, si vous saisissez 80,5555, la part des revenus est de 80,5555%, c'est-à-dire qu'en tant que fournisseur d'API, vous payez 80,5555% du prix au développeur facturés pour chaque transaction.
Pour le modèle de partage flexible:
Si vous sélectionnez le modèle de partage flexible, vous remarquerez que la fenêtre "Partage des revenus générique" affiche des champs supplémentaires. Ces champs permettent de spécifier une base pour l'agrégation spécifier des "tranches de revenus", c'est-à-dire des plages de revenus générés par les transactions pour lesquelles vous pouvez appliquer différents pourcentages de part des revenus.
Saisissez les informations suivantes dans la fenêtre Generic Revenue Share (Partage des revenus générique) :
Champ Description Base d'agrégation Période au cours de laquelle les revenus sont agrégés. Les revenus cumulés sont utilisée pour calculer la fourchette de revenus pour chaque transaction (et les revenus applicables le pourcentage de partage). Sélectionnez un nombre de mois (entre 1 et 12).
Tranches de revenus Une ou plusieurs plages de revenus des transactions (chaque plage correspond à une "tranche de revenus") Chaque la tranche de revenus peut se voir attribuer un pourcentage de part des revenus (vous définissez ce pourcentage dans champ "Bandes de revenus" de la section "Tarification".) Les transactions sont agrégées sur la période pour calculer le revenu total et la fourchette de revenus pour le transaction. Le pourcentage de part des revenus appliqué à chaque transaction dépend de ses tranche de revenus.
Spécifiez la limite supérieure de la première bande, par exemple jusqu'à 1 000 (la valeur inférieure est prédéfinie sur une valeur supérieure à 0). Cliquez sur "+" pour ajouter une deuxième bande, par exemple, entre 1 000 et 2 000. Cliquez sur + pour ajouter d'autres bracelets. Vous pouvez laisser la partie supérieure limite de la bande finale vide pour indiquer toutes les transactions après l'agrégation les revenus ont dépassé ce niveau.
Tarifs Opérateur (ou organisation) Nom de votre organisation. Ce champ est prédéfini à l'aide de l'opérateur (ou Organization) dans le profil d'organisation.
Pays Pays d'activité de votre organisation. Ce champ est prédéfini à l'aide du paramètre Valeur du champ "Pays" dans le profil de l'organisation.
Devise La "base" ou la devise comptable utilisée par votre organisation. Ce champ est prédéfini à l'aide de la valeur du champ "Devise" dans le profil de l'organisation.
Type de tarification Base de la part des revenus. Sélectionnez Brut ou Net. Si vous sélectionnez Brut, le La part des revenus est basée sur un pourcentage du prix brut d’une transaction. Si vous sélectionnez Net, la part des revenus est basée sur un pourcentage du prix net transaction. Remarque: Vous définissez le prix brut ou net de la transaction lorsque vous créez la règle d'enregistrement des transactions.
Pourcentage de partage des tranches de revenus Pourcentage utilisé pour calculer la part des revenus des transactions de chaque tranche de revenus. Vous spécifiez un pourcentage pour chaque bande. Saisissez un nombre décimal (avec les à 4 chiffres après la virgule). Par exemple, si vous spécifiez deux tranches de revenus dans la section bande (>0-1000, 1000 et au-delà), vous pouvez saisir 80,5555 pour la 90, 5 pour la tranche de 1 000 et au-delà. Supposons également que la devise est en dollars américains. Ensuite, les transactions qui génèrent jusqu'à 1 000 $ la part des revenus s'élève à 80,5555% du prix de la transaction. transactions qui génèrent plus de 1 000 $de revenus, la part des revenus s'élève à 90,5 % le prix de la transaction.
- Cliquez sur Appliquer et fermer pour enregistrer les informations détaillées sur la part des revenus et revenir au tarif standard. Période du plan.
- Pour les plans tarifaires spécifiques aux produits d'API, configurez les détails des plans tarifaires pour les autres produits d'API, si nécessaire.
Spécifier les détails d'un plan de partage des revenus à l'aide de l'API
Vous spécifiez les détails du plan de partage des revenus lorsque vous créez le plan tarifaire. Vous spécifiez les détails
dans la propriété ratePlanDetails, dans le corps de la requête, lors d'un appel à
/organizations/{org_name}/monetization-packages/{package_id}/rate-plans Ce que vous
spécifier dans la propriété ratePlanDetails, selon le modèle de partage que vous choisissez:
fixes ou flexibles.
Spécifier les détails d'un plan de partage des revenus pour un modèle de partage fixe
Pour implémenter le modèle de partage fixe, spécifiez les éléments suivants dans les détails du plan tarifaire:
- Paramètre de notation indiquant que le plan tarifaire est basé sur des transactions
(
VOLUME).VOLUMEest la valeur par défaut. - Type de mesure (
UNIT) indiquant que la part des revenus est fixe par unité (en d'autres termes, il n'est pas basé sur le volume des transactions, comme c'est le cas pour le le modèle de partage). - Type de revenus (
GROSSouNET). Cette valeur indique si le La part des revenus est basée sur le prix brut ou net d'une transaction. - Délai d'échéance du paiement (par exemple, 30 jours).
- ID de votre organisation.
- La "base" ou la devise comptable utilisée par votre entreprise.
- Tarif du plan tarifaire qui fournit des détails sur le calcul de la part des revenus. En effet, le modèle de partage est basé sur un tarif fixe, vous ne spécifiez qu'un seul tarif de plan tarifaire.
Pour obtenir la liste complète des propriétés de détails du plan tarifaire, consultez Propriétés de configuration des détails du plan tarifaire.
Dans le tarif du plan tarifaire, vous indiquez:
- Type de tarif du plan tarifaire (
REVSHARE). - Pourcentage utilisé pour calculer la part des revenus. Par exemple, si vous indiquez 80.5555, la part des revenus est de 80,5555 %. En tant que fournisseur d'API, vous payez au développeur 80, 5555 % le prix facturé pour chaque transaction (ou, si cette valeur est basée sur un attribut personnalisé tel que le nombre transmis dans une transaction, vous payez au développeur 80,5555% du prix facturé en transmettant le nombre d'octets spécifié).
- Unité de départ de l'application tarifaire (
0). Cela signifie que le taux est appliqué à chaque transaction, en commençant par la première.
Pour obtenir la liste complète des propriétés de plans tarifaires, consultez Propriétés de configuration des plans tarifaires.
L'exemple ci-dessous permet de créer un plan de partage des revenus avec un modèle de partage fixe. La le pourcentage de part des revenus est de 80,5555%. La part des revenus est basée sur le prix net transaction. Le contrat entre en vigueur le 15 septembre 2013, et le paiement doit être effectué sous 30 jours. (Le les détails relatifs au partage des revenus sont mis en surbrillance.)
$ curl -H "Content-Type:application/json" -X POST -d \
'{
"name": "Fixed share plan",
"developer":null,
"developerCategory":null,
"advance": false,
"currency": {
"id": "usd"
},
"description": "Fixed share plan",
"displayName": "Fixed share plan",
"earlyTerminationFee": 10,
"monetizationPackage": {
"id": "location"
},
"organization": {
"id": "{org_name}"
},
"paymentDueDays": "30",
"prorate": false,
"published": true,
"ratePlanDetails": [
{
"aggregateStandardCounters": true,
"currency": {
"id": "usd"
},
"duration": 1,
"durationType": "MONTH",
"meteringType": "UNIT",
"organization": {
"id": "{org_name}"
},
"paymentDueDays": "30",
"ratePlanRates": [
{
"revshare": 80.8555,
"startUnit": 0,
"type": "REVSHARE"
}
],
"ratingParameter": "VOLUME",
"revenueType": "NET",
"type": "REVSHARE"
}
],
"recurringStartUnit": 1,
"recurringType": "CALENDAR",
"setUpFee": 10,
"startDate": "2013-09-15 00:00:00",
"type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password
La réponse doit se présenter comme suit (seule une partie de la réponse est affichée):
{ "advance" : false, "currency" : { "id" : "usd", "name" : "USD", ... "organization" : { ... }, ... }, "description" : "Fixed share plan", "displayName" : "Fixed share plan", "earlyTerminationFee" : 10, "id" : "location_fixed_share_plan", "monetizationPackage" : { "description" : "Location", "displayName" : "Location", "id" : "location", "name" : "Location", "organization" : { ... }, "product" : [ { "customAtt1Name" : "user", "description" : "Location", "displayName" : "Location", "id" : "location", "name" : "location", "organization" : { ... }, "status" : "CREATED" } ], "status" : "CREATED" }, "name" : "Fixed share plan", "organization" : { ... }, "paymentDueDays" : "30", "prorate" : false, "published" : true, "ratePlanDetails" : [ { "aggregateFreemiumCounters" : true, "aggregateStandardCounters" : true, "currency" : { "id" : "usd", "name" : "USD", ... "organization" : { ... }, ... }, "duration" : 1, "durationType" : "MONTH", "id" : "c1720153-c60f-4f7f-b4e5-cdc7bc7bec5b", "meteringType" : "UNIT", "organization" : { ... }, "paymentDueDays" : "30", "ratePlanRates" : [ { "id" : "01c4d544-d907-423b-964e-4e2aed2816a3", "revshare" : 80.8555, "startUnit" : 0, "type" : "REVSHARE" } ], "ratingParameter" : "VOLUME", "revenueType" : "NET", "type" : "REVSHARE" } ], "recurringStartUnit" : 1, "recurringType" : "CALENDAR", "setUpFee" : 10, "startDate" : "2013-09-15 00:00:00", "type" : "STANDARD" }
Spécifier les détails d'un forfait de partage des revenus pour un modèle de partage flexible
Dans un modèle de partage flexible, vous spécifiez les détails d'un plan tarifaire qui incluent un ou plusieurs plans taux de conversion. Chaque tarif couvre une plage de revenus des transactions (chaque plage est appelée bracelet", par exemple). Vous attribuez un pourcentage de part des revenus à chaque tranche de revenus.
En plus des tarifs du plan tarifaire, vous spécifiez les éléments suivants dans les détails du plan tarifaire:
- Paramètre de notation indiquant que le plan tarifaire est basé sur des transactions
(
VOLUME).VOLUMEest la valeur par défaut. - Un type de mesure (
VOLUME) qui indique que la part des revenus n'est pas basée sur le volume des transactions (il n'est pas fixe, comme c'est le cas pour le du modèle de ML). - Type de revenus (
GROSSouNET). Cette valeur indique si le La part des revenus est basée sur le prix brut ou net d'une transaction. - Délai d'échéance du paiement (par exemple, 30 jours).
- ID de votre organisation.
- La "base" ou la devise comptable utilisée par votre entreprise.
- Un type de durée et un type de durée qui, ensemble, spécifient la période au cours de laquelle le revenu est agrégées (ce procédé est également appelé "base d'agrégation"). Les transactions sont agrégées sur la période (1 mois, par exemple) pour calculer le revenu total et le montant des revenus tranche de revenus. Le pourcentage de part des revenus appliqué à chaque transaction dépend des revenus générés bracelet.
- Compteurs d'agrégation utilisés pour déterminer la tranche de revenus applicable
Pour obtenir la liste complète des propriétés de détails du plan tarifaire, consultez Propriétés de configuration des détails du plan tarifaire.
Pour chaque tarif du plan tarifaire, vous indiquez:
- Type de tarif du plan tarifaire pour la tranche de revenus (
REVSHARE). - Pourcentage utilisé pour calculer la part des revenus pour la tranche de revenus. Par exemple, si si vous spécifiez 80,5555, la part de revenus pour la tranche de revenus est de 80,5555%, c'est-à-dire avec l'API vous payez au développeur 80, 5555% du prix facturé pour chaque transaction dans ce tranche de revenus.
- Unités de début et de fin de la tranche de revenus. L'unité de départ indique
limite d'une tranche de revenus, et l'unité de fin spécifie la limite supérieure de la tranche de revenus. Pour
Par exemple, si vous spécifiez 0 comme unité de départ et 1 000 comme unité de fin, la fourchette de revenus
couvre les revenus des transactions compris entre 0 et 1 000 dans la devise spécifiée. Si le
la devise est le dollar américain, la base d'agrégation est un mois, et le pourcentage des revenus
est de 80,5555 %. Pour les transactions qui génèrent jusqu'à 1 000 $de revenus en un mois,
la part des revenus représente 80,5555% du prix de la transaction.
Si vous ne spécifiez pas d'unité de fin pour la tranche de revenus finale, le pourcentage de part pour cette bande est appliquée à toutes les transactions une fois que les revenus cumulés ont dépassé le unité de départ de cette bande. Par exemple, si l'unité de départ de la dernière bande est 1 000 (en supposant le dollar américain) et que vous n'avez pas défini d'unité de fin pour cette bande, le revenu pourcentage pour la bande est appliqué à toutes les transactions supérieures à 1 000 USD de revenus pendant la période sur la période cumulée.
Pour obtenir la liste complète des propriétés de plans tarifaires, consultez Propriétés de configuration des plans tarifaires.
L'exemple ci-dessous permet de créer un plan de partage des revenus avec un modèle de partage flexible. Il spécifie deux tranches de revenus. La première bande couvre les revenus des transactions supérieurs à 1 000 dollars américains. La seconde tranche couvre des revenus de transaction supérieurs à 1 000 dollars américains. Les revenus le pourcentage de part est de 80,5555% pour la première tranche de revenus et de 90,5% pour la deuxième. La part des revenus est basée sur le prix net d'une transaction. Elle est calculée sur la base d'un mois. La période du contrat entre en vigueur le 15 septembre 2013, et le paiement doit être effectué sous 30 jours. (Le chiffre d'affaires les détails relatifs au partage sont mis en surbrillance.)
$ curl -H "Content-Type:application/json" -X POST -d \
'{
"name": "Flexible share plan",
"developer":null,
"developerCategory":null,
"advance": "true",
"currency": {
"id": "usd"
},
"description": "Flexible share plan",
"displayName": "Flexible share plan",
"frequencyDuration": "30",
"frequencyDurationType": "DAY",
"earlyTerminationFee": "10",
"monetizationPackage": {
"id": "location"
},
"organization": {
"id": "{org_name}"
},
"paymentDueDays": "30",
"prorate": "false",
"published": "true",
"ratePlanDetails": [
{
"currency": {
"id": "usd"
},
"duration": "1",
"durationType": "MONTH",
"meteringType": "VOLUME",
"organization": {
"id": "{org_name}"
},
"paymentDueDays": "30",
"ratePlanRates" : [ {
"endUnit" : 1000,
"revshare" : 80.5555,
"startUnit" : 0,
"type" : "REVSHARE"
}, {
"revshare" : 90.5,
"startUnit" : 1000,
"type" : "REVSHARE"
} ],
"ratingParameter" : "VOLUME",
"revenueType" : "NET",
"type" : "REVSHARE"
} ],
"recurringStartUnit": 1,
"recurringType": "CALENDAR",
"recurringFee": "10",
"setUpFee": "10",
"startDate": "2013-09-15 00:00:00",
"type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password
La réponse doit se présenter comme suit (seule une partie de la réponse est affichée):
{ "advance" : true, "currency" : { "id" : "usd", "name" : "USD", "organization" : { ... }, ... }, "description" : "Flexible share plan", "displayName" : "Flexible share plan", "earlyTerminationFee" : 10, "frequencyDuration" : 30, "frequencyDurationType" : "DAY", "id" : "location_flexible_share_plan", "monetizationPackage" : { "description" : "Location", "displayName" : "Location", "id" : "location", "name" : "Location", "organization" : { ... }, "product" : [ { "customAtt1Name" : "user", "description" : "Location", "displayName" : "Location", "id" : "location", "name" : "location", "organization" : { ... }, "status" : "CREATED" } ], "status" : "CREATED" }, "name" : "Flexible share plan", "organization" : { ... }, "paymentDueDays" : "30", "prorate" : false, "published" : false, "ratePlanDetails" : [ { "aggregateFreemiumCounters" : true, "aggregateStandardCounters" : true, "currency" : { "id" : "usd", "name" : "USD", … "organization" : { ... }, ... }, "duration" : 1, "durationType" : "MONTH", "id" : "ba3353e3-14f4-4bc5-a9f1-c723fd34131c", "meteringType" : "VOLUME", "organization" : { ... }, "paymentDueDays" : "30", "ratePlanRates" : [ { "endUnit" : 1000, "id" : "5f13a51e-2250-4383-9aad-35e9a008ab40", "revshare" : 80.5555, "startUnit" : 0, "type" : "REVSHARE" }, { "id" : "d4196250-4ecc-480e-a7ed-dfab8e1c92ed", "revshare" : 90.5, "startUnit" : 1000, "type" : "REVSHARE" } ], "ratingParameter" : "VOLUME", "revenueType" : "NET", "type" : "REVSHARE" } ], "recurringFee" : 10, "recurringStartUnit" : 1, "recurringType" : "CALENDAR", "setUpFee" : 10, "startDate" : "2013-09-15 00:00:00", "type" : "STANDARD" }