Gestione dei piani tariffari per i prodotti API

Questa pagina si applica a Apigee e Apigee ibridi.

Visualizza la documentazione di Apigee Edge.

Utilizzando i piani tariffari, i proprietari di 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
  • Addebiti 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 è applicato per un prodotto API (attivazione e scadenza del piano tariffario)
  • Condivisione delle entrate con i partner sviluppatori

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.

Apigee nella console Cloud

Visualizza i piani tariffari utilizzando l'interfaccia utente di Apigee in Cloud Console come descritto nelle sezioni seguenti:

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'interfaccia utente di Apigee nella console Cloud.
  2. Seleziona Distribuzione > Monetizzazione nella barra di navigazione laterale.

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

Elenco dei piani tariffari che mostra il nome, il prodotto API e i tempi di attivazione e scadenza di ciascuno, oltre al menu che può essere utilizzato per gestire il piano tariffario

La pagina Piani tariffari ti consente di:

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. Scorri verso il basso fino alla sezione Piano tariffario per visualizzare i piani tariffari.

Interfaccia utente Apigee classica

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

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 alla UI classica di Apigee.
  2. Seleziona Pubblica > Monetizzazione > Piani tariffari nella barra di navigazione laterale.

La pagina Piani tariffari elenca i piani tariffari correnti.

Elenco dei piani tariffari che mostra il nome, il prodotto API e i tempi di attivazione e scadenza di ciascuno, oltre al menu a discesa che può essere utilizzato per gestire il piano tariffario

Nella pagina Piani tariffari puoi:

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. Modifica il prodotto API e scorri verso il basso fino alla sezione Piani tariffari.

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 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 tuo 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 Utilizzare 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 di risposta, che include i due piani tariffari, myrateplan1 e myrateplan2 associati a 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 relativo payload di risposta, consulta l'API List rate plans

Visualizzare i dettagli di un piano tariffario utilizzando l'API

Per visualizzare i dettagli di un piano tariffario, invia una richiesta GET all'API seguente: 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 tuo 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 Utilizzare 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 per il piano tariffario con il nome 6b51b501-ac15-41b7-bb3e-621edb849e13 e il 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 ulteriori informazioni sull'API e sul suo payload di risposta, vedi Ottieni l'API del piano tariffario.

Creazione di piani tariffari

Crea piani tariffari come descritto nelle sezioni seguenti.

Apigee nella console Cloud

Per creare un piano tariffario utilizzando l'UI di Apigee nella console Cloud:

  1. Esegui una delle seguenti operazioni:
    • Seleziona Distribuzione > Monetizzazione nella barra di navigazione laterale e fai clic su Crea nell'elenco dei piani tariffari.
    • Modifica un prodotto API e fai clic su Aggiungi piano tariffario nella sezione Piani tariffari.
  2. Inserisci Dettagli piano tariffario, come segue:
    Campo Descrizione
    Nome piano tariffario Inserisci il nome del piano tariffario.
    Prodotto API Seleziona un prodotto API a cui vuoi associare il piano tariffario dal menu a discesa.
  3. Fai clic su Avanti.
  4. Inserisci i dettagli di fatturazione, come segue:
    Campo Descrizione Predefinito
    Valuta di fatturazione Seleziona la valuta da utilizzare per la fatturazione dal menu a discesa. $
    Periodo di fatturazione Seleziona la frequenza con cui verrà addebitato il costo al cliente dal menu a discesa. Mensile
    Tariffa di inizializzazione

    Una tariffa una tantum addebitata a ogni sviluppatore alla data di inizio del piano tariffario (ovvero la data in cui lo sviluppatore acquista il prodotto API).

    Se vuoi addebitare la tariffa di configurazione, seleziona Addebitare la tariffa di inizializzazione e inserisci l'importo da addebitare nel campo Tariffa di inizializzazione.

    		Disabilitato
  5. Fai clic su Avanti.
  6. Inserisci i dettagli dei prezzi come segue.
    Campo Descrizione Predefinito
    Tariffa ricorrente fissa Abilita una tariffa ricorrente fissa per unità:
    1. Seleziona Addebita una tariffa ricorrente fissa.
    2. Configura la frequenza della tariffa fissa e l'importo della tariffa ricorrente fissa.

    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 una tariffa ricorrente fissa.

    		Disabilitato
    Tariffe basate sul consumo Attiva i prezzi basati sul consumo:
    1. Seleziona Addebita una tariffa basata sul consumo.
    2. 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 di transazione e consumo determinano le commissioni di una transazione. Una fascia si riferisce a un intervallo di consumo dell'API e ogni fascia ha una tariffa diversa. Nella sezione Ranges of unit consumption, puoi specificare gli intervalli di fascia e le commissioni corrispondenti per la fascia. Puoi specificare quante bande che vuoi facendo clic su + CINTURINO.

      Esempio: supponiamo che tu voglia addebitare le prime 1000 chiamate API a 2 $ per chiamata e tutte le chiamate API successive a 1 $ per chiamata. Per configurare questa opzione, specifica le seguenti due bande 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 commissioni totali saranno di 2500 $ ((1000 * 2) + (500 * 1)).

    Se attivi le tariffe basate sul consumo, puoi visualizzare in anteprima gli effetti del tipo di tariffa selezionato sulle entrate complessive, come descritto in Visualizzare in anteprima il piano tariffario.

    Per disattivare la tariffa, deseleziona Modello di prezzi basato sul consumo di addebito.

    Se hai configurato perUnitPriceMultiplier variabile di monetizzazione nella norma Data Capture, il costo per transazione specificato in qualsiasi tipo (Tariffa fissa per unità o fascia) delle tariffe basate sul consumo viene moltiplicata per il valore di perUnitPriceMultiplier.

    		Disabilitato
  7. Fai clic su Avanti.
  8. Inserisci i dettagli della condivisione delle entrate come segue:
    Campo Descrizione Predefinito
    Quota di condivisione delle entrate Attiva la condivisione delle entrate per condividere una percentuale delle entrate con gli sviluppatori partner.
    1. Seleziona Attiva la condivisione delle entrate.
    2. Inserisci una percentuale delle entrate da condividere nel campo Percentuale (%) di entrate da condividere con lo sviluppatore.

    Puoi ottenere le entrate condivise per ogni transazione monetizzata configurando la revShareGrossPrice variabile di monetizzazione nel criterio DataCapture. Per ulteriori informazioni, vedi Variabili di monetizzazione.

    Se attivi la condivisione delle entrate, puoi visualizzare in anteprima gli effetti del valore Percentuale (%) inserito sugli addebiti dettagliati e totali, come descritto in Visualizzare l'anteprima del piano tariffario.

    Per disattivare la commissione, deseleziona Attiva la compartecipazione alle entrate.

    		Disabilitato
  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.

Interfaccia utente Apigee classica

Per creare un piano tariffario utilizzando l'interfaccia utente:

  1. Esegui una delle seguenti operazioni:
    • 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 Aggiungi pulsante 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 Seleziona un prodotto API a cui vuoi associare il piano tariffario dal menu a discesa.
  3. Fai clic su Avanti.
  4. Inserisci i dettagli di fatturazione come segue:
    Campo Descrizione Predefinito
    Valuta di fatturazione Seleziona la valuta da utilizzare per la fatturazione dal menu a discesa. $
    Periodo di fatturazione Seleziona la frequenza con cui verrà addebitato il costo al cliente dal menu a discesa. Mensile
    Tariffa di inizializzazione

    Una commissione una tantum addebitata a ogni sviluppatore nella data di inizio del piano tariffario (ovvero la data in cui lo sviluppatore acquista il prodotto API).

    Se vuoi addebitare la tariffa di configurazione, seleziona Addebitare la tariffa di configurazione e inserisci l'importo da addebitare nel campo Tariffa di inizializzazione.

    		Disabilitato
  5. Fai clic su Avanti.
  6. Inserisci i dettagli dei prezzi come segue.
    Campo Descrizione Predefinito
    Tariffa ricorrente fissa Attiva una tariffa ricorrente fissa per unità:
    1. Seleziona Addebita tariffa ricorrente fissa.
    2. 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.

    		Disabilitato
    Commissioni basate sul consumo Attiva i prezzi basati sul consumo:
    1. Seleziona Charge Charge-based Fee (Tariffa basata sul consumo).
    2. 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.

    • A fasce: viene addebitata una commissione variabile per ogni transazione monetizzata. La banda di transazione e consumo determinano le commissioni di una transazione. Una fascia si riferisce a un intervallo di consumo dell'API e ogni fascia ha una tariffa diversa. Nella sezione Ranges of unit consumption, puoi specificare il cinturino e le tariffe corrispondenti per la banda. Puoi specificare tutte le bande che preferisci facendo clic su + BANDA.

      Esempio: supponiamo che tu voglia addebitare 2 $ a chiamata per le prime 1000 chiamate API e tutte le chiamate API successive a 1 $ per chiamata. Per configurare questa funzionalità, specifica quanto segue due cinturini 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 commissioni totali saranno di 2500 $ ((1000 * 2) + (500 * 1)).

    Se abiliti le tariffe basate sul consumo, puoi visualizzare l'anteprima degli effetti della tariffa selezionata digita le entrate complessive, come descritto in Visualizzare l'anteprima del piano tariffario.

    Per disattivare la tariffa, deseleziona Modello di prezzi basato sul consumo.

    Se hai configurato perUnitPriceMultiplier variabile di monetizzazione nella norma Data Capture, il costo per transazione specificato in qualsiasi tipo (Tariffa fissa per unità o fascia) delle tariffe basate sul consumo viene moltiplicata per il valore di perUnitPriceMultiplier.

    		Disabilitato
  7. Fai clic su Avanti.
  8. Inserisci i dettagli della condivisione delle entrate come segue:
    Campo Descrizione Predefinito
    Quota di condivisione delle entrate Attiva la condivisione delle entrate per condividere una percentuale delle entrate con i partner sviluppatori.
    1. Seleziona Attiva la condivisione delle entrate.
    2. Inserisci una percentuale delle entrate da condividere nel campo Percentuale (%) di entrate da condividere con lo sviluppatore.

    Puoi ottenere le entrate condivise per ogni transazione monetizzata configurando il revShareGrossPrice variabile di monetizzazione nel criterio Data Capture. Per ulteriori informazioni, vedi Variabili di monetizzazione.

    Se attivi la condivisione delle entrate, puoi visualizzare in anteprima gli effetti del valore Percentuale (%) inserito sugli addebiti dettagliati e totali, come descritto in Visualizzare l'anteprima del piano tariffario.

    Per disattivare la commissione, deseleziona Attiva la compartecipazione alle entrate.

    		Disabilitato
  9. Fai clic su Avanti.
  10. Fai clic su una delle seguenti opzioni:

API Apigee

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

Configura il piano tariffario passando i campi obbligatori nel corpo della richiesta, come descritto in Risorsa: RatePlans.

La seguente tabella riassume i campi obbligatori per la creazione di un piano tariffario in 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
  • startTime
  • state

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 tuo 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 Utilizzare 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 di 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 saperne di più, consulta l'API Create rate plan

Visualizzare l'anteprima del piano tariffario nell'interfaccia utente

In base alla configurazione dei prezzi 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 del piano tariffario, come mostrato nella figura seguente.

Inserisci valori di esempio, visualizza i risultati nell'anteprima del piano tariffario

Aggiorna il campo Consumo di unità API nella sezione Dati consumatore 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 Dati di esempio dei consumatori:

  • Consumo di unità API
    Se in Prezzi è selezionata l'opzione Addebitare una tariffa basata sul consumo.
  • Entrate
    Se in Condivisione delle entrate è selezionata l'opzione Attiva la 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 possa essere utilizzato dagli sviluppatori nelle loro app.

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

  • Per un prodotto API può essere attivo un solo piano tariffario alla volta.
  • Puoi pubblicare più piani tariffari per lo stesso prodotto API con data di attivazione e di scadenza non sovrapposte.
  • Devi impostare il tempo di attivazione di un piano tariffario prima che possa essere pubblicato.
    Quando pubblichi un piano tariffario utilizzando l'interfaccia utente, ti verrà chiesto di impostare l'ora di attivazione, se non è impostata.
  • L'ora di attivazione deve essere precedente all'ora di scadenza (se impostata) e quest'ultima 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 di scadenza utilizzando l'interfaccia utente, puoi specificare solo la data e non l'ora del giorno (hh:mm:ss:mmm). Per impostazione predefinita, l'ora del giorno per i valori di attivazione e scadenza è 12:00:00:000 AM e rispettivamente 11:59:59:999 PM.

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

Apigee nella console Cloud

Per impostare il tempo di attivazione per un piano tariffario utilizzando l'UI di Apigee nella console Cloud:

  1. Accedi alla pagina Piani tariffari.
  2. Fai clic su e poi su Imposta attivazione per il piano tariffario per il quale vuoi impostare l'ora di attivazione.
  3. Seleziona una delle seguenti opzioni:
    • Senza data per annullare l'impostazione del momento di attivazione del piano tariffario (disponibile solo per i piani tariffari in bozza).
    • 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 il tempo di scadenza per un piano tariffario utilizzando l'UI di Apigee nella console Cloud:

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

Interfaccia utente Apigee classica

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

  1. Accedi alla pagina Tariffe.
  2. Fai clic su > Imposta l'attivazione per il piano tariffario per il quale vuoi impostare l'ora di attivazione.
  3. Seleziona una delle seguenti opzioni:
    • Senza data per annullare l'impostazione del momento di attivazione del piano tariffario (disponibile solo per i piani tariffari in bozza).
    • 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 cui vuoi impostare la data e l'ora di scadenza.
  3. Seleziona una delle seguenti opzioni:
    • Mai per non far scadere mai il piano tariffario.
    • Immediatamente per impostare immediatamente il piano tariffario come attivo.
    • In una data futura per selezionare la data in cui il piano tariffario sarà attivo.
  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 l'ora di attivazione
    • endTime per impostare la scadenza

  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, il seguente codice imposta l'ora di attivazione su 1° aprile 2021 (ora di epoch 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 tuo 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, vedi Con curl. Per una descrizione delle variabili di ambiente utilizzate, consulta Impostazione delle variabili di ambiente per le richieste dell'API Apigee.

Per ulteriori informazioni sui campi che puoi specificare nel corpo della richiesta, consulta la risorsa: 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.

Piani tariffari per la pubblicazione

Pubblica i piani tariffari come descritto nelle sezioni seguenti.

Apigee nella console Cloud

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

  • Quando crei o aggiorni 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, fai clic su e seleziona Pubblica in corrispondenza della bozza del piano tariffario che vuoi pubblicare.

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

UI classica di Apigee

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

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 state su PUBLISHED.
    • Imposta startTime sul tempo di attivazione in millisecondi dall'epoca.
    • Facoltativamente, imposta endTime sulla data e sull'ora di scadenza in millisecondi dall'epoca o su Never. Se omesso, la data e l'ora di scadenza predefiniti sono Never.
    • Imposta eventuali altri campi che vuoi mantenere.

  3. Per pubblicare il piano tariffario, 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, 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 la risorsa: RatePlans.

dove $TOKEN è impostato sul tuo 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 Utilizzare 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 di 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 l'API Update rate plan

Spostamento dei piani tariffari pubblicati in stato di bozza

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

Apigee nella console Cloud

Per spostare un piano tariffario pubblicato in stato di bozza utilizzando l'interfaccia utente di Apigee nella console Cloud:

  1. Accedi alla pagina Tariffe.
  2. Seleziona , quindi Sposta in bozza.

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

Interfaccia utente Apigee classica

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

  1. Accedi alla pagina Piani tariffari.
  2. Seleziona > Sposta in 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.

  3. Per impostare lo stato di bozza del piano tariffario pubblicato, invia una richiesta PUT alla seguente API, passando il corpo della richiesta modificato: 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 tuo 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, vedi Con curl. Per una descrizione delle variabili di ambiente utilizzate, consulta Impostazione delle variabili di ambiente per le richieste dell'API Apigee.

Di seguito è riportato un esempio di 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:

Aggiorna un piano tariffario come descritto nelle sezioni seguenti.

Apigee nella console Cloud

Per aggiornare un piano tariffario utilizzando l'interfaccia utente:

  1. Accedi alla pagina Tariffe.
  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 ulteriori informazioni, consulta Impostare la data di attivazione di un piano tariffario.
    • Salva per salvare una bozza del piano tariffario.
    • Annulla per annullare gli aggiornamenti.

Interfaccia utente Apigee classica

Per aggiornare un piano tariffario utilizzando l'interfaccia utente:

  1. Accedi alla pagina Piani tariffari.
  2. Fai clic sul nome del piano tariffario da aggiornare nell'elenco.
  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 ulteriori informazioni, consulta 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.

  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, le seguenti modifiche impostano la tariffa basata sul consumo su 5 e la percentuale di condivisione delle entrate su 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 la risorsa: RatePlans.

Dove $TOKEN è impostato sul tuo 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, vedi Con curl. Per una descrizione delle variabili di ambiente utilizzate, consulta Impostazione delle variabili di ambiente per le richieste dell'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 l'API Update rate plan

Piani di clonazione

Clona i piani tariffari per creare piani tariffari duplicati in base a piani tariffari esistenti.

Apigee nella console Cloud

Per clonare un piano tariffario utilizzando l'interfaccia utente:

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

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

UI classica di Apigee

Per clonare un piano tariffario utilizzando l'interfaccia utente:

  1. Accedi alla pagina Tariffe.
  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.
  3. Crea un piano tariffario trasmettendo al suo interno il corpo della richiesta modificata.

Eliminazione dei piani tariffari in corso...

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

Elimina i piani tariffari come descritto nelle sezioni seguenti.

Apigee nella console Cloud

Per eliminare un piano tariffario utilizzando l'interfaccia utente:

  1. Accedi alla pagina Piani tariffari.
  2. Seleziona e poi Elimina per il piano tariffario da eliminare.
  3. Verifica che questo sia il piano tariffario corretto da eliminare e fai clic su Elimina.

Il piano tariffario viene eliminato e rimosso dall'elenco.

Interfaccia utente Apigee classica

Per eliminare un piano tariffario utilizzando l'interfaccia utente:

  1. Accedi alla pagina Tariffe.
  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 all'API seguente: 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 tuo 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 Utilizzare 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'API DeleteRatePlans.