Stai visualizzando la documentazione di Apigee Edge.
Visualizza la documentazione di Apigee X.
Gestisci i piani tariffari tramite l'interfaccia utente e l'API, come descritto nelle sezioni seguenti.
Esplorare la pagina Piani tariffari
Accedi alla pagina dei piani tariffari, come descritto di seguito.
Perimetrale
Per visualizzare i piani tariffari nell'interfaccia utente perimetrale, accedi alla pagina Piani tariffari:
- Accedi a apigee.com/edge.
- Seleziona Pubblica > Monetizzazione > Piani tariffari nella barra di navigazione a sinistra.
Viene visualizzata la pagina Piani tariffari.
Come evidenziato nella figura, la pagina Piani tariffari ti consente di:
- Visualizza informazioni di riepilogo per tutti i piani tariffari, inclusi nome del piano, pacchetto di prodotti API, stato (pubblicato o bozza), costo del piano e date di inizio e fine.
NOTA: i piani tariffari scaduti non vengono visualizzati nell'interfaccia utente. Per visualizzare i piani tariffari scaduti, utilizza l'API. Consulta la sezione Visualizzazione dei piani tariffari tramite l'API. - Creare un piano tariffario
- Modificare un piano tariffario
- Pubblicare un piano tariffario
- Eliminare una bozza di piano tariffario
- Aggiungi un piano tariffario futuro, come descritto in Gestire i piani tariffari futuri
- Cerca nell'elenco dei piani tariffari un campo visibile oppure il nome o la categoria dello sviluppatore (se applicabile)
Classic Edge (Cloud privato)
Per visualizzare i piani tariffari utilizzando l'interfaccia utente classica di Edge, accedi alla pagina Pacchetti API:
- Accedi a
http://ms-ip:9000, dove ms-ip è l'indirizzo IP o il nome DNS del nodo Gestione server. - Seleziona Pubblica > Pacchetti nella barra di navigazione in alto.
La pagina Pacchetti API mostra i piani tariffari definiti per ogni pacchetto.
La pagina Piani tariffari ti consente di:
- Creare un piano tariffario
- Modificare un piano tariffario
- Pubblicare un piano tariffario
- Eliminare una bozza di piano tariffario
- Aggiungi un piano tariffario futuro, come descritto in Gestire i piani tariffari futuri
- Cerca nell'elenco dei piani tariffari un campo visibile oppure il nome o la categoria dello sviluppatore (se applicabile)
Creare un piano tariffario
Per creare un piano tariffario:
- Accedi alla pagina Piani tariffari.
- Fai clic su + Piano tariffario.
- Configura i seguenti campi nel riquadro superiore:
Campo Descrizione Predefinito Obbligatorio Nome piano tariffario Nome del piano tariffario. NOTA: il nome deve essere univoco all'interno del bundle di prodotti API. Due piani nello stesso pacchetto di prodotti non possono avere lo stesso nome.
N/D Sì Tipo di piano tariffario Tipo di piano tariffario. Seleziona un valore dall'elenco a discesa. Per un elenco dei tipi di piani tariffari validi, consulta l'articolo Tipi di piani tariffari supportati. N/D Sì Set di prodotti Bundle di prodotti API. Seleziona un valore dall'elenco a discesa. Per ulteriori informazioni sui pacchetti di prodotti API, consulta la sezione Gestione dei pacchetti di prodotti API. Se selezioni un pacchetto di prodotti che contiene più di un prodotto API, devi scegliere se configurare singoli piani tariffari per ogni prodotto API o un piano tariffario generico che verrà applicato a tutti i prodotti API.
N/D Sì Pubblico Segmento di pubblico che può accedere al piano tariffario. Seleziona uno dei seguenti valori dall'elenco a discesa: - Tutti: tutti gli sviluppatori.
- Sviluppatore: lo sviluppatore o l'azienda. Inserisci il nome dello sviluppatore o la società. Mentre digiti, viene visualizzato un elenco a discesa di sviluppatori/aziende che contengono la stringa. Fai clic sul nome dello sviluppatore o dell'azienda nell'elenco a discesa.
- Categoria sviluppatore: categoria sviluppatore. Seleziona la categoria sviluppatore dall'elenco a discesa.
Configura le categorie di sviluppatori come necessario, come descritto nell'articolo Gestire le categorie di sviluppatori.
Tutti No Data di inizio La data di entrata in vigore del piano tariffario. Inserisci una data di inizio o selezionane una utilizzando il calendario. Oggi No Data di fine Data di fine del piano tariffario. Per specificare una data di fine, attiva l'opzione di attivazione della data di fine e inserisci una data di fine o selezionane una utilizzando il calendario. NOTA: il piano tariffario entrerà in vigore fino alla fine della giornata nella data specificata. Se vuoi far scadere un piano tariffario il 1° dicembre 2018, ad esempio, devi impostare il valore endDate su 2018-11-30. In questo caso, il piano tariffario scadrà alla fine della giornata del 30 novembre 2018; tutte le richieste del 1° dicembre 2018 verranno bloccate.
Nessuno No Visibile ai portali Imposta se il piano tariffario è Pubblico o Privato. Consulta le sezioni Confronto tra i piani tariffari pubblici e quelli privati. Abilitati No - Configura le tariffe per il piano tariffario. Consulta la sezione Configurazione delle tariffe per un piano tariffario.
NOTA: non applicabile ai piani di notifica regolabili. - Se selezioni un pacchetto di prodotti che contiene più di un prodotto API, imposta le seguenti preferenze nella sezione Piano tariffario specifico o generico:
NOTA: questo passaggio non è applicabile ai piani di notifica regolabili.
Campo Descrizione Predefinito Configurare ogni prodotto singolarmente Flag che specifica se configurare un singolo piano tariffario per ogni prodotto API. Disabilitata Configura l'offerta freemium di ogni prodotto singolarmente Flag che specifica se configurare un piano freemium per ciascun prodotto API. Disabilitata Seleziona un prodotto Se attivi uno o entrambi i flag, devi selezionare ciascun prodotto singolarmente dall'elenco a discesa e configurare i dettagli del relativo piano tariffario. NOTA: assicurati di configurare tutti i prodotti nel pacchetto di prodotti.
N/D - Configura i dettagli del piano tariffario in base al tipo di piano tariffario selezionato:
- Fai clic su una delle seguenti opzioni:
Pulsante Descrizione Salva come bozza Salva il piano tariffario come bozza. Il piano tariffario non sarà visibile agli sviluppatori di app finché non lo pubblichi. Puoi modificare qualsiasi campo di un piano tariffario in versione bozza.
Pubblica nuovo piano Pubblica il piano. NOTA: dopo aver pubblicato un piano tariffario, puoi modificare la data di fine solo se non è già impostata. Non puoi eliminare un piano tariffario dopo la pubblicazione, ma puoi far scadere il piano e sostituirlo con un piano tariffario futuro, come descritto nella sezione Scadenza di un piano tariffario pubblicato.
- Allega le norme relative al controllo dei limiti di monetizzazione ai proxy API associati ai prodotti API inclusi nel piano tariffario. Le norme relative al controllo dei limiti di monetizzazione applicano i limiti alla monetizzazione sui proxy API e garantiscono che eventuali errori vengano intercettati con precisione nei report di analisi e monetizzazione. Per maggiori informazioni, vedi Applicare i limiti di monetizzazione ai proxy API.
Modificare un piano tariffario
Puoi modificare tutti i campi di un piano tariffario in bozza, ad eccezione del pacchetto di prodotti, del tipo e del pubblico. Dopo aver pubblicato un piano tariffario, puoi modificare la data di fine solo e soltanto se non è stata specificata alcuna data di fine.
Per modificare un piano tariffario:
- Accedi alla pagina Piani tariffari.
- Fai clic sulla riga del piano tariffario che vuoi modificare.
Viene visualizzato il riquadro del piano tariffario. - Modifica i campi del piano tariffario, come richiesto.
NOTA: dopo aver pubblicato un piano tariffario, puoi modificare la data di fine solo se non è già impostata. - Fai clic su una delle seguenti opzioni:
Pulsante Descrizione Aggiornare la bozza (bollini dei piani tariffari) Salva il piano tariffario come bozza.
Il piano tariffario non sarà visibile agli sviluppatori di app finché non lo pubblichi. Puoi modificare qualsiasi campo di un piano tariffario in versione bozza.Pubblica bozza (piani di tariffe bozza) Pubblica il piano tariffario.
NOTA: dopo aver pubblicato un piano tariffario, puoi modificare la data di fine solo se non è già impostata. Non puoi eliminare un piano tariffario dopo la pubblicazione, ma puoi far scadere il piano e sostituirlo con un piano tariffario futuro, come descritto nella sezione Scadenza di un piano tariffario pubblicato.Data di fine aggiornata (piani tariffari pubblicati) Imposta la data di fine di un piano pubblicato.
NOTA: una volta impostata per un piano tariffario pubblicato, la data di fine non può più essere modificata.
Eliminare una bozza di piano tariffario
Eliminare una bozza di piano tariffario se non è più necessaria.
NOTA: non è possibile eliminare un piano tariffario pubblicato.
Per eliminare una bozza di piano tariffario:
- Accedi alla pagina Piani tariffari.
- Posiziona il cursore sul piano tariffario che vuoi eliminare per visualizzare il menu Azioni.
- Fai clic su
. - Fai clic su Elimina per confermare l'azione.
Gestione dei piani tariffari tramite l'API
Le seguenti sezioni descrivono come gestire i piani tariffari utilizzando l'API.
Creazione di piani tariffari utilizzando l'API
Per creare un piano tariffario, invia una richiesta POST a /organizations/{org_name}/monetization-packages/{monetizationpackage_id}/rate-plans, dove {monetizationpackage_id} è l'ID del pacchetto di prodotti API per cui crei il piano tariffario (l'ID viene restituito nella risposta quando crei il pacchetto di prodotti API).
Quando crei un piano tariffario, devi specificare quanto segue nel corpo della richiesta:
- ID organizzazione
- ID pacchetto prodotto API
- Nome del piano tariffario
- Descrizione del piano tariffario
- L'ambito del piano tariffario (che si applichi a tutti gli sviluppatori o solo a una specifica categoria di sviluppatori, di società o di sviluppatori)
- Data di entrata in vigore del piano tariffario
- Valuta del piano tariffario
- Se pubblicare il piano tariffario
- Indica se il piano tariffario è pubblico o privato
Altre impostazioni possono essere specificate facoltativamente, ad esempio il periodo in cui il pagamento è in scadenza (ad es. 30 giorni). Consulta la sezione Proprietà di configurazione per i piani tariffari.
Se crei un piano tariffario (diverso da un solo piano tariffario) per un pacchetto di prodotti API che include più prodotti, puoi applicare il piano a un prodotto specifico nel pacchetto. Per farlo, identifica il prodotto nella richiesta. Se non identifichi un prodotto, il piano viene applicato a tutti i prodotti nel bundle di prodotti dell'API.
Nelle sezioni che seguono viene descritto come creare piani tariffari:
- Creazione di un piano tariffario standard utilizzando l'API
- Creazione di uno sviluppatore o di un piano tariffario aziendale utilizzando l'API
- Creare un piano tariffario per categoria per sviluppatori utilizzando l'API
- Creazione di un piano tariffario specifico del prodotto utilizzando l'API
- Impostare il piano tariffario come pubblico o privato utilizzando l'API
Creare un piano tariffario standard utilizzando l'API
Per creare un piano tariffario standard, imposta l'attributo type su STANDARD, come mostrato nell'esempio seguente.
$ curl -H "Content-Type:application/json" -X POST -d \
'{
"name": "Simple rate plan",
"currency": {
"id" : "usd"
},
"description": "Simple rate plan",
"displayName" : "Simple rate plan",
"monetizationPackage": {
"id": "location"
},
"organization": {
"id": "{org_name}"
},
"published": true,
"isPrivate" : false,
"ratePlanDetails": [
{
…
}
],
"startDate": "2013-09-15",
"type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location_package/rate-plans" \
-u email:password
Creazione di un piano tariffario per sviluppatore o società tramite l'API
Per applicare il piano tariffario a uno sviluppatore o un'azienda specifici, imposta il valore type su
Developer. Devi anche identificare lo sviluppatore o l'azienda nella richiesta, identificando l'ID, il nome legale e il nome dello sviluppatore dell'azienda.
Ad esempio, il seguente estratto crea un piano tariffario per lo sviluppatore di Dev Five:
...
"type": "DEVELOPER",
"developer" : {
"id" : "0mkKu1PALUGfjUph",
"legalName" : "DEV FIVE",
"name" : "Dev Five"
}
...
Creare un piano tariffario per categoria sviluppatore utilizzando l'API
Per applicare il piano tariffario a una categoria di sviluppatori, imposta il valore type su
Developer_Category. Devi anche identificare la categoria di sviluppatori nella richiesta.
Ad esempio:
...
"type": "DEVELOPER_CATEGORY",
"developerCategory" : {
"id" : "5e172299-8232-45f9-ac46-40076139f373",
"name" : "Silver",
"description" : "Silver category"
}
...
Creazione di un piano tariffario specifico del prodotto utilizzando l'API
Quando crei un piano tariffario per i pacchetti di prodotti API che includono più prodotti API, puoi specificare i dettagli del piano tariffario per i prodotti API singolarmente.
Ad esempio, quanto segue crea un piano di quota di condivisione delle entrate con due prodotti API:
$ curl -H "Content-Type:application/json" -X POST -d \
'{
"name": "Multi-product rate plan",
"currency": {
"id" : "usd"
},
"description": "Multi-product rate plan",
"displayName" : "Multi-product rate plan",
"monetizationPackage": {
"id": "mypackage",
...
},
"organization": {
"id": "{org_name}",
...
},
"published": true,
"isPrivate" : false,
"ratePlanDetails": [
{
"ratePlanRates":[{
"revshare":0,
"startUnit":0,
"type":"REVSHARE",
"endUnit":null
}],
"revenueType":"NET",
"type":"REVSHARE"
"currency":{...},
"product":{"id":"product1","displayName":"Product1"},
"customPaymentTerm":false
},
{
"ratePlanRates":[{
"revshare":10,
"startUnit":0,
"type":"REVSHARE",
"endUnit":null
}],
"revenueType":"NET",
"type":"REVSHARE"
"currency":{...},
"product":{"id":"product2","displayName":"Product2"},
"customPaymentTerm":false
}
],
"startDate": "2019-09-15",
"type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/my-package/rate-plans" \
-u email:password
Per aggiungere un prodotto API al pacchetto di prodotti API my-package, devi inserire i dettagli del piano tariffario per il prodotto API nel corpo della richiesta, come descritto nella sezione Aggiungere un prodotto API a un pacchetto prodotti API con piani tariffari specifici del prodotto API.
$ curl -H "Content-Type:application/json" -X POST -d \
'{
"ratePlan": [
{
"id": "my-package_multi-product-rate-plan",
"ratePlanDetails": [
{
"ratePlanRates":[{
"revshare":20,
"startUnit":0,
"type":"REVSHARE",
"endUnit":null
}],
"revenueType":"NET",
"type":"REVSHARE"
"currency":{...},
"customPaymentTerm":false
}]
}]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/my-package/products/product3" \
-u email:password
Impostare il piano tariffario come pubblico o privato utilizzando l'API
Quando crei un piano tariffario, puoi specificare se è pubblico o privato utilizzando l'attributo isPrivate nel corpo della richiesta. Se è impostata su true, il piano tariffario sarà privato. Per maggiori informazioni, consulta la pagina Piani tariffari pubblici e privati.
Ad esempio, quanto segue crea un piano tariffario privato:
$ curl -H "Content-Type:application/json" -X POST -d \
'{
"name": "Simple rate plan",
"currency": {
"id" : "usd"
},
"description": "Simple rate plan",
"displayName" : "Simple rate plan",
"monetizationPackage": {
"id": "location"
},
"organization": {
"id": "{org_name}"
},
"published": true,
"isPrivate" : true,
"ratePlanDetails": [
{
…
}
],
"startDate": "2013-09-15",
"type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location_package/rate-plans" \
-u email:password
Pubblicazione di un piano tariffario utilizzando l'API
Per pubblicare un piano tariffario, imposta il valore della proprietà published su "true" quando crei il piano tariffario. Gli sviluppatori potranno visualizzare il piano tariffario a partire dalla data specificata nella proprietà startDate del piano.
Ad esempio, quanto segue crea un piano tariffario e lo pubblica (viene mostrata solo una parte della richiesta):
$ curl -H "Content-Type:application/json" -X POST -d \
'{
"name": "Flat rate card plan",
"developer":null,
"developerCategory":null,
"advance": "false",
…
"published": "true",
"ratePlanDetails": [
…
],
…
"type": "RATECARD"
}],
…
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password
Salvataggio di una bozza di piano tariffario con l'API
Per salvare un piano tariffario senza pubblicarlo, imposta il valore della proprietà published su false quando crei il piano tariffario.
Ad esempio, quanto segue crea un piano tariffario e lo salva come bozza (viene visualizzata solo una parte della richiesta):
$ curl -H "Content-Type:application/json" -X POST -d \
'{
"name": "Flat rate card plan",
"developer":null,
"developerCategory":null,
"advance": "false",
…
"published": "false",
"ratePlanDetails": [
…
],
…
"type": "RATECARD"
}],
…
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password
Modificare la bozza di un piano tariffario utilizzando l'API
Per aggiornare la bozza di un piano tariffario, invia una richiesta PUT a
/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_Id},
dove {package_id} è l'identificazione del pacchetto API e
{plan_Id} è l'identificazione del piano tariffario. Quando effettui l'aggiornamento, devi
specificare nel corpo della richiesta le impostazioni aggiornate e l'ID del piano tariffario. Se aggiorni una tariffa del piano tariffario, devi specificare anche l'ID. Ad esempio, la seguente richiesta aggiorna la tariffa del piano tariffario in un piano tariffario il cui ID è location_flat_rate_card_plan (l'aggiornamento è evidenziato):
$ curl -H "Content-Type: application/json" -X PUT -d \
'{
"id" : "location_flat_rate_card_plan",
"name": "Flat rate card plan",
"advance": "false",
"currency": {
"id" : "usd"
},
"description": "Flat rate card plan",
"displayName" : "Flat rate card plan",
"frequencyDuration": "30",
"frequencyDurationType": "DAY",
"earlyTerminationFee": "10",
"monetizationPackage": {
"id": "location"
},
"organization": {
"id": "{org_name}"
},
"paymentDueDays": "30",
"prorate": "false",
"published": "false",
"ratePlanDetails": [
{
"currency": {
"id" : "usd"
},
"paymentDueDays": "30",
"meteringType": "UNIT",
"organization": {
"id": "{org_name}"
},
"ratePlanRates": [
{
"id" : "26b69b0b-9863-48c9-ba73-74a5b918fcec",
"type": "RATECARD",
"rate": "0.15",
"startUnit": "0"
}
],
"ratingParameter": "VOLUME",
"type": "RATECARD"
}],
"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/location_flat_rate_card_plan" \
-u email:password
La risposta include la tariffa aggiornata del piano tariffario (viene visualizzata solo una parte della risposta):
…
"ratePlanRates" : [ {
"id" : "26b69b0b-9863-48c9-ba73-74a5b918fcec",
"rate" : 0.15,
"startUnit" : 0,
"type" : "RATECARD"
} ],
…
Visualizzare i piani tariffari utilizzando l'API
Puoi visualizzare i piani tariffari utilizzando l'API di monetizzazione, come descritto nelle sezioni seguenti.
- Visualizzazione di tutti i piani tariffari per un'organizzazione che utilizza l'API
- Visualizzazione di tutti i piani tariffari per un pacchetto di prodotti API utilizzando l'API
- Visualizzare un piano tariffario per un pacchetto di prodotti API utilizzando l'API
- Visualizzazione di tutti i piani tariffari attivi per uno sviluppatore che utilizza l'API
- Visualizzare un piano tariffario accettato per uno sviluppatore che utilizza l'API
- Visualizzare un piano tariffario accettato per uno sviluppatore che contiene un prodotto API che utilizza l'API
- Visualizzazione di tutti i piani tariffari accettati da uno sviluppatore che utilizza l'API
Visualizzazione di tutti i piani tariffari per un'organizzazione che utilizza l'API
Per visualizzare tutti i piani tariffari per un'organizzazione, invia una richiesta GET
a /mint/organizations/{org_name}/rate-plans,
dove {org_name} è il nome della tua organizzazione.
Puoi filtrare i seguenti parametri di ricerca per filtrare i risultati:
| Parametro di ricerca | Descrizione |
|---|---|
all |
Flag che specifica se restituire tutti i piani tariffari. Se è impostato su false, il numero di piani tariffari restituiti per pagina è definito dal parametro di ricerca size. Il valore predefinito è true. |
size |
Numero di pacchetti API restituiti per pagina. Se il parametro di ricerca all è impostato su true, viene ignorato. |
page |
Numero della pagina che vuoi restituire (se i contenuti sono impaginati). Se il parametro di ricerca all è impostato su true, questo parametro viene ignorato. |
Ad esempio:
curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/rate-plans" \ -u email:password
Visualizzazione di tutti i piani tariffari per un pacchetto di prodotti API utilizzando l'API
Per visualizzare tutti i piani tariffari per un pacchetto API, invia una richiesta GET
a /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans,
dove {package_id} è l'ID del pacchetto API (l'ID pacchetto
viene restituito quando crei il pacchetto di monetizzazione).
Per impostazione predefinita, nei risultati vengono restituiti solo piani tariffari attivi, pubblici e standard. Per farlo:
- Imposta i piani tariffari in modalità bozza o scaduta, imposta il parametro di ricerca
currentsufalse(ad esempio?current=false). - Piani tariffari privati, imposta il parametro di ricerca
showPrivatesutrue(ad esempio,?showPrivate=true). - Tutti i piani tariffari standard, imposta il parametro di ricerca
standardsutrue(ad esempio,?standard=true).
Ad esempio:
curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/communications/rate-plans" \ -u email:password
Visualizzazione di un piano tariffario per un pacchetto API tramite l'API
Per visualizzare un piano tariffario per un pacchetto API, emetti una richiesta GET
a /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_id},
dove {package_id} è l'ID del pacchetto API e {plan_id} è
l'ID del piano tariffario (l'ID pacchetto viene restituito quando crei il pacchetto di monetizzazione e l'ID piano tariffario viene restituito al momento della creazione del piano tariffario).
Ad esempio:
curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/communications/rate-plans/communications_standard_fixed_plan" \ -u email:password
Di seguito è riportato un esempio di risposta:
{
"advance" : true,
"contractDuration" : 1,
"contractDurationType" : "YEAR",
"currency" : {
"id" : "usd",
...
"organization" : {
...
},
...
},
"description" : "Standard Fixed Plan",
"displayName" : "Standard Fixed Plan",
"earlyTerminationFee" : 0.0000,
"frequencyDuration" : 1,
"frequencyDurationType" : "MONTH",
"id" : "communications_standard_fixed_plan",
"isPrivate" : false,
"monetizationPackage" : {
"description" : "Communications",
"displayName" : "Communications",
"id" : "communications",
"name" : "Communications",
"organization" : {
...
},
"product" : [ {
"customAtt1Name" : "user",
"description" : "Location",
"displayName" : "Location",
"id" : "location",
"name" : "location",
"organization" : {
...
},
"status" : "CREATED"
}, {
"customAtt1Name" : "user",
"description" : "Messaging",
"displayName" : "Messaging",
"id" : "messaging",
"name" : "messaging",
"organization" : {
...
},
"status" : "CREATED"
} ],
"status" : "CREATED"
},
"name" : "Standard Fixed Plan",
"organization" : {
...
},
"paymentDueDays" : "30",
"prorate" : true,
"published" : true,
"ratePlanDetails" : [ {
"aggregateFreemiumCounters" : true,
"aggregateStandardCounters" : true,
"currency" : {
"id" : "usd",
"name" : "USD",
"organization" : {
...
},
"status" : "ACTIVE",
"virtualCurrency" : false
},
"id" : "cb92f7f3-7331-446f-ad63-3e176ad06a86",
"meteringType" : "UNIT",
"organization" : {
...
},
"paymentDueDays" : "30",
"ratePlanRates" : [ {
"id" : "07eefdfb-4db5-47f6-b182-5d606c6051c2",
"rate" : 0.0500,
"startUnit" : 0,
"type" : "RATECARD"
} ],
"ratingParameter" : "VOLUME",
"type" : "RATECARD"
} ],
"recurringFee" : 200.0000,
"recurringStartUnit" : 1,
"recurringType" : "CALENDAR",
"setUpFee" : 100.0000,
"startDate" : "2013-01-11 22:00:00",
"type" : "STANDARD"
}
Visualizzazione di tutti i piani tariffari attivi per uno sviluppatore che utilizza l'API
Per visualizzare tutti i piani tariffari attivi per uno sviluppatore, invia una richiesta GET a /mint/organizations/{org_name}/developers/{developer_id}/developer-rateplans, dove {developer_id} è l'indirizzo email dello sviluppatore.
Puoi filtrare i seguenti parametri di ricerca per filtrare i risultati:
| Parametro di ricerca | Descrizione |
|---|---|
all |
Flag che specifica se restituire tutti i pacchetti API. Se impostato su false, il numero di pacchetti API restituiti per ogni pagina viene definito dal parametro di ricerca size. Il valore predefinito è false. |
size |
Numero di pacchetti API restituiti per pagina. Il valore predefinito è 20. Se il parametro di ricerca all è impostato su true, viene ignorato. |
page |
Numero della pagina che vuoi restituire (se i contenuti sono impaginati). Se il parametro di ricerca all è impostato su true, questo parametro viene ignorato. |
Ad esempio:
curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans" \ -u email:password
Di seguito è riportato un esempio di risposta:
{
"ratePlan" : [ {
"advance" : true,
"contractDuration" : 1,
"contractDurationType" : "MONTH",
"currency" : {
"description" : "United States Dollar",
"displayName" : "United States Dollar",
"id" : "usd",
"name" : "USD",
"organization" : {
...
},
"status" : "ACTIVE",
"virtualCurrency" : false
},
"description" : "Fee Only RatePlan",
"displayName" : "Fee Only RatePlan",
"earlyTerminationFee" : 10.0000,
"freemiumDuration" : 0,
"freemiumDurationType" : "MONTH",
"freemiumUnit" : 0,
"frequencyDuration" : 1,
"frequencyDurationType" : "WEEK",
"id" : "messaging_package_fee_only_rateplan",
"isPrivate" : false,
"monetizationPackage" : {
"description" : "messaging package",
"displayName" : "Messaging Package",
"id" : "messaging_package",
"name" : "Messaging Package",
"organization" : {
...
},
"product" : [ {
"customAtt1Name" : "user",
"customAtt2Name" : "response size",
"customAtt3Name" : "content-length",
"description" : "messaging api product",
"displayName" : "messaging",
"id" : "messaging",
"name" : "messaging",
"organization" : {
...
},
"status" : "CREATED",
"transactionSuccessCriteria" : "status == 'SUCCESS'"
} ],
"status" : "CREATED"
},
"name" : "Fee Only RatePlan",
"organization" : {
...
},
"paymentDueDays" : "30",
"prorate" : false,
"published" : true,
"ratePlanDetails" : [ ],
"recurringFee" : 10.0000,
"recurringStartUnit" : 1,
"recurringType" : "CALENDAR",
"setUpFee" : 20.0000,
"startDate" : "2013-02-20 00:00:00",
"type" : "STANDARD"
} ],
"totalRecords" : 1
}
Visualizzare un piano tariffario accettato per uno sviluppatore che utilizza l'API
Per visualizzare un piano tariffario attivo per uno sviluppatore, invia una richiesta GET a
/mint/organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id},
dove {developer_id} è l'indirizzo email dello sviluppatore e {developer_rateplan_id} è
l'ID del piano tariffario accettato che viene restituito nella risposta quando accetti il piano tariffario pubblicato.
Ad esempio:
curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/messaging_package_fee_only_rateplan" \ -u email:password
Di seguito è riportato un esempio di risposta:
{
"created" : "2018-01-25 20:01:54",
"developer" : {
},
"id" : "a73s104-276f-45b3-8075-83d1046ea550",
"nextCycleStartDate" : "2018-02-19 00:00:00",
"nextRecurringFeeDate" : "2018-02-19 00:00:00",
"prevRecurringFeeDate" : "2018-01-25 00:00:00",
"ratePlan" : {
"frequencyDuration" : 1,
"frequencyDurationType" : "MONTH",
"recurringFee" : 0.0000,
"recurringStartUnit" : 19,
"recurringType" : "CALENDAR",
"setUpFee" : 0.0000,
"type" : "STANDARD"
},
"startDate" : "2018-01-25 20:01:54",
"updated" : "2018-01-25 20:01:54"
}
Visualizzare un piano tariffario accettato per uno sviluppatore che contiene un prodotto API utilizzando l'API
Per visualizzare un piano tariffario accettato per uno sviluppatore che contiene un prodotto API, invia una richiesta GET a /mint/organizations/{org_id}/developers/{developer_id}/products/{product_id}/rate-plan-by-developer-product, dove {developer_id} è l'ID dello sviluppatore e /{product_id} è l'ID del prodotto.
Per impostazione predefinita, nei risultati viene restituito solo un piano tariffario pubblico. Per visualizzare un piano tariffario privato,
imposta il parametro di ricerca showPrivate su true (ad esempio,
?showPrivate=true).
Ad esempio:
curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/products/location/rate-plan-by-developer-product" \ -u email:password
Visualizzazione di tutti i piani tariffari accettati da uno sviluppatore che utilizza l'API
Per visualizzare i piani tariffari accettati da uno sviluppatore, invia una richiesta GET a
/mint/organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans,
dove {developer_id} è l'ID dello sviluppatore.
Puoi filtrare i seguenti parametri di ricerca per filtrare i risultati:
| Parametro di ricerca | Descrizione |
|---|---|
all |
Flag che specifica se restituire tutti i pacchetti API. Se impostato su false, il numero di pacchetti API restituiti per ogni pagina viene definito dal parametro di ricerca size. Il valore predefinito è false. |
size |
Numero di pacchetti API restituiti per pagina. Il valore predefinito è 20. Se il parametro di ricerca all è impostato su true, viene ignorato. |
page |
Numero della pagina che vuoi restituire (se i contenuti sono impaginati). Se il parametro di ricerca all è impostato su true, questo parametro viene ignorato. |
Ad esempio:
curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-accepted-rateplans" \ -u email:password
Di seguito è riportato un esempio di risposta:
{
"developerRatePlan" : [ {
"created" : "2018-01-25 20:01:54",
"developer" : { ...
},
"id" : "a73s104-276f-45b3-8075-83d1046ea550",
"nextCycleStartDate" : "2018-02-19 00:00:00",
"nextRecurringFeeDate" : "2018-02-19 00:00:00",
"prevRecurringFeeDate" : "2018-01-25 00:00:00",
"ratePlan" : {
"frequencyDuration" : 1,
"frequencyDurationType" : "MONTH",
"recurringFee" : 0.0000,
"recurringStartUnit" : 19,
"recurringType" : "CALENDAR",
"setUpFee" : 0.0000,
"type" : "STANDARD"
},
"startDate" : "2018-01-25 20:01:54",
"updated" : "2018-01-25 20:01:54"
}],
"totalRecords" : 1
}
Eliminare la bozza di un piano tariffario utilizzando l'API
Per eliminare una bozza di piano tariffario, invia una richiesta DELETE a
/organizations/{org_name}/monetization-packages/package_id}/rate-plans/{plan_Id},
dove {plan_Id} è l'identificazione del piano tariffario da eliminare e
{package_id} è l'identificazione del pacchetto API per il piano tariffario. Ad esempio:
$ curl -H "Accept:application/json" -X DELETE \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans/location_flat_rate_card_plan" \
-u email:password
Proprietà di configurazione per i piani tariffari
Quando crei un piano tariffario utilizzando l'API, puoi specificare le impostazioni di configurazione seguenti.
| Nome | Descrizione | Predefinito | Campo obbligatorio? |
|---|---|---|---|
advance |
Offerta valida solo per tariffe ricorrenti. Flag che specifica se la tariffa ricorrente viene addebitata in anticipo. I valori validi includono:
|
false | No |
contractDuration |
Durata del contratto con il piano insieme a |
N/D | No |
contractDurationType |
Durata del contratto con il piano insieme a
|
N/D | No |
currency |
Valuta utilizzata per il piano tariffario. Specifica il codice ISO 4217 per la valuta, ad esempio
|
N/D | Sì |
description |
Descrizione del piano tariffario. |
N/D | Sì |
developer |
ID sviluppatore (indirizzo email). Specifica soltanto per i piani tariffari dello sviluppatore. |
N/D | No |
developerCategory |
ID categoria sviluppatore Specifica soltanto per i piani tariffari della categoria di sviluppatori. |
N/D | No |
displayName |
Nome visualizzato intuitivo per il piano tariffario. |
N/D | Sì |
earlyTerminationFee |
Tariffa una tantum che viene addebitata se lo sviluppatore termina il piano prima della scadenza del rinnovo. |
N/D | No |
endDate |
Data di fine del piano. Gli sviluppatori non potranno visualizzare il piano tariffario dopo questa data. Se non vuoi che il piano tariffario termini in una data specifica, specifica un valore null per Il piano tariffario sarà in vigore fino alla fine della giornata nella data specificata. Ad esempio, se vuoi far scadere un piano tariffario il 1° dicembre 2016, devi impostare il valore endDate su 2016-11-30. In questo caso, il piano tariffario scadrà alla fine della giornata il 30 novembre 2016; tutte le richieste il 1° dicembre 2016 verranno bloccate. NOTA: quando visualizzi il piano tariffario utilizzando l'API, il timestamp endDate è specificato come
|
N/D | No |
freemiumDuration |
Periodo di tempo del periodo freemium con
|
N/D | No |
freemiumDurationType |
Il periodo del periodo freemium con
|
N/D | No |
freemiumUnit |
Quantità freemium. Il valore può essere il numero di transazioni o il numero di unità relative a un attributo personalizzato registrato nel criterio di registrazione delle transazioni. |
N/D | No |
frequencyDuration |
Offerta valida solo per tariffe ricorrenti. Periodo di tempo tra le tariffe ricorrenti degli addebiti insieme a |
N/D | No |
frequencyDurationType |
Offerta valida solo per tariffe ricorrenti. Periodo di tempo tra le tariffe ricorrenti degli addebiti insieme a frequencyDuration. I valori validi includono:
|
N/D | No |
isPrivate |
Flag che specifica se il piano tariffario è pubblico o privato. Il valore predefinito è
false (pubblico). Per maggiori informazioni, consulta la pagina
Piani tariffari pubblici e privati. |
N/D | No |
monetizationPackage |
ID pacchetto del prodotto API per il piano tariffario. |
N/D | No |
name |
Nome del piano tariffario. |
N/D | Sì |
organization |
ID organizzazione del piano tariffario. |
N/D | Sì |
paymentDueDays |
Offerta valida solo per tariffe ricorrenti. Numero di giorni di scadenza delle tariffe. Ad esempio, imposta il valore su 30 per indicare che le tariffe sono dovute entro 30 giorni. |
N/D | No |
proRate |
Offerta valida solo per tariffe ricorrenti. Flag che specifica se la tariffa ricorrente viene ripartita proporzionalmente quando uno sviluppatore inizia o termina un piano nell'arco di un mese. I valori validi includono:
|
false | No |
published |
Flag che specifica se il piano tariffario deve essere pubblicato o meno per la visualizzazione dagli sviluppatori. I valori validi includono:
|
N/D | Sì |
ratePlanDetails |
Dettagli per il piano tariffario (consulta Proprietà di configurazione per i dettagli dei piani tariffari). |
N/D | Sì |
recurringFee |
Tariffa che viene addebitata allo sviluppatore su base continuativa fino al termine del piano. |
N/D | No |
recurringStartUnit |
Valido solo se il criterio |
N/D | No |
recurringType |
Pianifica la tariffa ricorrente. I valori validi includono:
|
N/D | No |
setUpFee |
La tariffa una tantum che viene addebitata a ogni sviluppatore alla data di inizio del piano (ovvero la data in cui viene acquistato il piano). |
N/D | No |
startDate |
Data di inizio del piano. Gli sviluppatori possono visualizzare il piano tariffario a partire da questa data. |
N/D | Sì |
type |
Tipo di piano tariffario. Specifica una delle seguenti opzioni:
|
N/D | Sì |
Proprietà di configurazione per i dettagli del piano tariffario
Puoi specificare una qualsiasi delle seguenti entità di configurazione come parte dell'array di ratePlanDetails durante la creazione del piano tariffario.
| Nome | Descrizione | Predefinito | Campo obbligatorio? |
|---|---|---|---|
aggregateFreemiumCounters |
Flag che specifica se sono abilitati o meno i contatori aggregati per determinare se l'utilizzo di un prodotto API rientra nell'intervallo senza costi. I contatori aggregati devono essere attivati per configurare un piano freemium per un prodotto. I valori validi includono:
|
N/D | No |
aggregateStandardCounters |
Flag che specifica se vengono utilizzati o meno i contatori aggregati per determinare la banda di utilizzo (ad esempio una banda di volume per un piano tariffario). Il valore può essere uno dei seguenti:
|
N/D | No |
aggregateTransactions |
NOTA: questa proprietà non è attualmente utilizzata per la monetizzazione e può essere ignorata. |
true | No |
currency |
Valuta. |
N/D | No |
duration |
Periodo di tempo della frequenza di calcolo, insieme a Ad esempio, imposta |
N/D | No |
durationType |
Periodo di tempo della frequenza di calcolo insieme a Vedi |
N/D | No |
freemiumDuration |
Periodo di tempo per il periodo freemium per un singolo prodotto API insieme a |
N/D | No |
freemiumDurationType |
Periodo di tempo per il periodo freemium per un singolo prodotto API insieme a
Ad esempio, per specificare che il periodo di freemium per un prodotto API è di 30 giorni, imposta |
N/D | No |
freemiumUnit |
Quantità freemium per un prodotto API. Il valore può corrispondere al numero di transazioni o al numero di unità relative a un attributo personalizzato registrato nel criterio di registrazione delle transazioni. |
N/D | No |
meteringType |
Modello di addebito per un piano tariffario. I valori validi includono:
|
N/D | sì |
organization |
ID organizzazione. |
N/D | No |
paymentDueDays |
Data di scadenza del pagamento per uno sviluppatore con pagamento posticipato. Ad esempio, imposta il valore su 30 per indicare che il pagamento è dovuto entro 30 giorni. |
N/D | No |
product |
Informazioni sul prodotto API, come l'ID. |
N/D | No |
ratePlanRates |
Dettagli della tariffa del piano, come il tipo di piano tariffario ( |
N/D | Sì |
ratingParameter |
Base del piano tariffario. Il piano tariffario si basa sulle transazioni o su un attributo personalizzato. I valori validi includono:
|
VOLUME |
Sì |
ratingParameterUnit |
L'unità che si applica a |
N/D | Sì |
revenueType |
Base della quota di condivisione delle entrate in un piano di quota di condivisione delle entrate. I valori validi includono:
|
N/D | No |
type |
Tipo di piano tariffario. I valori validi includono:
Per ulteriori informazioni sui tipi di piani tariffari, consulta l'articolo Tipi di piani tariffari supportati. |
N/D | Sì |