Stai visualizzando la documentazione di Apigee Edge.
Vai alla sezione
Documentazione di Apigee X. Informazioni
Introduzione
In un piano di condivisione delle entrate, il provider API condivide con lo sviluppatore una percentuale del Entrate generate da ogni transazione (in base al prezzo lordo o netto di una transazione). Quando crei un piano di quota di condivisione delle entrate, devi indicare un modello di condivisione, che può essere flessibili o flessibili e da una base di determinazione del prezzo (ad esempio, se la quota di condivisione delle entrate si basa sulle entrate prezzo di una transazione). Il prezzo lordo o netto della transazione viene fissato nel momento in cui crei le norme di registrazione delle transazioni.
Con il 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). Nella di condivisione flessibile, condividi con lo sviluppatore una percentuale variabile delle entrate. La la quota di condivisione delle entrate dipende dalle entrate generate in un determinato periodo di tempo. La percentuale utilizzata nella Il calcolo della quota di condivisione delle entrate può variare in base all'importo delle entrate generate dalle transazioni.
Specificare i dettagli del piano quota di condivisione delle entrate utilizzando l'interfaccia utente
Configura i piani di quota di condivisione delle entrate, come descritto di seguito.
Edge
Per configurare un piano quota di condivisione delle entrate utilizzando l'interfaccia utente di Edge, durante la creazione o modifica un piano tariffario, seleziona il tipo di piano tariffario Quota di condivisione delle entrate o Tariffario e quota di condivisione delle entrate e, nella sezione Quota di condivisione delle entrate, configura le seguenti informazioni:
| Campo | Descrizione |
| Modello di calcolo | Seleziona uno dei seguenti tipi di prezzi:
|
| Frequenza di calcolo | Periodo di tempo durante il quale viene calcolato il volume delle transazioni (o del volume relativo agli attributi personalizzati). Seleziona un numero di mesi (1-24 mesi). |
| Condivisione del modello | Seleziona uno dei seguenti modelli di quota di condivisione delle entrate:
|
| Quota di condivisione delle entrate fissa | Per il modello di condivisione fissa, specifica la percentuale utilizzata per calcolare la quota di condivisione delle entrate. Inserisci un numero decimale (con un massimo di quattro cifre decimali). Ad esempio, se inserisci 80.5555, la quota di condivisione delle entrate sarà 80.5555%. In altre parole, in qualità di provider API, pagherai allo sviluppatore l'80, 5555% del prezzo addebitato per ogni transazione. |
| Fasce quota di condivisione delle entrate | Per il modello di condivisione flessibile, uno o più intervalli di entrate da transazioni (ogni intervallo è una "banda di entrate"). A ogni fascia di entrate può essere assegnata una percentuale di quota di condivisione delle entrate. Le transazioni vengono aggregate su base di aggregazione per calcolare le entrate totali e la fascia di entrate per la transazione. La percentuale di quota di condivisione delle entrate applicata a ogni transazione dipende dalla categoria delle entrate. Specifica il limite superiore della prima banda, ad esempio, fino a 1000 (il limite inferiore è preimpostato su un valore maggiore di 0). Fai clic su +Nuovo per aggiungere altri cinturini. Lascia vuoto il limite superiore della banda finale per indicare tutte le transazioni dopo che le entrate aggregate hanno superato questo livello. Ad esempio, se specifichi due fasce di entrate nella sezione Banda di entrate (>0-1000 e 1000 e superiore), potresti inserire 80,5555 per la fascia di entrate >0-1000 e 90, 5 per la fascia di entrate 1000 e superiore. Supponiamo inoltre che la valuta sia in dollari statunitensi. Per le transazioni che generano entrate fino a 1000 $, la quota di condivisione delle entrate è pari all'80,5555% del prezzo della transazione, mentre per le transazioni che generano entrate superiori a 1000 $la quota di condivisione delle entrate è pari al 90,5% del prezzo della transazione. |
Perimetrale classico (Private Cloud)
Per configurare i piani relativi alla quota di condivisione delle entrate utilizzando l'interfaccia utente di Edge classico:
- Segui i passaggi per creare un piano tariffario.
- Seleziona Quota di condivisione delle entrate nel menu a discesa Tipo di piano tariffario per configurare il modello di entrate.
- Se il pacchetto API selezionato include più prodotti API, seleziona una delle seguenti opzioni:
Nota: se il pacchetto API include un singolo prodotto API, puoi saltare questo passaggio.
- Piani specifici per prodotto, per configurare i dettagli dei piani tariffari per ciascun prodotto API singolarmente.
- Piano generico per tutti i prodotti per configurare i dettagli del piano tariffario per tutti i prodotti basati su API.
- Fai clic su Quota di condivisione delle entrate per il piano tariffario generico o per ciascun piano tariffario specifico del prodotto API.
Nota: quando configuri i piani specifici per prodotto API, devi configurare un piano per la quota di condivisione delle entrate singolarmente per ciascun prodotto API.
Viene visualizzata la finestra Quota di condivisione delle entrate.
- Seleziona uno dei seguenti modelli di condivisione:
- Fissa: in questo modello, il provider API condivide con lo sviluppatore una percentuale fissa di Le entrate generate da ogni transazione (in base al prezzo lordo o netto di un transazione).
- Flessibile: in questo modello, il provider API condivide con lo sviluppatore una variabile percentuale delle entrate. La quota di condivisione delle entrate dipende dalle entrate generate in un determinato periodo del tempo. La percentuale utilizzata nel calcolo della quota di condivisione delle entrate può variare in base all'importo delle entrate generate dalle transazioni.
Per il modello di condivisione fissa:
Se selezioni il modello di condivisione fisso, inserisci le seguenti informazioni nel campo Prezzi della finestra Quota di condivisione delle entrate generica:
Campo Descrizione Operatore (o organizzazione) Il nome della tua organizzazione. Questo campo viene preimpostato utilizzando l'operatore (o organizzazione) nel profilo dell'organizzazione.
Paese Il paese in cui opera la tua organizzazione. Questo campo viene preimpostato utilizzando Valore del campo Paese nel profilo dell'organizzazione.
Valuta La "base" o valuta contabile utilizzata dalla tua azienda. Questo campo è preimpostato utilizzando il valore del campo Valuta nel profilo dell'organizzazione.
Tipo di prezzo La base della quota di condivisione delle entrate. Seleziona Lordo o Netto. Se selezioni Lordo, la quota di condivisione delle entrate si basa su una percentuale del prezzo lordo di una transazione. Se selezionare Netto, la quota di condivisione delle entrate si basa su una percentuale del prezzo netto di transazione. Nota: il prezzo lordo o netto della transazione viene impostato quando crei il criterio di registrazione delle transazioni.
% condivisione fissa La percentuale utilizzata per calcolare la quota di condivisione delle entrate. Inserisci un numero decimale (con con un massimo di quattro cifre decimali). Ad esempio, se inserisci 80.5555, la quota di condivisione delle entrate sarà 80,5555%, ovvero, in qualità di fornitore di API, paghi allo sviluppatore l'80,5555% del prezzo addebitato per ogni transazione.
Per il modello di condivisione flessibile:
Se selezioni il modello di condivisione flessibile, noterai che la finestra della quota di condivisione delle entrate generica visualizza altri campi. Questi campi consentono di specificare una base per l'aggregazione e specificare le "bande di entrate", ovvero intervalli di entrate generate dalle transazioni per i quali puoi e applicare percentuali di quota di condivisione delle entrate diverse.
Inserisci le seguenti informazioni nella finestra Quota di condivisione delle entrate generica:
Campo Descrizione Base di aggregazione Il periodo di tempo durante il quale vengono aggregate le entrate. Le entrate aggregate sono utilizzata per calcolare la fascia di entrate per ogni transazione (e le entrate applicabili percentuale di condivisione). Seleziona un numero di mesi (compreso tra 1 e 12).
Bande entrate Uno o più intervalli di entrate da transazioni (ciascun intervallo rappresenta una "banda di entrate"). Ciascuna per fascia di entrate può essere assegnata una percentuale di quota di condivisione delle entrate (la percentuale viene impostata nel nel campo Intervalli di entrate della sezione Prezzi). Le transazioni vengono aggregate di aggregazione per calcolare le entrate totali e la fascia di entrate per transazione. La percentuale di quota di condivisione delle entrate applicata a ogni transazione dipende dal relativo fascia di entrate.
Specifica il limite superiore della prima banda, ad esempio, fino a 1000 (il limite inferiore è preimpostato su un valore maggiore di 0). Fai clic su + per aggiungere una seconda fascia, ad esempio, superiore a 1000 e fino a 2000. Fai clic su + per aggiungere altri cinturini. Puoi lasciare la parte superiore limite della banda finale vuoto per indicare tutte le transazioni dopo l'aggregato le entrate siano superiori a questo livello.
Prezzi Operatore (o organizzazione) Il nome della tua organizzazione. Questo campo viene preimpostato utilizzando l'operatore (o organizzazione) nel profilo dell'organizzazione.
Paese Il paese in cui opera la tua organizzazione. Questo campo viene preimpostato utilizzando Valore del campo Paese nel profilo dell'organizzazione.
Valuta La "base" o valuta contabile della tua organizzazione. Questo campo è preimpostata utilizzando il valore del campo Valuta nel profilo dell'organizzazione.
Tipo di prezzo La base della quota di condivisione delle entrate. Seleziona Lordo o Netto. Se selezioni Lordo, la quota di condivisione delle entrate si basa su una percentuale del prezzo lordo di una transazione. Se selezionare Netto, la quota di condivisione delle entrate si basa su una percentuale del prezzo netto di transazione. Nota: il prezzo lordo o netto della transazione viene impostato quando crei il criterio di registrazione delle transazioni.
Condividi % per fasce di entrate La percentuale utilizzata per calcolare la quota di condivisione delle entrate per le transazioni in ogni fascia di entrate. Devi specificare una percentuale per ogni banda. Inserisci un numero decimale (con con quattro cifre decimali). Ad esempio, se specifichi due fasce di entrate nel campo Entrate Banda (>0-1000, 1000 e superiore), puoi inserire 80,5555 per il parametro Fascia di entrate >0-1000 e 90, 5 per la fascia di entrate pari o superiore a 1000. Supponiamo anche la valuta è in dollari statunitensi. Per le transazioni che generano fino a 1000 $ delle entrate, la quota di condivisione delle entrate è pari all'80,5555% del prezzo della transazione, mentre transazioni che generano più di 1000 $di entrate, la quota di condivisione delle entrate è pari al 90,5% il prezzo della transazione.
- Fai clic su Applica e chiudi per salvare i dettagli della quota di condivisione delle entrate e tornare alla tariffa standard. Finestra del piano.
- Per i piani tariffari specifici dei prodotti API, configura i dettagli dei piani tariffari per altri prodotti API, come richiesto.
Specificare i dettagli del piano quota di condivisione delle entrate utilizzando l'API
Puoi specificare i dettagli del piano relativo alla quota di condivisione delle entrate al momento della creazione del piano tariffario. Sei tu a 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. Cosa vuoi
specificare nella proprietà ratePlanDetails, dipende dal modello di condivisione scelto:
fisso o flessibile.
Specificare i dettagli del piano quota di condivisione delle entrate per un modello di condivisione fissa
Per implementare il modello di condivisione fissa, specifica quanto segue nei dettagli del piano tariffario:
- Un parametro di valutazione che indica che il piano tariffario è basato 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 è basato sul volume di transazioni, come nel caso dell'inserzionista modello di condivisione). - Il tipo di entrate (
GROSSoNET). Questa opzione 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 es. 30 giorni).
- L'ID della tua organizzazione.
- La "base" o valuta contabile utilizzata dalla tua azienda.
- 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, devi specificare una sola tariffa del piano tariffario.
Per un elenco completo delle proprietà dei dettagli dei piani tariffari, consulta Proprietà di configurazione per i dettagli dei piani tariffari.
Nella tariffa del piano tariffario, specifichi:
- 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 è dell'80,5555%, ovvero, in qualità di provider API, paghi allo sviluppatore l'80,5555% il prezzo addebitato per ogni transazione (o se si basa su un attributo personalizzato come il numero byte trasmessi in una transazione, paghi allo sviluppatore l'80,5555% del prezzo addebitato che trasmette il numero specificato di byte).
- L'unità iniziale dell'applicazione della tariffa (
0). Ciò significa che la tariffa applicati 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 segue crea un piano di quota di condivisione delle entrate con un modello di condivisione fisso. La la percentuale di quota di condivisione delle entrate è pari all'80,5555%. La quota di condivisione delle entrate è basata sul prezzo netto di un transazione. Il contratto entra in vigore il 15 settembre 2013 e il pagamento scade entro 30 giorni. (La 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 avere il seguente aspetto (è 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 quota di condivisione delle entrate per un modello di condivisione flessibile
In un modello di condivisione flessibile, specifichi i dettagli dei piani tariffari che includono uno o più piani tariffari tariffe. Ogni tariffa del piano tariffario copre una serie di entrate da transazioni (ogni intervallo è chiamato "entrate cinturino"). Assegna una percentuale di quota di condivisione delle entrate per ciascuna fascia di entrate.
Oltre alle tariffe del piano tariffario, nei dettagli del piano tariffario puoi specificare quanto segue:
- Un parametro di valutazione che indica che il piano tariffario è basato sulle transazioni
(
VOLUME)VOLUMEè l'impostazione predefinita. - Un tipo di misurazione (
VOLUME) che indica che la quota di condivisione delle entrate non è basata su il volume delle transazioni (ovvero non è fisso, come nel caso della condivisione modello). - Il tipo di entrate (
GROSSoNET). Questa opzione 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 es. 30 giorni).
- L'ID della tua organizzazione.
- La "base" o valuta contabile utilizzata dalla tua azienda.
- Un tipo di durata e durata che insieme specificano il periodo di tempo durante il quale le entrate vengono aggregati (questa operazione viene anche definita "base di aggregazione"). Le transazioni vengono aggregate di aggregazione (ad es. 1 mese) per calcolare le entrate totali e i fascia di entrate. La percentuale di quota di condivisione delle entrate applicata a ogni transazione dipende dalle relative entrate cinturino.
- Contatori di aggregazione utilizzati per determinare la fascia di entrate applicabile.
Per un elenco completo delle proprietà dei dettagli dei piani tariffari, consulta Proprietà di configurazione per i 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 fascia di entrate. Ad esempio, se specifichi 80.5555, la quota di condivisione delle entrate per la fascia di entrate è 80.5555%, ovvero come API fornitore, paghi allo sviluppatore l'80,5555% del prezzo addebitato per ogni transazione in fascia di entrate.
- L'unità iniziale e finale della fascia di entrate. L'unità iniziale specifica il valore
limite di una fascia di entrate e l'unità finale specifica il limite superiore di tale fascia. Per
Ad esempio, se specifichi un'unità iniziale pari a 0 e un'unità finale pari a 1000, la fascia di entrate
copre le entrate da transazioni superiori a 0 e fino a 1000 nella valuta specificata. Se
valuta è il dollaro statunitense, la base di aggregazione è 1 mese e la percentuale delle entrate
è pari all'80,5555%, per le transazioni che generano entrate fino a 1000 $in un mese la
la quota di condivisione delle entrate è pari all'80,5555% del prezzo della transazione.
Se non specifichi un'unità finale per la fascia di entrate finale, la percentuale di condivisione per questa banda viene applicata a tutte le transazioni dopo che le entrate complessive hanno superato unità iniziale per quella banda. Ad esempio, se l'unità iniziale per l'ultima banda è 1000. (supponi dollari USA) e non specifichi un'unità finale per quella banda, le entrate per la banda viene applicata a tutte le transazioni superiori a 1000 $di entrate durante periodo aggregato.
Per un elenco completo delle proprietà dei piani tariffari, consulta Proprietà di configurazione dei piani tariffari.
Ad esempio, di seguito viene creato un piano di condivisione delle entrate con un modello di condivisione flessibile. it specifica due fasce di entrate. La prima fascia copre le entrate da transazioni maggiori di 1000 dollari statunitensi. La seconda fascia riguarda le entrate da transazioni superiori a 1000 dollari USA. Le entrate la percentuale di condivisione è pari all'80,5555% per la prima fascia di entrate e al 90,5% per la seconda. La quota di condivisione delle entrate si basa sul prezzo netto di una transazione. La base di aggregazione è 1 mese. Il periodo di validità del contratto entrerà in vigore il 15 settembre 2013 e il pagamento dovrà essere effettuato entro 30 giorni. (le entrate i dettagli relativi alla condivisione 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 avere il seguente aspetto (è 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" }