Gestione dei piani tariffari per i prodotti API

Questa pagina si applica a Apigee e Apigee ibrido.

Visualizza la documentazione di Apigee Edge.

Utilizzando i piani tariffari, i proprietari dei prodotti API possono monetizzare i propri prodotti API configurando quanto segue:

• Modello di account di fatturazione
• Valuta utilizzata per la fatturazione
• Frequenza di fatturazione ai clienti (solo mensile)
• Tariffe di configurazione iniziali per l'utilizzo di un prodotto API
• Costi basati sul consumo per l'utilizzo di un prodotto API
• Eventuali tariffe ricorrenti non basate sul consumo, ad esempio le tariffe mensili per l'accesso al tuo prodotto API.
• Intervallo di tempo durante il quale il piano tariffario viene applicato per un prodotto API (attivazione e scadenza del piano tariffario)
• Condivisione delle entrate con gli sviluppatori partner

Nota: puoi associare più piani tariffari allo stesso prodotto API, ma può essere attivo un solo piano tariffario in qualsiasi momento.

Gestisci i piani tariffari per i tuoi prodotti API come descritto nelle sezioni seguenti.

Visualizzazione dei piani tariffari

Visualizza i piani tariffari nella tua organizzazione come descritto nelle sezioni seguenti.

Interfaccia utente di Apigee

Visualizza i piani tariffari utilizzando l'interfaccia utente, come descritto nelle seguenti sezioni:

• Visualizzare i piani tariffari definiti per la tua organizzazione
• Visualizzazione dei piani tariffari associati a un prodotto API

Visualizzare i piani tariffari definiti per la tua organizzazione

Visualizza i piani tariffari definiti per la tua organizzazione nella pagina Piani tariffari.

Per accedere alla pagina Piani tariffari:

1. Accedi all'UI di Apigee.
2. Seleziona Pubblica> Monetizzazione> Piani tariffari nella barra di navigazione laterale.

Si apre la pagina Piani tariffari, in cui sono elencati i piani tariffari correnti.

Come evidenziato nella figura precedente, la pagina Piani tariffari ti consente di:

• Creare e aggiornare piani tariffari
• Gestisci i piani tariffari nel seguente modo:
  • Impostare i tempi di attivazione e scadenza per un piano tariffario
  • Pubblicare un piano tariffario (disponibile solo per le bozze di piani tariffari)
  • Sposta un piano tariffario pubblicato allo stato di bozza (disponibile solo per i piani tariffari pubblicati)
  • Clonare un piano tariffario
  • Eliminare un piano tariffario
• Visualizza i dettagli di ogni piano tariffario, inclusi il prodotto API associato, lo stato (Published o Draft), se è attivo e i tempi di attivazione e scadenza

Visualizzare i piani tariffari associati a un prodotto API

Quando gestisci un prodotto API, puoi visualizzare e gestire i piani tariffari associati a un prodotto API, come mostrato nella figura che segue.

API Apigee

Le seguenti sezioni descrivono come visualizzare i piani tariffari per un'organizzazione utilizzando l'API:

• Elenco dei piani tariffari per un prodotto API
• Visualizzare i dettagli di un piano tariffario

Elenco dei piani tariffari per un prodotto API utilizzando l'API

Per elencare i piani tariffari per l'organizzazione, invia una richiesta GET alla seguente API: https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans

Ad esempio, utilizzando curl:

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans?expand=true" \
  -X GET \
  -H "Authorization: Bearer $TOKEN"

Dove $TOKEN è impostato sul token di accesso OAuth 2.0, come descritto in Ottenere un token di accesso OAuth 2.0. Per informazioni sulle opzioni curl utilizzate in questo esempio, consulta Utilizzo di curl. Per una descrizione delle variabili di ambiente utilizzate, consulta Impostare le variabili di ambiente per le richieste API Apigee.

Di seguito è riportato un esempio dell'output della risposta, che include i due piani tariffari, myrateplan1 e myrateplan2, associati al prodotto API HelloworldProduct:

{
    "ratePlans": [
        {
            "name": "6b51b501-ac15-41b7-bb3e-621edb849e13",
            "apiproduct": "HelloworldProduct",
            "displayName": "myrateplan2",
            "billingPeriod": "MONTHLY",
            "currencyCode": "USD",
            "setupFee": {
                "currencyCode": "USD",
                "units": "20"
            },
            "fixedRecurringFee": {
                "currencyCode": "USD",
                "units": "25"
            },
            "fixedFeeFrequency": 1,
            "consumptionPricingType": "FIXED_PER_UNIT",
            "consumptionPricingRates": [
                {
                    "fee": {
                        "currencyCode": "USD",
                        "nanos": 500000000
                    }
                }
            ],
            "revenueShareType": "FIXED",
            "revenueShareRates": [
                {
                    "sharePercentage": 2
                }
            ],
            "state": "DRAFT"
        },
        {
            "name": "8c0b527c-ba2f-45f1-ac1c-b9e891546fc2",
            "apiproduct": "HelloworldProduct",
            "displayName": "myrateplan1",
            "billingPeriod": "MONTHLY",
            "currencyCode": "USD",
            "consumptionPricingType": "FIXED_PER_UNIT",
            "consumptionPricingRates": [
                {
                    "fee": {
                        "currencyCode": "USD",
                        "units": "3"
                    }
                }
            ],
            "state": "PUBLISHED",
            "startTime": "1617302588000"
        }
    ]
}

Per ulteriori informazioni sull'API e sul suo payload di risposta, consulta la pagina relativa all'API List Rate Plan

Visualizzare i dettagli di un piano tariffario utilizzando l'API

Per visualizzare i dettagli di un piano tariffario, invia una richiesta GET alla seguente API: https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME

Per determinare il nome del piano tariffario da passare nel percorso della risorsa, consulta la sezione Elenco dei piani tariffari in un'organizzazione.

Ad esempio, utilizzando curl:

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME" \
  -X GET \
  -H "Authorization: Bearer $TOKEN"

Dove $TOKEN è impostato sul token di accesso OAuth 2.0, come descritto in Ottenere un token di accesso OAuth 2.0. Per informazioni sulle opzioni curl utilizzate in questo esempio, consulta Utilizzo di curl. Per una descrizione delle variabili di ambiente utilizzate, consulta Impostare le variabili di ambiente per le richieste API Apigee.

Di seguito è riportato un esempio dell'output di risposta per il piano tariffario denominato 6b51b501-ac15-41b7-bb3e-621edb849e13 e nome visualizzato myrateplan2:

{
    "name": "6b51b501-ac15-41b7-bb3e-621edb849e13",
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan2",
    "billingPeriod": "MONTHLY",
    "currencyCode": "USD",
    "setupFee": {
        "currencyCode": "USD",
        "units": "20"
    },
    "fixedRecurringFee": {
        "currencyCode": "USD",
        "units": "25"
    },
    "fixedFeeFrequency": 1,
    "consumptionPricingType": "FIXED_PER_UNIT",
    "consumptionPricingRates": [
        {
            "fee": {
                "currencyCode": "USD",
                "nanos": 500000000
            }
        }
    ],
    "revenueShareType": "FIXED",
    "revenueShareRates": [
        {
            "sharePercentage": 2
        }
    ],
    "state": "DRAFT"
}

Per maggiori informazioni sull'API e sul suo payload di risposta, consulta Ottieni l'API del piano tariffario.

Creazione di piani tariffari

Crea piani tariffari come descritto nelle sezioni seguenti.

Interfaccia utente di Apigee

Per creare un piano tariffario utilizzando l'interfaccia utente:

1. Esegui una delle seguenti attività:
   • Seleziona Pubblica> Monetizzazione> Piani tariffari nella barra di navigazione laterale e fai clic su Crea piano tariffario.
   • Modifica un prodotto API e fai clic su nella sezione Piani tariffari.
2. Inserisci i Dettagli del piano tariffario come segue:

   Campo	Descrizione
   Nome piano tariffario	Inserisci il nome del piano tariffario.
   Prodotto API	Dal menu a discesa, seleziona un prodotto API a cui vuoi associare il piano tariffario.

3. Fai clic su Avanti.
4. Inserisci i dettagli di fatturazione come segue:

   Campo	Descrizione	Predefinita
   Valuta di fatturazione	Seleziona la valuta da utilizzare per la fatturazione dal menu a discesa.	USD
   Periodo di fatturazione	Dal menu a discesa, seleziona la frequenza con cui verrà addebitata la fattura al cliente. Nota: Monthly è l'unica opzione valida in questa release.	Ogni mese
   Modello di finanziamento dei pagamenti	Seleziona il modello di pagamento utilizzato per i pagamenti degli account. Postpaid è l'unica opzione valida in questa release. Nota: L'opzione del modello di finanziamento a pagamento è disponibile solo nella release Apigee Hybrid 1.5. In Apigee, le release di monetizzazione a partire dal 3 novembre 2021 non dispongono dell'opzione del modello di finanziamento con pagamento. Se specifichi l'opzione paymentFundingModel nell'API durante la creazione di un piano tariffario, Apigee ignora il valore.	Pagamento posticipato
   Tariffa di inizializzazione	Tariffa una tantum addebitata a ogni sviluppatore alla data di inizio del piano tariffario (ossia la data in cui lo sviluppatore acquista il prodotto API). Se vuoi addebitare la tariffa di configurazione, seleziona Charge setup Fee (Addebito tariffa di configurazione) e inserisci l'importo da addebitare nel campo Inizialization Fee (Tariffa di inizializzazione).	Disabilitata

5. Fai clic su Avanti.
6. Inserisci i dettagli dei prezzi come segue.

   Campo	Descrizione	Predefinita
   Tariffa ricorrente fissa	Abilita una tariffa ricorrente fissa per unità: Seleziona Addebita tariffa ricorrente fissa. Configura l'importo della Tariffa ricorrente fissa e la Frequenza della tariffa. La tariffa verrà ripartita proporzionalmente per il primo periodo di fatturazione. Se attivata, puoi visualizzare in anteprima gli effetti che la tariffa ricorrente fissa avrà sugli addebiti dettagliati e totali, come descritto in Anteprima del piano tariffario. Per disattivare la tariffa, deseleziona Addebita tariffa ricorrente fissa.	Disabilitata
   Tariffe basate sul consumo	Abilita i prezzi basati sul consumo: Seleziona Charge Charge-based Fee (Tariffa basata sul consumo). Seleziona una delle seguenti opzioni: Tariffa fissa per unità (tariffa fissa per unità consumata) A bande (una tariffa variabile per unità consumata, determinata dagli intervalli di consumo) Tariffa fissa per unità: viene addebitata una tariffa fissa per ogni transazione monetizzata. Inserisci nel campo Tariffa fissa per unità un valore che deve essere addebitato per ogni transazione. Collegati:viene addebitata una tariffa variabile per ogni transazione monetizzata. La banda della transazione e il consumo determinano le commissioni di una transazione. Una banda si riferisce a un intervallo di consumo delle API e ogni banda ha una tariffa diversa. Nella sezione Ranges of unit consumption, puoi specificare gli intervalli di banda e le tariffe corrispondenti per la banda. Puoi specificare tutte le bande che vuoi facendo clic su + BAND. Esempio: supponiamo che tu voglia addebitare 2 $ per le prime 1000 chiamate API a 2 $ per chiamata e tutte le chiamate API successive a 1 $ per chiamata. Per configurarlo, specifica le due bande seguenti nella sezione Ranges of unit consumption: Nella prima riga, inserisci i seguenti valori: Inizio: 0 Fine: 1000 Tariffa:2 Nella seconda riga, inserisci i seguenti valori: Inizio:1001 Fine: unità illimitate Tariffa:1 In questo esempio, se uno sviluppatore utilizza 1500 API, le tariffe totali saranno di 2500 $ ((1000 * 2) + (500 * 1)). Nota: il contatore di chiamate API per uno sviluppatore persiste a prescindere dal comportamento dell'abbonamento. Ad esempio, se uno sviluppatore si abbona a un piano tariffario con una tariffa variabile, effettua cinque chiamate API, annulla l'iscrizione e poi si abbona di nuovo, la chiamata successiva verrà considerata come la sesta chiamata anziché la prima. I contatori delle chiamate API vengono reimpostati alla fine di ogni mese del periodo di fatturazione. Se attivi le tariffe basate sul consumo, puoi visualizzare l'anteprima degli effetti del tipo di tariffa selezionato sulle entrate complessive, come descritto in Anteprima del piano tariffario. Per disattivare la tariffa, deseleziona Modello di prezzi basato sul consumo di addebito. Se hai configurato la variabile di monetizzazione perUnitPriceMultiplier nel criterio Data Capture, il costo per transazione specificato in qualsiasi tipo (tariffa fissa per unità o a banda) di tariffe basate sul consumo viene moltiplicato per il valore di perUnitPriceMultiplier. Nota: una transazione viene monetizzata in base al valore della variabile di monetizzazione transactionSuccess. Per maggiori informazioni, consulta la pagina Variabili di monetizzazione.	Disabilitata

7. Fai clic su Avanti.
8. Inserisci i dettagli della condivisione delle entrate come segue:

   Campo	Descrizione	Predefinita
   Quota di condivisione delle entrate	Attiva la condivisione delle entrate per condividere una percentuale delle entrate con gli sviluppatori partner. Seleziona Attiva la condivisione delle entrate. Inserisci una percentuale delle entrate da condividere nel campo Percentuale (%) di entrate da condividere con lo sviluppatore. Per ottenere le entrate condivise per ogni transazione monetizzata, configura la variabile di monetizzazione revShareGrossPrice nel criterio Data Capture. Per saperne di più, consulta la pagina Variabili di monetizzazione. Se attivi la condivisione delle entrate, puoi visualizzare l'anteprima degli effetti del valore Percentuale (%) inserito sugli addebiti dettagliati e totali, come descritto in Anteprima del piano tariffario. Per disattivare la tariffa, deseleziona Attiva la condivisione delle entrate.	Disabilitata

9. Fai clic su Avanti.
10. Fai clic su una delle seguenti opzioni:
    • Salva e pubblica per salvare e pubblicare il piano tariffario. Ti verrà chiesta una data di attivazione. Per saperne di più, consulta l'articolo Impostare la data di attivazione del piano tariffario.
    • Salva per salvare una bozza del piano tariffario.
    • Annulla per annullare.

API Apigee

Per creare un piano tariffario, invia una richiesta POST alla seguente API: https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans

Per configurare il piano tariffario, inserisci i campi obbligatori nel corpo della richiesta, come descritto in Risorsa: RatePlans.

La seguente tabella riassume i campi obbligatori da utilizzare durante la creazione di un piano tariffario in versione bozza e pubblicato.

Campi obbligatori per la bozza del piano tariffario	Campi obbligatori per il piano tariffario pubblicato
apiproduct displayName state	apiproduct billingPeriod currencyCode displayName paymentFundingModel (richiesto solo per Apigee Hybrid 1.5) startTime state

Nota: per pubblicare un piano tariffario, consulta Pubblicare un piano tariffario

.

Ad esempio, la seguente chiamata API crea una bozza di piano tariffario denominato myrateplan5 associato al prodotto API HelloworldProduct:

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/HelloworldProduct/rateplans" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "apiproduct":"HelloworldProduct",
    "billingPeriod":"MONTHLY",
    "consumptionPricingType":"FIXED_PER_UNIT",
    "consumptionPricingRates":[{
       "fee":{
          "units":"3",
          "nanos":0
        }
    }],
    "currencyCode":"USD",
    "displayName":"myrateplan5",
    "revenueShareType":"FIXED",
    "revenueShareRates":[{
       "sharePercentage":"1"
    }],
    "setupFee":{
       "units":"10",
       "nanos":0
     },
	 "state":"DRAFT"
    }'

Dove $TOKEN è impostato sul token di accesso OAuth 2.0, come descritto in Ottenere un token di accesso OAuth 2.0. Per informazioni sulle opzioni curl utilizzate in questo esempio, consulta Utilizzo di curl. Per una descrizione delle variabili di ambiente utilizzate, consulta Impostare le variabili di ambiente per le richieste API Apigee.

Di seguito viene fornito un esempio dell'output della risposta:

{
    "name": "4403a3a5-b366-44f0-aa4d-bd54dcfd3239",
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan5",
    "billingPeriod": "MONTHLY",
    "currencyCode": "USD",
    "setupFee": {
        "currencyCode": "USD",
        "units": "10"
    },
    "consumptionPricingType": "FIXED_PER_UNIT",
    "consumptionPricingRates": [
        {
            "fee": {
                "currencyCode": "USD",
                "units": "3"
            }
        }
    ],
    "revenueShareType": "FIXED",
    "revenueShareRates": [
        {
            "sharePercentage": 1
        }
    ],
    "state": "DRAFT"
}

Per ulteriori informazioni, consulta la sezione sull'API Creare un piano tariffario.

Visualizzare l'anteprima del piano tariffario nell'interfaccia utente

In base alla configurazione dei pricing e della quota di condivisione delle entrate, puoi visualizzare l'anteprima degli addebiti dettagliati e dei totali fatturati nella sezione Anteprima del piano tariffario della pagina Piano tariffario, come mostrato nella figura seguente.

Aggiorna il campo Consumo di unità API nella sezione Dati consumer di esempio per modificare le stime nell'anteprima. Gli addebiti e i totali dettagliati vengono aggiornati in base a quanto inserito.

Aggiorna i seguenti campi nella sezione Esempi di dati dei consumatori:

• Consumo di unità API
  Se in Prezzi è selezionata l'opzione Tariffa basata sul consumo di addebito.
• Entrate
  Se l'opzione Attiva la condivisione delle entrate è selezionata in Condivisione delle entrate.

Impostare i tempi di attivazione e scadenza per i piani tariffari

Imposta i tempi di attivazione e scadenza per un piano tariffario per indicare quando un piano tariffario pubblicato è attivo e che il prodotto API associato è disponibile per l'uso da parte degli sviluppatori nelle loro app.

Tieni presente quanto segue quando imposti i tempi di attivazione e scadenza:

• Può essere attivo un solo piano tariffario alla volta per un prodotto API.
• Puoi pubblicare più piani tariffari per lo stesso prodotto API con tempi di attivazione e scadenza non sovrapposti.
• Devi impostare il tempo di attivazione di un piano tariffario prima che possa essere pubblicato.
  Quando pubblichi un piano tariffario utilizzando l'UI, ti verrà chiesto di impostare l'ora di attivazione, se non è impostata.
• La durata dell'attivazione deve essere precedente alla scadenza (se impostata), mentre la scadenza deve essere successiva all'ora di attivazione.
• La data e l'ora di scadenza non sono obbligatorie. Se non specificata, la scadenza è impostata per impostazione predefinita su Never (il piano tariffario non ha scadenza).
• Quando imposti i tempi di attivazione e scadenza tramite l'interfaccia utente, puoi specificare solo la data e non l'ora del giorno (hh:mm:ss:mmm). L'ora del giorno per i valori di attivazione e scadenza è impostata rispettivamente su 12:00:00:000 AM e 11:59:59:999 PM.

Imposta i tempi di attivazione e scadenza per i piani tariffari come descritto nelle sezioni seguenti.

Interfaccia utente di Apigee

Per impostare l'ora di attivazione di un piano tariffario utilizzando l'interfaccia utente:

1. Accedi alla pagina Piani tariffari.
2. Fai clic su > Imposta attivazione per il piano tariffario per il quale vuoi impostare l'ora di attivazione.
3. Seleziona una delle seguenti opzioni:
   • Indeterminato per annullare l'impostazione della data di attivazione del piano tariffario (disponibile solo per le bozze dei piani tariffari).
   • Immediatamente per impostare il piano tariffario come attivo immediatamente.
   • In una data futura per selezionare quella in cui sarà attivo il piano tariffario.
4. Fai clic su Imposta attivazione.
5. Pubblica il piano tariffario se non è ancora stato pubblicato per consentire agli sviluppatori di utilizzarlo nelle loro app.

Per impostare la data di scadenza di un piano tariffario utilizzando l'interfaccia utente:

1. Accedi alla pagina Piani tariffari.
2. Fai clic su > Imposta scadenza per il piano tariffario per il quale vuoi impostare la scadenza.
3. Seleziona una delle seguenti opzioni:
   • Mai per non far scadere mai il piano tariffario.
   • Immediatamente per impostare il piano tariffario come attivo immediatamente.
   • In una data futura per selezionare quella in cui sarà attivo il piano tariffario.
4. Fai clic su Imposta scadenza.

API Apigee

Per impostare i tempi di attivazione o scadenza di un piano tariffario utilizzando l'API:

1. Visualizza i dettagli del piano tariffario che vuoi aggiornare.
2. Utilizza la risposta per creare il corpo della richiesta e aggiornare i seguenti campi:
   • startTime per impostare il tempo di attivazione
   • endTime per impostare la scadenza
   Nota: quando aggiorni un piano tariffario utilizzando l'API, le impostazioni di configurazione specificate nella richiesta sostituiscono tutte le impostazioni esistenti. Assicurati di specificare i valori per tutte le impostazioni che desideri mantenere, anche se non vengono modificate. In caso contrario, le impostazioni verranno rimosse.

3. Per aggiornare il piano tariffario con la nuova configurazione, invia una richiesta PUT alla seguente API, trasmettendo il corpo della richiesta modificata nella richiesta: https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME

Ad esempio, di seguito puoi impostare la durata di attivazione sul 1° aprile 2021 (ora dell'epoca: 1617302588000):

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME" \
  -X PUT \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan3",
    "currencyCode":"USD",
    "billingPeriod":"MONTHLY",
    "consumptionPricingType":"FIXED_PER_UNIT",
    "consumptionPricingRates":[{
       "fee":{
          "units":"3",
          "nanos":0
        }
    }],
    "revenueShareType":"FIXED",
    "revenueShareRates":[{
       "sharePercentage":"5"
    }],
    "state":"DRAFT",
    "startTime": 1617302588000
    }'

Dove $TOKEN è impostato sul token di accesso OAuth 2.0, come descritto in Ottenere un token di accesso OAuth 2.0. Per informazioni sulle opzioni curl utilizzate in questo esempio, consulta Utilizzo di curl. Per una descrizione delle variabili di ambiente utilizzate, consulta Impostare le variabili di ambiente per le richieste API Apigee.

Per ulteriori informazioni sui campi che puoi specificare nel corpo della richiesta, consulta Resource: RatePlans.

Di seguito viene fornito un esempio dell'output della risposta:

{
    "name": "cb9f420e-313d-4900-aa4f-e07b2b76918d",
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan3",
    "billingPeriod": "MONTHLY",
    "currencyCode": "USD",
    "consumptionPricingType": "FIXED_PER_UNIT",
    "consumptionPricingRates": [
        {
            "fee": {
                "currencyCode": "USD",
                "units": "3"
            }
        }
    ],
    "revenueShareType": "FIXED",
    "revenueShareRates": [
        {
            "sharePercentage": 5
        }
    ],
    "state": "DRAFT",
    "startTime": "1617302588000"
}

Per ulteriori informazioni, consulta la sezione sull'API Update rate plan.

Pubblicazione dei piani tariffari in corso

Pubblica i piani tariffari come descritto nelle sezioni seguenti.

Nota: per un prodotto API può essere attivo un solo piano tariffario alla volta. Puoi pubblicare piani tariffari per lo stesso prodotto API con tempi di attivazione e scadenza non sovrapposti.

Interfaccia utente di Apigee

Per pubblicare un piano tariffario utilizzando l'interfaccia utente, utilizza uno dei seguenti metodi:

• Durante la creazione o l'aggiornamento di un piano tariffario, puoi fare clic su Salva e pubblica per salvarlo e pubblicarlo. Ti verrà chiesto di impostare la data di attivazione.
• Accedi alla pagina Piani tariffari e fai clic su > Pubblica per la bozza del piano tariffario che vuoi pubblicare.

  Questa opzione viene visualizzata solo se hai impostato una data di attivazione per la bozza del piano tariffario.

API Apigee

Per pubblicare un piano tariffario utilizzando l'API:

1. Visualizza i dettagli del piano tariffario che vuoi pubblicare.
2. Utilizza la risposta per creare il corpo della richiesta e aggiornare i seguenti campi:
   • Imposta lo state su state.
   • Imposta startTime sul tempo di attivazione in millisecondi dall'epoca.
   • Facoltativamente, imposta endTime sulla scadenza in millisecondi dall'epoca o su Mai. Se omesso, la scadenza predefinita è Never.
   • Imposta eventuali altri campi che vuoi mantenere.
     Nota: quando aggiorni un piano tariffario utilizzando l'API, le impostazioni di configurazione specificate nella richiesta sostituiscono tutte le impostazioni esistenti. Assicurati di specificare i valori per tutte le impostazioni che desideri mantenere, anche se non vengono modificate. In caso contrario, le impostazioni verranno rimosse.

3. Per pubblicare il piano tariffario, invia una richiesta PUT all'API seguente, trasmettendo il corpo della richiesta modificata nella richiesta: https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME

Ad esempio, quanto segue modifica lo stato del piano tariffario rateplan1 in PUBLISHED e imposta il tempo di attivazione sul 1° aprile 2021, specificato in millisecondi dall'epoca:

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME" \
  -X PUT \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan3",
    "currencyCode":"USD",
    "billingPeriod":"MONTHLY",
    "consumptionPricingType":"FIXED_PER_UNIT",
    "consumptionPricingRates":[{
       "fee":{
          "units":"3",
          "nanos":0
        }
    }],
    "revenueShareType":"FIXED",
    "revenueShareRates":[{
       "sharePercentage":"5"
    }],
    "state":"PUBLISHED",
    "startTime": 1617302588000
    }'

Per ulteriori informazioni sui campi che puoi specificare nel corpo della richiesta, consulta Risorsa: RatePlans.

Dove $TOKEN è impostato sul token di accesso OAuth 2.0, come descritto in Ottenere un token di accesso OAuth 2.0. Per informazioni sulle opzioni curl utilizzate in questo esempio, consulta Utilizzo di curl. Per una descrizione delle variabili di ambiente utilizzate, consulta Impostare le variabili di ambiente per le richieste API Apigee.

Di seguito viene fornito un esempio dell'output della risposta:

{
    "name": "cb9f420e-313d-4900-aa4f-e07b2b76918d",
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan3",
    "billingPeriod": "MONTHLY",
    "currencyCode": "USD",
    "consumptionPricingType": "FIXED_PER_UNIT",
    "consumptionPricingRates": [
        {
            "fee": {
                "currencyCode": "USD",
                "units": "3"
            }
        }
    ],
    "revenueShareType": "FIXED",
    "revenueShareRates": [
        {
            "sharePercentage": 5
        }
    ],
    "state": "PUBLISHED",
    "startTime": "1617302588000"
}

Per ulteriori informazioni, consulta la sezione sull'API Update rate plan.

Spostamento dei piani tariffari pubblicati allo stato di bozza

Sposta i piani tariffari pubblicati in stato di bozza, come descritto nelle sezioni seguenti.

Interfaccia utente di Apigee

Per passare allo stato di bozza di un piano tariffario pubblicato utilizzando l'interfaccia utente:

1. Accedi alla pagina Piani tariffari.
2. Seleziona > Sposta alla bozza.

Il piano tariffario viene aggiornato e il campo Status viene modificato in Bozza.

API Apigee

Per passare allo stato di bozza di un piano tariffario pubblicato utilizzando l'API:

1. Esamina i dettagli del piano tariffario pubblicato che vuoi passare allo stato di bozza.
2. Utilizza la risposta per creare il corpo della richiesta e aggiornare i seguenti campi:
   • Imposta state su BOZZA.
   • Imposta eventuali altri campi che vuoi mantenere.
     Nota: quando aggiorni un piano tariffario utilizzando l'API, le impostazioni di configurazione specificate nella richiesta sostituiscono tutte le impostazioni esistenti. Assicurati di specificare i valori per tutte le impostazioni che desideri mantenere, anche se non vengono modificate. In caso contrario, le impostazioni verranno rimosse.

3. Per passare allo stato di bozza del piano tariffario pubblicato, invia una richiesta PUT alla seguente API, trasmettendo il corpo della richiesta modificata nella richiesta: https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME

Ad esempio, di seguito modifica lo stato del piano tariffario rateplan1 in DRAFT:

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME" \
  -X PUT \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan3",
    "currencyCode":"USD",
    "billingPeriod":"MONTHLY",
    "consumptionPricingType":"FIXED_PER_UNIT",
    "consumptionPricingRates":[{
       "fee":{
          "units":"3",
          "nanos":0
        }
    }],
    "revenueShareType":"FIXED",
    "revenueShareRates":[{
       "sharePercentage":"5"
    }],
    "state":"DRAFT",
    "startTime": 1617302588000
    }'

Per ulteriori informazioni sui campi che puoi specificare nel corpo della richiesta, consulta Risorsa: RatePlans.

Dove $TOKEN è impostato sul token di accesso OAuth 2.0, come descritto in Ottenere un token di accesso OAuth 2.0. Per informazioni sulle opzioni curl utilizzate in questo esempio, consulta Utilizzo di curl. Per una descrizione delle variabili di ambiente utilizzate, consulta Impostare le variabili di ambiente per le richieste API Apigee.

Di seguito viene fornito un esempio dell'output della risposta:

{
    "name": "cb9f420e-313d-4900-aa4f-e07b2b76918d",
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan3",
    "billingPeriod": "MONTHLY",
    "currencyCode": "USD",
    "consumptionPricingType": "FIXED_PER_UNIT",
    "consumptionPricingRates": [
        {
            "fee": {
                "currencyCode": "USD",
                "units": "3"
            }
        }
    ],
    "revenueShareType": "FIXED",
    "revenueShareRates": [
        {
            "sharePercentage": 5
        }
    ],
    "state": "DRAFT",
    "startTime": "1617302588000"
}

Per ulteriori informazioni, consulta la sezione sull'API Update rate plan.

Aggiornamento dei piani tariffari

Aggiorna i piani tariffari come descritto nelle sezioni seguenti. Vedi anche:

• Pubblicazione di piani tariffari
• Impostare i tempi di attivazione e scadenza di un piano tariffario

Nota: quando aggiorni il piano tariffario attivo pubblicato, scegli uno dei seguenti metodi:

Metodo	Considerazioni
Aggiorna il piano tariffario (come descritto di seguito)	Le modifiche hanno effetto immediato per il piano tariffario pubblicato attivo. In questo caso, potrebbe non essere immediatamente evidente il motivo per cui le modifiche al piano tariffario sono state applicate.
Pubblica una nuova versione del piano tariffario	Gli addebiti vengono monitorati in base al nuovo piano tariffario pubblicato attivo, il che può facilitare il monitoraggio. Per pubblicare una nuova versione del piano tariffario: Clona il piano tariffario esistente. Modifica la versione clonata del piano tariffario, come richiesto. Scade immediatamente o passa alla bozza del piano tariffario esistente. Pubblica immediatamente la nuova versione del piano tariffario.

Aggiorna un piano tariffario come descritto nelle sezioni seguenti.

Interfaccia utente di Apigee

Per aggiornare un piano tariffario utilizzando l'interfaccia utente:

1. Accedi alla pagina Piani tariffari.
2. Nell'elenco, fai clic sul nome del piano tariffario da aggiornare.
3. Aggiorna il piano tariffario, come richiesto.
4. Fai clic su una delle seguenti opzioni:
   • Salva e pubblica per salvare e pubblicare il piano tariffario. Ti verrà chiesta una data di attivazione. Per saperne di più, consulta l'articolo Impostare la data di attivazione di un piano tariffario.
   • Salva per salvare una bozza del piano tariffario.
   • Annulla per annullare gli aggiornamenti.

API Apigee

Per aggiornare un piano tariffario utilizzando l'API:

1. Visualizza i dettagli del piano tariffario che vuoi aggiornare.
2. Utilizza la risposta per creare il corpo della richiesta e aggiornare eventuali altre impostazioni di configurazione, come necessario.
   Nota: quando aggiorni un piano tariffario utilizzando l'API, le impostazioni di configurazione specificate nella richiesta sostituiscono tutte le impostazioni esistenti. Assicurati di specificare i valori per tutte le impostazioni che desideri mantenere, anche se non vengono modificate. In caso contrario, le impostazioni verranno rimosse.

3. Per aggiornare un piano tariffario, invia una richiesta PUT all'API seguente, trasmettendo il corpo della richiesta modificata nella richiesta: https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME

Ad esempio, quanto segue modifica la tariffa basata sul consumo in 5 e la percentuale della quota di condivisione delle entrate al 6,5%.Tutte le altre impostazioni di configurazione sono incluse per garantire che vengano mantenute:

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME" \
  -X PUT \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan3",
    "currencyCode":"USD",
    "billingPeriod":"MONTHLY",
    "consumptionPricingType":"FIXED_PER_UNIT",
    "consumptionPricingRates":[{
       "fee":{
          "units":"5",
          "nanos":0
        }
    }],
    "revenueShareType":"FIXED",
    "revenueShareRates":[{
       "sharePercentage":"6.5"
    }],
    "state":"DRAFT",
    "startTime": 1617302588000
    }'

Per ulteriori informazioni sui campi che puoi specificare nel corpo della richiesta, consulta Risorsa: RatePlans.

Dove $TOKEN è impostato sul token di accesso OAuth 2.0, come descritto in Ottenere un token di accesso OAuth 2.0. Per informazioni sulle opzioni curl utilizzate in questo esempio, consulta Utilizzo di curl. Per una descrizione delle variabili di ambiente utilizzate, consulta Impostare le variabili di ambiente per le richieste API Apigee.

Di seguito viene fornito un esempio dell'output della risposta:

{
    "name": "cb9f420e-313d-4900-aa4f-e07b2b76918d",
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan3",
    "billingPeriod": "MONTHLY",
    "currencyCode": "USD",
    "consumptionPricingType": "FIXED_PER_UNIT",
    "consumptionPricingRates": [
        {
            "fee": {
                "currencyCode": "USD",
                "units": "5"
            }
        }
    ],
    "revenueShareType": "FIXED",
    "revenueShareRates": [
        {
            "sharePercentage": 6.5
        }
    ],
    "state": "DRAFT",
    "startTime": "1617302588000"
}

Per ulteriori informazioni, consulta la sezione sull'API Update rate plan.

Piani di clonazione

Clona i piani tariffari come descritto nelle sezioni seguenti.

Interfaccia utente di Apigee

Per clonare un piano tariffario utilizzando l'interfaccia utente:

1. Accedi alla pagina Piani tariffari.
2. Seleziona > Clona.
3. Aggiorna i campi Nome piano tariffario e Prodotto API, come richiesto.
4. Fai clic su Clona.

Il piano tariffario viene aggiunto all'elenco dei piani tariffari.

API Apigee

Per clonare un piano tariffario utilizzando l'API:

1. Visualizza i dettagli del piano tariffario da clonare.
2. Utilizza la risposta per creare il corpo della richiesta e aggiornare i seguenti campi:
   • Rimuovi il campo name.
   • Aggiorna eventuali altre impostazioni di configurazione, se necessario.
     Nota: quando aggiorni un piano tariffario utilizzando l'API, le impostazioni di configurazione specificate nella richiesta sostituiscono tutte le impostazioni esistenti. Assicurati di specificare i valori per tutte le impostazioni che desideri mantenere, anche se non vengono modificate. In caso contrario, le impostazioni verranno rimosse.
3. Crea un piano tariffario inserendo il corpo della richiesta modificata nella richiesta.

Eliminazione dei piani tariffari in corso...

L'eliminazione di un piano tariffario è definitiva. Il piano tariffario verrà eliminato immediatamente e non potrà essere ripristinato.

Attenzione:prima di eliminare un piano tariffario, assicurati che non siano in corso transazioni attive.

Elimina i piani tariffari come descritto nelle sezioni seguenti.

Interfaccia utente di Apigee

Per eliminare un piano tariffario utilizzando l'interfaccia utente:

1. Accedi alla pagina Piani tariffari.
2. Seleziona > Elimina per il piano tariffario da eliminare.
3. Fai clic su Elimina quando ti viene chiesto di confermare l'eliminazione.

Il piano tariffario viene eliminato e rimosso dall'elenco.

API Apigee

Per eliminare un piano tariffario, invia una richiesta DELETE alla seguente API: https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME.

Per determinare il nome del piano tariffario da passare nel percorso della risorsa, consulta la sezione Elenco dei piani tariffari in un'organizzazione.

Ad esempio, la seguente procedura elimina il piano tariffario con nome cc6252c0-c5d0-4aaf-85f2-203ec8fa5707 e nome visualizzato myrateplan3:

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME" \
  -X DELETE \
  -H "Authorization: Bearer $TOKEN

Dove $TOKEN è impostato sul token di accesso OAuth 2.0, come descritto in Ottenere un token di accesso OAuth 2.0. Per informazioni sulle opzioni curl utilizzate in questo esempio, consulta Utilizzo di curl. Per una descrizione delle variabili di ambiente utilizzate, consulta Impostare le variabili di ambiente per le richieste API Apigee.

Di seguito viene fornito un esempio dell'output della risposta:

{
    "name": "93ca14aa-7a48-4384-ae09-c85a0e8a8df8",
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan3",
    "billingPeriod": "MONTHLY",
    "currencyCode": "USD",
    "consumptionPricingType": "FIXED_PER_UNIT",
    "consumptionPricingRates": [
        {
            "fee": {
                "currencyCode": "USD",
                "units": "5"
            }
        }
    ],
    "revenueShareType": "FIXED",
    "revenueShareRates": [
        {
            "sharePercentage": 6.5
        }
    ],
    "state": "DRAFT",
    "startTime": "1617302588000"
}

Per ulteriori informazioni, consulta l'articolo sull'eliminazione dei piani tariffari.