Configura il piano per la quota di condivisione delle entrate

Stai visualizzando la documentazione di Apigee Edge.
Vai alla documentazione di Apigee X. informazioni

Introduzione

In un piano di quota di condivisione delle entrate, il fornitore dell'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 quota di condivisione delle entrate è basata sul prezzo lordo o netto di una transazione). Sei tu a stabilire il prezzo lordo o netto della transazione quando crei la norma di registrazione delle transazioni.

Nel modello di condivisione fissa, 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 quota di condivisione delle entrate dipende dalle entrate generate in un determinato periodo di tempo. La percentuale utilizzata nel calcolo della quota di condivisione delle entrate può variare in base all'importo delle entrate generate dalle transazioni.

Specificare i dettagli del piano di quota di condivisione delle entrate tramite l'interfaccia utente

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

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

I dettagli del piano di quota di condivisione delle entrate vengono specificati al momento della creazione del piano tariffario. Devi specificare i dettagli nella proprietà ratePlanDetails 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 che scegli: fisso o flessibile.

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

Per implementare il modello di condivisione fissa, devi specificare quanto segue nei dettagli del piano tariffario:

• Un parametro di valutazione che indica che il piano tariffario si basa sulle transazioni (VOLUME). VOLUME è l'impostazione predefinita.
• Un tipo di monitoraggio (UNIT) che indica che la quota di condivisione delle entrate è fissa per unità (ovvero, non si basa sul volume di transazioni, come nel caso del modello di condivisione flessibile).
• Il tipo di entrate (GROSS o NET). Indica se la quota di condivisione delle entrate si basa sul prezzo lordo o netto di una transazione.
• Il periodo di scadenza del pagamento (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 quota di condivisione delle entrate. Poiché il modello di condivisione si basa su una tariffa fissa, specifichi una sola tariffa del piano tariffario.

Consulta Proprietà di configurazione per i dettagli del piano tariffario per un elenco completo delle proprietà dei dettagli dei piani tariffari.

Nella tariffa del piano tariffario devi specificare:

• Il tipo di tariffa del piano tariffario (REVSHARE).
• La percentuale utilizzata per calcolare la quota di condivisione delle entrate. Ad esempio, se specifichi 80,5555, la quota di condivisione delle entrate sarà pari all'80,5555%. In altre parole, in qualità di provider di API paghi allo sviluppatore l'80,5555% del prezzo addebitato per ogni transazione (oppure, se in base a un attributo personalizzato come il numero di byte trasmessi in una transazione, paghi allo sviluppatore l'80,5555% del prezzo addebitato per ogni transazione).
• L'unità iniziale dell'applicazione delle tariffe (0). Ciò significa che la tariffa viene applicata a ogni transazione, a partire dalla prima.

Per un elenco completo delle proprietà dei piani tariffari, consulta Proprietà di configurazione dei piani tariffari.

Ad esempio, quanto riportato di seguito crea un piano di quota di condivisione delle entrate con un modello di condivisione fisso. La percentuale della quota di condivisione delle entrate è 80,5555%. La quota di condivisione delle entrate si basa sul prezzo netto di una transazione. Il contratto entra in vigore il 15 settembre 2013, con la scadenza del pagamento entro 30 giorni. I dettagli relativi alla quota di 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 alla seguente (viene mostrata solo una parte):

{
  "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 quota di condivisione delle entrate per un modello di condivisione flessibile

In un modello di condivisione flessibile, devi specificare i dettagli del piano tariffario che includono una o più tariffe del piano tariffario. Ogni tariffa del piano tariffario copre un intervallo di entrate da transazioni (ogni intervallo è chiamato "fascia di entrate"). Devi assegnare una percentuale di quota di condivisione delle entrate a ciascuna categoria di entrate.

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

• Un parametro di valutazione che indica che il piano tariffario si basa sulle transazioni (VOLUME). VOLUME è l'impostazione predefinita.
• Un tipo di monitoraggio (VOLUME) che indica che la quota di condivisione delle entrate non si basa sul volume di transazioni (vale a dire, non è fissa, come nel caso del modello di condivisione fissa).
• Il tipo di entrate (GROSS o NET). Indica se la quota di condivisione delle entrate si basa sul prezzo lordo o netto di una transazione.
• Il periodo di scadenza del pagamento (ad esempio 30 giorni).
• L'ID della tua organizzazione.
• La valuta di base o contabile utilizzata dalla tua azienda.
• Un tipo di durata e durata che, insieme, specificano il periodo di tempo durante il quale le entrate vengono aggregate (definito anche "base di aggregazione"). Le transazioni vengono aggregate sulla base di aggregazione (ad esempio 1 mese) per calcolare le entrate totali e la fascia di entrate applicabile. La percentuale di quota di condivisione delle entrate applicata a ogni transazione dipende dalla categoria di entrate corrispondente.
• Contatori di aggregazione utilizzati per determinare la categoria di entrate applicabile.

Consulta Proprietà di configurazione per i dettagli del piano tariffario per un elenco completo delle proprietà dei dettagli dei piani tariffari.

Per ogni tariffa del piano tariffario devi specificare:

• Il tipo di tariffa del piano tariffario per la fascia di entrate (REVSHARE).
• La percentuale utilizzata per calcolare la quota di condivisione delle entrate per la categoria di entrate. Ad esempio, se specifichi 80,5555, la quota di condivisione delle entrate per la fascia di entrate sarà 80,5555%. In altre parole, in qualità di provider di API, pagherai allo sviluppatore l'80,5555% del prezzo addebitato per ogni transazione in quella fascia di entrate.
• L'unità iniziale e finale della banda delle entrate. L'unità iniziale specifica il limite inferiore di una banda di entrate, mentre l'unità finale specifica il limite superiore di una banda di entrate. Ad esempio, se specifichi un'unità iniziale pari a 0 e un'unità finale pari a 1000, la categoria delle entrate copre le entrate da transazioni maggiori di 0 e fino a 1000 nella valuta specificata. Se la valuta è dollari statunitensi, la base di aggregazione è 1 mese e la percentuale per la fascia di entrate è 80,5555%, per le transazioni che generano fino a 1000 $di entrate in un mese, la quota di condivisione delle entrate sarà pari all'80,5555% del prezzo della transazione.

  Se non specifichi un'unità finale per la fascia di entrate finale, la percentuale della quota di condivisione per quella fascia viene applicata a tutte le transazioni dopo che le entrate aggregate hanno superato l'unità iniziale per quella fascia. Ad esempio, se l'unità iniziale per l'ultima banda è 1000 (supponi dollari statunitensi) e non specifichi un'unità finale per quella fascia, la percentuale di entrate della banda viene applicata a tutte le transazioni superiori a 1000 $di entrate durante il periodo aggregato.

Per un elenco completo delle proprietà dei piani tariffari, consulta Proprietà di configurazione dei piani tariffari.

Ad esempio, quanto riportato di seguito crea un piano di quota di condivisione delle entrate con un modello di condivisione flessibile. Specifica due fasce di entrate. La prima fascia copre entrate da transazioni superiori a 1000 dollari statunitensi. La seconda fascia copre le entrate da transazioni superiori a 1000 dollari statunitensi. La percentuale di quota di condivisione delle entrate è dell'80,5555% per la prima fascia di entrate e del 90,5% per la seconda. La quota di condivisione delle entrate si basa sul prezzo netto di una transazione. La base dell'aggregazione è 1 mese. La durata del contratto è in vigore il 15 settembre 2013, il pagamento deve essere effettuato entro 30 giorni. I dettagli relativi alla quota di 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 alla seguente (viene mostrata solo una parte):

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