Configura il piano per la quota di condivisione delle entrate

Stai visualizzando la documentazione di Apigee Edge.
Consulta la documentazione di Apigee X. info

Introduzione

In un piano di condivisione delle entrate, il fornitore di API condivide con lo sviluppatore una percentuale delle entrate generate da ogni transazione (in base al prezzo lordo o netto di una transazione). Quando crei un piano di condivisione delle entrate, devi indicare un modello di condivisione, che può essere fisso o flessibile, e una base di prezzo (ad esempio se la condivisione delle entrate si basa sul prezzo lordo o netto di una transazione). Imposti il prezzo lordo o netto per la transazione quando crei la policy di registrazione delle transazioni.

Nel modello di condivisione fisso, condividi con lo sviluppatore una percentuale fissa delle entrate generate da ogni transazione (in base al prezzo lordo o netto di una transazione). Nel modello di condivisione flessibile, condividi con lo sviluppatore una percentuale variabile delle entrate. La condivisione delle entrate dipende dalle entrate generate in un periodo di tempo. La percentuale utilizzata nel calcolo della condivisione delle entrate può variare in base all'importo delle entrate generate dalle transazioni.

Specificare i dettagli del piano di condivisione delle entrate utilizzando l'UI

Configura i piani di condivisione delle entrate come descritto di seguito.

Specificare i dettagli del piano di condivisione delle entrate utilizzando l'API

Specifichi i dettagli del piano di condivisione delle entrate quando crei il piano tariffario. Specifichi i dettagli nella ratePlanDetails proprietà all'interno del corpo della richiesta in una chiamata a /organizations/{org_name}/monetization-packages/{package_id}/rate-plans. Ciò che specifichi nella proprietà ratePlanDetails dipende dal modello di condivisione scelto: fisso o flessibile.

Specificare i dettagli del piano di condivisione delle entrate per un modello di condivisione fisso

Per implementare il modello di condivisione fisso, specifica quanto segue nei dettagli del piano tariffario:

• Un parametro di valutazione che indica che il piano tariffario si basa sulle transazioni (VOLUME). VOLUME è il valore predefinito.
• Un tipo di misurazione (UNIT) che indica che la condivisione delle entrate è fissa per unità (ovvero non si basa sul volume delle transazioni, come nel caso del modello di condivisione flessibile ).
• Il tipo di entrate (GROSS o NET). Indica se la condivisione delle entrate si basa sul prezzo lordo o netto di una transazione.
• Il periodo di pagamento dovuto (ad esempio 30 giorni).
• L'ID della tua organizzazione.
• La valuta "di base" o contabile utilizzata dalla tua azienda.
• Una tariffa del piano tariffario che fornisce dettagli su come viene calcolata la condivisione delle entrate. Poiché il modello di condivisione si basa su una tariffa fissa, devi specificare una sola tariffa del piano tariffario.

Per un elenco completo delle proprietà dei dettagli del piano tariffario, consulta Proprietà di configurazione per i dettagli del piano tariffario.

Nella tariffa del piano tariffario, specifica:

• Il tipo di tariffa del piano tariffario (REVSHARE).
• La percentuale utilizzata per calcolare la condivisione delle entrate. Ad esempio, se specifichi 80,5555, la condivisione delle entrate è pari all'80,5555%, ovvero, in qualità di fornitore di API, paghi allo sviluppatore l'80,5555% del prezzo addebitato per ogni transazione (o, se basato su un attributo personalizzato come il numero di byte trasmessi in una transazione, paghi allo sviluppatore l'80,5555% del prezzo addebitato per la trasmissione del numero di byte specificato).
• L'unità iniziale dell'applicazione della tariffa (0). Ciò significa che la tariffa viene applicata a ogni transazione, a partire dalla prima.

Per un elenco completo delle proprietà del piano tariffario, consulta Proprietà di configurazione per i piani tariffari.

Ad esempio, il seguente crea un piano di condivisione delle entrate con un modello di condivisione fisso. La percentuale di condivisione delle entrate è pari all'80,5555%. La condivisione delle entrate si basa sul prezzo netto di una transazione. Il contratto è in vigore dal 15 settembre 2013 e il pagamento è dovuto entro 30 giorni. (I dettagli relativi alla condivisione delle entrate sono evidenziati.)

$ 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 risposta dovrebbe essere simile a questa (viene mostrata solo una parte della risposta):

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

Specificare i dettagli del piano di condivisione delle entrate per un modello di condivisione flessibile

In un modello di condivisione flessibile, specifichi i dettagli del piano tariffario che includono una o più tariffe del piano tariffario. Ogni tariffa del piano tariffario copre un intervallo di entrate delle transazioni (ogni intervallo è chiamato "scaglione di entrate "). Assegni una percentuale di condivisione delle entrate per ogni scaglione di entrate.

Oltre alle tariffe del piano tariffario, specifica quanto segue nei dettagli del piano tariffario:

• Un parametro di valutazione che indica che il piano tariffario si basa sulle transazioni (VOLUME). VOLUME è il valore predefinito.
• Un tipo di misurazione (VOLUME) che indica che la condivisione delle entrate non si basa sul volume delle transazioni (ovvero non è fissa, come nel caso del modello di condivisione fisso modello).
• Il tipo di entrate (GROSS o NET). Indica se la condivisione delle entrate si basa sul prezzo lordo o netto di una transazione.
• Il periodo di pagamento dovuto (ad esempio 30 giorni).
• L'ID della tua organizzazione.
• La valuta "di base" o contabile utilizzata dalla tua azienda.
• Una durata e un tipo di durata che insieme specificano il periodo di tempo durante il quale le entrate vengono aggregate (questo è anche chiamato "base di aggregazione"). Le transazioni vengono aggregate in base alla base di aggregazione (ad esempio, 1 mese) per calcolare le entrate totali e lo scaglione di entrate applicabile. La percentuale di condivisione delle entrate applicata a ogni transazione dipende dal relativo scaglione di entrate.
• Contatori di aggregazione utilizzati per determinare lo scaglione di entrate applicabile.

Per un elenco completo delle proprietà dei dettagli del piano tariffario, consulta Proprietà di configurazione per i dettagli del piano tariffario.

Per ogni tariffa del piano tariffario, specifica:

• Il tipo di tariffa del piano tariffario per lo scaglione di entrate (REVSHARE).
• La percentuale utilizzata per calcolare la condivisione delle entrate per lo scaglione di entrate. Ad esempio, se specifichi 80,5555, la condivisione delle entrate per lo scaglione di entrate è pari all'80,5555%, ovvero, in qualità di fornitore di API paghi allo sviluppatore l'80,5555% del prezzo addebitato per ogni transazione in quello scaglione di entrate.
• L'unità iniziale e finale dello scaglione di entrate. L'unità iniziale specifica il limite inferiore di uno scaglione di entrate, mentre l'unità finale specifica il limite superiore dello scaglione di entrate. Ad esempio, se specifichi un'unità iniziale di 0 e un'unità finale di 1000, lo scaglione di entrate copre le entrate delle transazioni superiori a 0 e fino a 1000 nella valuta specificata. Se la valuta è in dollari statunitensi, la base di aggregazione è di 1 mese e la percentuale per lo scaglione di entrate è pari all'80,5555%, quindi per le transazioni che generano entrate fino a 1000 $in un mese, la condivisione delle entrate è pari all'80,5555% del prezzo della transazione.

  Se non specifichi un'unità finale per lo scaglione di entrate finale, la percentuale di condivisione per questo scaglione viene applicata a tutte le transazioni dopo che le entrate aggregate hanno superato l' unità iniziale per questo scaglione. Ad esempio, se l'unità iniziale per l'ultimo scaglione è 1000 (supponi in dollari statunitensi) e non specifichi un'unità finale per questo scaglione, la percentuale di entrate per lo scaglione viene applicata a tutte le transazioni con entrate superiori a 1000 $durante il periodo di aggregazione.

Per un elenco completo delle proprietà del piano tariffario, consulta Proprietà di configurazione per i piani tariffari.

Ad esempio, il seguente crea un piano di condivisione delle entrate con un modello di condivisione flessibile. Specifica due scaglioni di entrate. Il primo scaglione copre le entrate delle transazioni superiori a 0 e fino a 1000 dollari statunitensi. Il secondo scaglione copre le entrate delle transazioni superiori a 1000 dollari statunitensi. La percentuale di condivisione delle entrate è pari all'80,5555% per il primo scaglione di entrate e al 90,5% per il secondo scaglione di entrate. La condivisione delle entrate si basa sul prezzo netto di una transazione. La base di aggregazione è di 1 mese. Il periodo contrattuale è in vigore dal 15 settembre 2013 e il pagamento è dovuto entro 30 giorni. (I dettagli relativi alla condivisione delle entrate sono evidenziati.)

$ 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 risposta dovrebbe essere simile a questa (viene mostrata solo una parte della risposta):

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