Questa pagina è stata tradotta dall'API Cloud Translation.

Configura il piano di notifiche regolabili

Stai visualizzando la documentazione di Apigee Edge.
Vai alla documentazione di Apigee X. info

Introduzione

In un piano di notifica regolabile, il fornitore dell'API può modificare il numero target di transazioni per ogni sviluppatore di app. Puoi configurare se e quando vengono inviate le notifiche in base al raggiungimento di una percentuale del numero target, ad esempio 90%, 100% o 150%. Le transazioni aggiuntive non vengono bloccate dopo il raggiungimento del numero target.

Configurazione di un piano di notifica regolabile utilizzando l'interfaccia utente

Configura piani di notifica regolabili, come descritto di seguito.

Edge

Per configurare un piano di notifica regolabile utilizzando l'interfaccia utente Edge, quando aggiungi o modifichi un piano tariffario seleziona il tipo di piano tariffario Notifica regolabile e nella sezione Notifica regolabile, configura le seguenti informazioni:

Campo	Descrizione	Predefinito
Frequenza di calcolo	Periodo di tempo durante il quale viene calcolato il volume di transazioni (o il volume relativo agli attributi personalizzati). Seleziona un numero di mesi (da 1 a 24 mesi).	1 mese

Se hai definito attributi personalizzati per il tuo prodotto API, puoi configurare un parametro di valutazione personalizzato per definire un contatore transazioni basato su un attributo personalizzato.

Ad esempio, potresti dover:

Addebita agli sviluppatori un importo variabile in base a un valore fornito nel messaggio di una chiamata API.
Ad esempio, potresti addebitare agli sviluppatori di app in base al numero di byte trasmessi nella richiesta API.
Raggruppa più chiamate API in un'unica transazione.
In questo caso, seleziona Utilizza parametro di valutazione personalizzato e scegli l'attributo personalizzato dall'elenco a discesa.

Per saperne di più, consulta l'articolo Configurare il piano tariffario con attributi personalizzati.

Perimetrale classico (Private Cloud)

Per configurare i piani di notifica regolabili utilizzando l'interfaccia utente di Edge classica:

Seleziona Notifica regolabile nel campo Tipo di piano tariffario nella scheda Dettagli piano della finestra Piano tariffario.
Per informazioni sull'accesso alla finestra Piano tariffario, consulta la sezione Creazione di un piano tariffario utilizzando l'interfaccia utente.

Nota: dopo aver selezionato il tipo di notifica regolabile, le schede Tariffe e Freemium non saranno selezionabili poiché non sono applicabili ai piani di notifica regolabili.
Imposta il campo Termine di rinnovo sul numero di mesi al termine dei quali il piano viene rinnovato automaticamente (a meno che lo sviluppatore non risolva il contratto prima di questa data). Se impostate questo valore su 0, il piano rimane in vigore finché lo sviluppatore non sceglie di terminarlo.
Fai clic su Dettagli in Piano tariffario generico.
Imposta Base di aggregazione sul periodo di tempo durante il quale viene aggregato il volume delle transazioni. Seleziona un numero compreso tra 1 e 24 mesi. Il valore predefinito è 1 mese.
Fai clic su Applica e chiudi.
Fai clic su Salva bozza.
Pubblica il piano solo quando hai la certezza che sia definitivo. Consulta la sezione Piani di tariffe di pubblicazione per informazioni su come impostare la data di pubblicazione e pubblicare il piano.

Dopo aver pubblicato un piano tariffario, puoi modificare solo la data di fine. Non puoi eliminare un piano tariffario dopo averlo pubblicato, ma puoi impostarne la scadenza e sostituirlo con un piano tariffario futuro, come descritto in Scadenze di un piano tariffario pubblicato.

Configurazione di un piano di notifica modificabile mediante l'API

Specifica i dettagli del piano di notifica regolabile nella proprietà ratePlanDetails nel corpo della richiesta in una richiesta POST a /organizations/{org_name}/monetization-packages/{package_id}/rate-plans.

Per specificare un piano di notifica regolabile, specifica i seguenti valori in ratePlanDetails del corpo della richiesta:

Proprietà	Valore
`type`	Da impostare su `USAGE_TARGET`.
`meteringType`	Da impostare su `DEV_SPECIFIC`.
`duration`	Imposta il periodo di tempo per la base di aggregazione, insieme a `durationType`. Per i piani di frequenza di notifica regolabili, imposta un valore intero tra 1 e 24.
`durationType`	Imposta il periodo di tempo per la base di aggregazione, insieme a `durationType`. Per i piani di frequenza di notifica regolabili, imposta questo valore su `MONTH`.

Per ulteriori informazioni sulle proprietà di configurazione che possono essere impostate quando specifichi dettagli del piano di notifica regolabili, consulta Impostazioni di configurazione dei dettagli del piano tariffario.

Ad esempio, quanto segue definisce un piano di notifica regolabile con una base di aggregazione impostata su 1 mese.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "AdjustableNotification",
     "displayName": "Adjustable notification plan",
     "description": "Adjustable notification plan",
     "published": "true",  
     "organization": {
      "id": "myorg"
     },
     "startDate": "2016-04-15 00:00:00",
     "type": "STANDARD",
     "monetizationPackage": {
        "id": "p1",
        "name": "test"
     },
     "currency": {
        "id" : "usd",
        "name" : "USD"
     },
     "ratePlanDetails": [
        {
           "type": "USAGE_TARGET",
           "meteringType": "DEV_SPECIFIC",
           "duration": 1,
           "durationType": "MONTH",
           "ratingParameter": "VOLUME",
           "organization": {
             "id": "myorg"
           },
           "currency": {
             "id": "usd",
             "name": "USD"
           }
        }
     ]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/p1/rate-plans"  \
-u email:password

Impostazione del numero di transazioni di destinazione per ogni sviluppatore di app che utilizza l'API

Per ogni sviluppatore di app che ha accettato il piano di frequenza delle notifiche regolabile, devi impostare il numero target di transazioni. Puoi configurare se e quando inviare le notifiche in base al raggiungimento di una percentuale del numero target, ad esempio 90%, 100% o 150%. Le transazioni aggiuntive non vengono bloccate dopo il raggiungimento del numero target.

Puoi impostare il numero target di transazioni per uno sviluppatore di app quando accetta il piano tariffario e puoi aggiornare il valore in un secondo momento.

Impostazione del numero target di transazioni al momento dell'accettazione del piano tariffario

Quando accetti il piano tariffario, per impostare il numero target di transazioni, specifica la proprietà quotaTarget nel corpo della richiesta in una richiesta POST alla risorsa /organizations/{org_name}/developers/{developer_id}/developer-rateplans. Imposta quotaTarget su un numero intero positivo o su 0 per disattivare le notifiche per lo sviluppatore dell'app. Se non specificato, il valore predefinito di quotaTarget è 0.

Ad esempio, la seguente richiesta imposta il numero target di transazioni su 4000 quando lo sviluppatore dell'app accetta il piano di notifica regolabile.

$ curl -H "Content-Type:application/json" -X POST -d \
'{ 
   "developer":{
     "id":"dev@mycompany.org"
   },
   "ratePlan":{
     "id":"p1_adjustable-notification-plan"
   },
   "startDate": "2016-03-24 00:00:00",
   "quotaTarget": 4000,
   "suppressWarning": false
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans" \
-u email:password

Impostare il numero target di transazioni durante l'aggiornamento del piano tariffario accettato

Per impostare il numero target di transazioni, puoi aggiornare il piano tariffario accettato e specificare la proprietà quotaTarget nel corpo della richiesta in una richiesta PUT alla risorsa /organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id}. Imposta quotaTarget su un numero intero positivo o su 0 per disattivare le notifiche per lo sviluppatore dell'app. Se non specificato, il valore predefinito di quotaTarget è 0.

Quando accetti il piano tariffario pubblicato, viene restituito {developer_rateplan_id} nella risposta.

Ad esempio:

{
  "created": "2016-03-31 18:59:54",
  "developer": {
    ...
  },
  "id": "b1c600b8-f871-496d-8173-12b9950d6ab1",
  "quotaTarget": 3000,
  "ratePlan": {
    ...
  },
  "startDate": "2016-03-31 00:00:00",
  "updated": "2016-03-31 18:59:54",
  "waiveTerminationCharge": false
}

In alternativa, puoi ottenere il {developer-rateplan-id} per il piano di tariffe dello sviluppatore inviando una richiesta GET a /organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans, dove {developer_id} è l'indirizzo email dello sviluppatore. Per ulteriori informazioni, consulta la sezione Visualizzare tutti i piani tariffari accettati da un sviluppatore.

Ad esempio:

{
  "developerRatePlan": [
    {
      "created": "2016-03-31 14:52:30",
      "developer": {
        ...
      },
      "id": "b1c600b8-f871-496d-8173-12b9950d6ab1",
      "quotaTarget": 3000,
      "ratePlan": { 
        ... 
      }, 
      "startDate": "2016-03-31 00:00:00", 
      "updated": "2016-03-31 18:59:54" 
    } 
  ], 
  "totalRecords": 1 
}

La seguente richiesta aggiorna il numero target di transazioni su 4000.

$ curl -H "Content-Type:application/json" -X PUT -d \
'{ 
   "id" : "b1c600b8-f871-496d-8173-12b9950d6ab1",
   "developer":{
     "id":"dev@mycompany.com"
   },
   "ratePlan":{
     "id":"p1_adjustable-notification-plan"
   },
   "startDate": "2016-04-15 00:00:00",
   "quotaTarget": 4000,
   "suppressWarning":false
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/b1c600b8-f871-496d-8173-12b9950d6ab1"
-u email:password