Configurer le plan de partage des revenus

Vous consultez la documentation Apigee Edge.
Accédez à la documentation Apigee X. info

Introduction

Dans un plan de partage des revenus, le fournisseur d'API partage avec le développeur un pourcentage des revenus générés par chaque transaction (en fonction du prix brut ou net d'une transaction). Lorsque vous créez un plan de partage des revenus, vous devez indiquer un modèle de partage, qui peut être fixe ou flexible, et une base de tarification (par exemple, si le partage des revenus est basé sur le prix brut ou net 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és par chaque transaction (en fonction du prix brut ou net d'une transaction). Dans le modèle de partage flexible, vous partagez avec le développeur un pourcentage variable des revenus. Le partage des revenus dépend des revenus générés sur une période donnée. Le pourcentage utilisé dans le calcul du partage des revenus peut varier en fonction du montant des revenus générés par les transactions.

Spécifier les détails du plan de partage des revenus à l'aide de l'interface utilisateur

Configurez les plans de partage des revenus, comme décrit ci-dessous.

Spécifier les détails du 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 du corps de la requête dans un appel à /organizations/{org_name}/monetization-packages/{package_id}/rate-plans. Ce que vous spécifiez dans la propriété ratePlanDetails dépend du modèle de partage que vous choisissez : fixe ou flexible.

Spécifier les détails du 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 :

• Un paramètre de tarification indiquant que le plan tarifaire est basé sur les transactions (VOLUME). VOLUME est la valeur par défaut.
• Un type de mesure (UNIT) indiquant que le partage des revenus est fixe par unité (c'est-à-dire qu'il n'est pas basé sur le volume de transactions, comme c'est le cas pour le modèle de partage flexible).
• Le type de revenus (GROSS ou NET). Indique si le partage des revenus est basé sur le prix brut ou net d'une transaction.
• La période de paiement (par exemple, 30 jours).
• L'ID de votre organisation.
• La devise "de base" ou comptable utilisée par votre entreprise.
• Un tarif de plan tarifaire qui fournit des informations sur le mode de calcul du partage des revenus. Étant donné que 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étail du plan tarifaire, consultez Propriétés de configuration pour les détails du plan tarifaire.

Dans le tarif du plan tarifaire, spécifiez les éléments suivants :

• Le type de tarif du plan tarifaire (REVSHARE).
• Le pourcentage utilisé pour calculer le partage des revenus. Par exemple, si vous spécifiez 80,5555, le partage des revenus est de 80,5555 %. En tant que fournisseur d'API, vous payez donc au développeur 80,5555% du prix facturé pour chaque transaction (ou, si le partage est basé sur un attribut personnalisé tel que le nombre d' octets transmis dans une transaction, vous payez au développeur 80,5555% du prix facturé pour la transmission du nombre d'octets spécifié).
• L'unité de départ de l'application du tarif (0). Cela signifie que le tarif est appliqué à chaque transaction, à partir de la première transaction.

Pour obtenir la liste complète des propriétés du plan tarifaire, consultez Propriétés de configuration pour les plans tarifaires.

Par exemple, le code suivant crée un plan de partage des revenus avec un modèle de partage fixe. Le pourcentage de partage des revenus est de 80,5555%. Le partage des revenus est basé sur le prix net d'une transaction. Le contrat est effectif à partir du 15 septembre 2013 et le paiement est dû dans les 30 jours. (Les détails liés 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 du plan de partage des revenus pour un modèle de partage flexible

Dans un modèle de partage flexible, vous spécifiez les détails du plan tarifaire, qui incluent un ou plusieurs tarifs de plan tarifaire. Chaque tarif de plan tarifaire couvre une plage de revenus de transaction (chaque plage est appelée "tranche de revenus"). Vous attribuez un pourcentage de partage des revenus à chaque tranche de revenus.

En plus des tarifs du plan tarifaire, spécifiez les éléments suivants dans les détails du plan tarifaire :

• Un paramètre de tarification indiquant que le plan tarifaire est basé sur les transactions (VOLUME). VOLUME est la valeur par défaut.
• Un type de mesure (VOLUME) indiquant que le partage des revenus n'est pas basé sur le volume de transactions (c'est-à-dire qu'il n'est pas fixe, comme c'est le cas pour le modèle de partage fixe).
• Le type de revenus (GROSS ou NET). Indique si le partage des revenus est basé sur le prix brut ou net d'une transaction.
• La période de paiement (par exemple, 30 jours).
• L'ID de votre organisation.
• La devise "de base" ou comptable utilisée par votre entreprise.
• Une durée et un type de durée qui spécifient ensemble la période pendant laquelle les revenus sont agrégés (également appelée "base d'agrégation"). Les transactions sont agrégées sur la base de l'agrégation (par exemple, un mois) pour calculer le revenu total et la tranche de revenus applicable. Le pourcentage de partage des revenus appliqué à chaque transaction dépend de sa tranche de revenus.
• Des 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étail du plan tarifaire, consultez Propriétés de configuration pour les détails du plan tarifaire.

Pour chaque tarif de plan tarifaire, spécifiez les éléments suivants :

• Le type de tarif du plan tarifaire pour la tranche de revenus (REVSHARE).
• Le pourcentage utilisé pour calculer le partage des revenus pour la tranche de revenus. Par exemple, si vous spécifiez 80,5555, le partage des revenus pour la tranche de revenus est de 80,5555 %. En tant que fournisseur d'API, vous payez donc au développeur 80,5555% du prix facturé pour chaque transaction de cette tranche de revenus.
• L'unité de début et de fin de la tranche de revenus. L'unité de départ spécifie la limite inférieure d'une tranche de revenus, et l'unité de fin spécifie la limite supérieure de la tranche de revenus. Par exemple, si vous spécifiez une unité de départ de 0 et une unité de fin de 1 000, la tranche de revenus couvre les revenus de transaction supérieurs à 0 et jusqu'à 1 000 dans la devise spécifiée. Si la devise est le dollar américain, que la base d'agrégation est d'un mois et que le pourcentage de la tranche de revenus est de 80,5555%, alors pour les transactions qui génèrent jusqu'à 1 000 $ de revenus par mois, le partage des revenus est de 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 partage de cette tranche est appliqué à toutes les transactions une fois que les revenus agrégés ont dépassé l' unité de départ de cette tranche. Par exemple, si l'unité de départ de la dernière tranche est de 1 000 (en supposant que la devise est le dollar américain) et que vous ne spécifiez pas d'unité de fin pour cette tranche, le pourcentage de revenus de la tranche est appliqué à toutes les transactions dont les revenus sont supérieurs à 1 000 $ au cours de la période agrégée.

Pour obtenir la liste complète des propriétés du plan tarifaire, consultez Propriétés de configuration pour les plans tarifaires.

Par exemple, le code suivant crée un plan de partage des revenus avec un modèle de partage flexible. Il spécifie deux tranches de revenus. La première tranche couvre les revenus de transaction supérieurs à 0 et jusqu'à 1 000 dollars américains. La deuxième tranche couvre les revenus de transaction supérieurs à 1 000 dollars américains. Le pourcentage de partage des revenus est de 80,5555% pour la première tranche de revenus et de 90,5% pour la deuxième tranche de revenus. Le partage des revenus est basé sur le prix net d'une transaction. La base d'agrégation est d'un mois. La période contractuelle est effective à partir du 15 septembre 2013 et le paiement est dû dans les 30 jours. (Les détails liés au partage des revenus 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"
}