Configura il piano di notifiche regolabili

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

Introduzione

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

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

Configura piani di notifica modificabili, come descritto di seguito.

Perimetrale

Per configurare un piano di notifica regolabile utilizzando l'interfaccia utente Edge, quando aggiungi o modifichi un piano tariffario, seleziona il tipo di piano 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 delle 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 di transazioni in base a un attributo personalizzato.

Ad esempio, potresti dover:

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

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

Classic Edge (private cloud)

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

  1. Seleziona Notifica regolabile nel campo Tipo di piano tariffario nella scheda Dettagli piano nella finestra Piano tariffario.

    Consulta la sezione Creazione di un piano tariffario utilizzando l'interfaccia utente per informazioni su come accedere alla finestra Piano tariffario.

  2. Imposta il campo Durata del rinnovo sul numero di mesi in cui il piano viene rinnovato automaticamente (a meno che lo sviluppatore non risolva il contratto prima di questa data). Se imposti questo valore su 0, il piano rimane in vigore finché lo sviluppatore non decide di terminarlo.
  3. Fai clic su Dettagli in Piano tariffario generico.
  4. Imposta la 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. Per impostazione predefinita, questo valore è di 1 mese.
  5. Fai clic su Applica e chiudi.
  6. Fai clic su Salva bozza.
  7. Pubblica il piano solo quando sei assolutamente sicuro che sia definitivo. Consulta la pagina relativa alla pubblicazione dei piani tariffari per informazioni sull'impostazione della data di pubblicazione e sulla pubblicazione del piano.

    Dopo aver pubblicato un piano tariffario, puoi modificare solo la data di fine. Non puoi eliminare un piano tariffario dopo la sua pubblicazione, ma puoi far scadere il piano tariffario e sostituirlo con un piano tariffario futuro, come descritto nella sezione Scadenza di un piano tariffario pubblicato.

Configurazione di un piano di notifica modificabile mediante l'API

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

Per specificare un piano di notifica modificabile, 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, impostalo su un valore intero compreso 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 si specificano i 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 target di transazioni per ogni sviluppatore di app che utilizza l'API

Devi impostare il numero target di transazioni per ogni sviluppatore di app che ha accettato il piano con tasso di notifica regolabile. Puoi configurare se e quando inviare le notifiche in base al raggiungimento di una percentuale del numero target, ad esempio 90%, 100% o 150%. Una volta raggiunto il numero target, le transazioni aggiuntive non vengono bloccate.

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

Impostare il 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 disabilitare 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 di 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 in fase di 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 di 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 disabilitare 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 {developer-rateplan-id} per il piano tariffario per sviluppatori inviando una richiesta GET a /organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans, dove {developer_id} è l'indirizzo email dello sviluppatore. Per maggiori informazioni, consulta la sezione Visualizzare tutti i piani tariffari accettati da uno 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 richiesta seguente aggiorna il numero target di transazioni a 4000.

$ curl -H "Content-Type:application/json" -X PUT -d \
'{ 
 "id" : "b1c600b8-f871-496d-8173-12b9950d6ab1",
 "developer":{
 "id":"dev@mycompany.com"rate":email:password