Gestione dei piani tariffari

Stai visualizzando la documentazione di Apigee Edge.
Consulta la documentazione di Apigee X. info

Gestisci i piani tariffari utilizzando l'interfaccia utente e l'API, come descritto nelle sezioni seguenti.

Esplorare la pagina dei piani tariffari

Accedi alla pagina dei piani tariffari, come descritto di seguito.

Creare un piano tariffario

Per creare un piano tariffario:

1. Accedi alla pagina Piani tariffari.
2. Fai clic su + Piano tariffario.
3. Configura i seguenti campi nel riquadro superiore:
   

   Campo	Descrizione	Predefinito	Obbligatorio
   Nome piano tariffario	Il nome del piano tariffario. NOTE: il nome deve essere univoco all'interno di un 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 Tipi di piani tariffari supportati.	N/D	Sì
   Bundle di prodotti	Bundle di prodotti API. Seleziona un valore dall'elenco a discesa. Per ulteriori informazioni sui bundle di prodotti API, consulta Gestione dei bundle di prodotti API. Se selezioni un bundle di prodotti che contiene più di un prodotto API, devi scegliere se configurare piani tariffari individuali per ogni prodotto API o un piano tariffario generico che verrà applicato a tutti i prodotti API.	N/D	Sì
   Pubblico	Il 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 dell'azienda. Mentre digiti, in un menu a discesa viene visualizzato un elenco degli sviluppatori/delle società che contengono la stringa. Fai clic sul nome dello sviluppatore o dell'azienda nell'elenco a discesa. Categoria sviluppatore: categoria sviluppatore. Seleziona la categoria di sviluppatore dall'elenco a discesa. Configura le categorie di sviluppatori in base alle esigenze, come descritto in Gestire le categorie di sviluppatori.	Tutti	No
   Data di inizio	Data di entrata in vigore del piano tariffario. Inserisci una data di inizio o seleziona una data utilizzando il calendario.	Oggi	No
   Data di fine	Data di fine del piano tariffario. Per specificare una data di fine, attiva il pulsante di attivazione/disattivazione Ha data di fine e inserisci una data di fine o seleziona una data utilizzando il calendario. NOTA: il piano tariffario sarà attivo fino alla fine della giornata della data specificata. Se vuoi far scadere un piano tariffario il 1° dicembre 2018, ad esempio, devi impostare il valore di endDate su 2018-11-30. In questo caso, il piano tariffario scadrà alla fine della giornata del 30 novembre 2018 e tutte le richieste del 1° dicembre 2018 verranno bloccate.	Nessuno	No
   Visibile ai portali	Imposta se il piano tariffario è pubblico o privato. Consulta la sezione Piani tariffari pubblici e privati.	Abilitata	No

4. Configura le tariffe per il piano tariffario. Consulta Configurare le commissioni per un piano tariffario.
   NOTE: non applicabile ai piani di notifica regolabili.
5. 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 piano tariffario individuale per ogni prodotto API.	Disabilitato
   Configurare singolarmente l'offerta freemium di ogni prodotto	Flag che specifica se configurare un piano freemium per ogni prodotto API.	Disabilitato
   Seleziona un prodotto	Se attivi uno o entrambi i flag, devi selezionare ogni prodotto singolarmente dall'elenco a discesa e configurare i dettagli del piano tariffario. NOTE: assicurati di configurare tutti i prodotti nel bundle.	N/D

6. Configura i dettagli del piano tariffario in base al tipo di piano tariffario selezionato:
   
   • Freemium
   • Tariffario
   • Quota di condivisione delle entrate
   • Notifica regolabile
7. 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 in un piano tariffario bozza.
   Pubblica nuovo piano	Pubblica il piano. NOTE: dopo aver pubblicato un piano tariffario, puoi modificare la data di fine solo se non è già stata impostata. Non puoi eliminare un piano tariffario dopo la pubblicazione, ma puoi farlo scadere e sostituirlo con un piano tariffario futuro, come descritto in Far scadere un piano tariffario pubblicato.

8. Collega il criterio Controllo limiti di monetizzazione ai proxy API associati ai prodotti API inclusi nel piano tariffario. I criteri di controllo dei limiti di monetizzazione impongono limiti di monetizzazione ai proxy API e garantiscono che eventuali errori vengano acquisiti con precisione nei report di analisi e monetizzazione. Per ulteriori informazioni, vedi Applicare i limiti di monetizzazione ai proxy API.

Modificare un piano tariffario

Puoi modificare tutti i campi di un piano tariffario bozza, ad eccezione del pacchetto di prodotti, del tipo e del segmento di pubblico. Dopo aver pubblicato un piano tariffario, puoi modificare solo la data di fine e solo se non è stata specificata alcuna data di fine.

Per modificare un piano tariffario:

1. Accedi alla pagina Piani tariffari.
2. Fai clic all'interno della riga del piano tariffario che vuoi modificare.
   Viene visualizzato il riquadro del piano tariffario.
3. Modifica i campi del piano tariffario in base alle necessità.
   NOTE: dopo aver pubblicato un piano tariffario, puoi modificare solo la data di fine se non è già stata impostata.
4. Fai clic su una delle seguenti opzioni:

   Pulsante	Descrizione
   Aggiorna bozza (piani tariffari 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 in un piano tariffario bozza.
   Pubblica bozza (piani tariffari bozza)	Pubblica il piano tariffario. NOTE: dopo aver pubblicato un piano tariffario, puoi modificare la data di fine solo se non è già stata impostata. Non puoi eliminare un piano tariffario dopo la pubblicazione, ma puoi farlo scadere e sostituirlo con un piano tariffario futuro, come descritto in Far scadere un piano tariffario pubblicato.
   Data di fine aggiornata (piani tariffari pubblicati)	Imposta la data di fine per un piano pubblicato. NOTE: una volta impostata la data di fine per un piano tariffario pubblicato, non è più possibile modificarla.

Eliminazione di una bozza di piano tariffario

Elimina un piano tariffario in bozza se non è più necessario.

NOTA:non puoi eliminare un piano tariffario pubblicato.

Per eliminare una bozza di piano tariffario:

1. Accedi alla pagina Piani tariffari.
2. Posiziona il cursore sopra il piano tariffario che vuoi eliminare per visualizzare il menu delle azioni.
3. Fai clic su .
4. Fai clic su Elimina per confermare l'azione.

Gestione dei piani tariffari utilizzando l'API

Le sezioni seguenti descrivono come gestire i piani tariffari utilizzando l'API.

Creazione di piani tariffari mediante 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 bundle di prodotti API per cui crei il piano tariffario (l'ID viene restituito nella risposta quando crei il bundle 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
• Ambito del piano tariffario (se si applica a tutti gli sviluppatori o solo a uno sviluppatore, a un'azienda o a una categoria di sviluppatori specifici)
• Data di applicazione del piano tariffario
• Valuta del piano tariffario
• Se pubblicare il piano tariffario
• Se il piano tariffario è pubblico o privato

Esistono altre impostazioni che puoi specificare facoltativamente, ad esempio il periodo in cui è dovuto il pagamento (ad esempio 30 giorni). Consulta Proprietà di configurazione per i piani tariffari.

Se crei un piano tariffario (diverso da un piano solo commissioni) per un bundle di prodotti API che contiene più di un prodotto, puoi applicare il piano a un prodotto specifico del bundle. A tale scopo, devi identificare il prodotto nella richiesta. Se non identifichi un prodotto, il piano viene applicato a tutti i prodotti nel pacchetto di prodotti API.

Le sezioni seguenti descrivono come creare piani tariffari:

• Creazione di un piano tariffario standard utilizzando l'API
• Creare un piano tariffario per sviluppatori o società utilizzando l'API
• Creare un piano tariffario per categoria di sviluppatori utilizzando l'API
• Creazione di un piano tariffario specifico per un prodotto API utilizzando l'API
• Impostare il piano tariffario come pubblico o privato utilizzando l'API

Creazione di un piano tariffario standard mediante 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 sviluppatori o società mediante l'API

Per applicare il piano tariffario a uno sviluppatore o a un'azienda specifici, imposta il valore type su Developer. Devi inoltre identificare lo sviluppatore o l'azienda nella richiesta, indicando l'ID, la ragione sociale e il nome dello sviluppatore o dell'azienda.

Ad esempio, il seguente estratto crea un piano tariffario per lo sviluppatore Dev Five:

...
     "type": "DEVELOPER",
       "developer" : {
        "id" : "0mkKu1PALUGfjUph",
        "legalName" : "DEV FIVE",
        "name" : "Dev Five"
      }
...

Creazione di un piano tariffario per categoria di 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 sviluppatore 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 per un prodotto API utilizzando l'API

Quando crei un piano tariffario per i bundle di prodotti API che includono più prodotti API, puoi specificare i dettagli del piano tariffario per i singoli prodotti API.

Ad esempio, il seguente crea un piano 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 bundle di prodotti API my-package, devi aggiungere i dettagli del piano tariffario per il prodotto API nel corpo della richiesta, come descritto in Aggiungere un prodotto API a un bundle di prodotti API con piani tariffari specifici per il 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 impostato su true, il piano tariffario sarà privato. Per saperne di più, consulta Piani tariffari pubblici e privati.

Ad esempio, il seguente codice 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 mediante 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, il seguente comando crea un piano con 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 utilizzando l'API

Per salvare un piano tariffario senza pubblicarlo, imposta il valore della proprietà published su false quando crei il piano tariffario.

Ad esempio, il seguente codice crea un piano tariffario e lo salva come bozza (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": "false",
     "ratePlanDetails": [
     …
      ],
     …
     "type": "RATECARD"
     }],
     …
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

Modifica di una bozza di piano tariffario utilizzando l'API

Per aggiornare una bozza di 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 esegui 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 della tariffa del piano tariffario. 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 del piano tariffario aggiornata (viene mostrata solo una parte della risposta):

…
"ratePlanRates" : [ {
  "id" : "26b69b0b-9863-48c9-ba73-74a5b918fcec",
  "rate" : 0.15,
  "startUnit" : 0,
  "type" : "RATECARD"
} ],
…

Visualizzazione dei piani tariffari utilizzando l'API

Puoi visualizzare i piani tariffari utilizzando l'API monetization come descritto nelle sezioni seguenti.

• Visualizzare tutti i piani tariffari per un'organizzazione utilizzando l'API
• Visualizzare tutti i piani tariffari per un bundle di prodotti API utilizzando l'API
• Visualizzazione di un piano tariffario per un bundle di prodotti API utilizzando l'API
• Visualizzazione di tutti i piani tariffari attivi per uno sviluppatore che utilizza l'API
• Visualizzazione di un piano tariffario accettato per uno sviluppatore che utilizza l'API
• Visualizzazione di un piano tariffario accettato per uno sviluppatore che contiene un prodotto API utilizzando l'API
• Visualizzazione di tutti i piani tariffari accettati da uno sviluppatore tramite l'API

Visualizzazione di tutti i piani tariffari per un'organizzazione utilizzando 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 trasmettere i seguenti parametri di query per filtrare i risultati:

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 bundle 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 i piani tariffari attivi, pubblici e standard. Per includere:

• Per i piani tariffari in bozza o scaduti, imposta il parametro di query current su false (ad esempio, ?current=false).
• Per i piani tariffari privati, imposta il parametro di ricerca showPrivate su true (ad esempio, ?showPrivate=true).
• Tutti i piani tariffari standard, imposta il parametro di query standard su true (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 utilizzando l'API

Per visualizzare un piano tariffario per un pacchetto API, invia 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 quando crei il 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 utilizzando 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 trasmettere i seguenti parametri di query per filtrare i risultati:

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
}

Visualizzazione di 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 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"
  }

Visualizzazione di 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 query 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 utilizzando 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 trasmettere i seguenti parametri di query per filtrare i risultati:

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
}

Eliminazione di una bozza di 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 seguenti impostazioni di configurazione.

Proprietà di configurazione per i dettagli del piano tariffario

Puoi specificare una delle seguenti proprietà di configurazione come parte dell'array ratePlanDetails durante la creazione del piano tariffario.