Configura il piano di notifiche regolabili

Stai visualizzando la documentazione di Apigee Edge.
Vai alla sezione Documentazione di Apigee X. Informazioni

Introduzione

In un piano di notifica modificabile, il provider API può adeguare il numero target di transazioni per ogni sviluppatore di app. Puoi configurare se e quando le notifiche vengono inviate in base su quando viene raggiunta una percentuale del numero target, ad esempio 90%, 100% o 150%. Aggiuntivo le transazioni non vengono bloccate una volta raggiunto il numero target.

Configurazione di un piano di notifica modificabile mediante l'interfaccia utente

Configura piani di notifica regolabili, come descritto di seguito.

Edge

Per configurare un piano di notifica regolabile utilizzando l'UI di Edge, durante l'aggiunta o la modifica di una tariffa seleziona il tipo di piano Adjustable Notification e configura le seguenti informazioni nella sezione Adjustable Notification:

Campo Descrizione Predefinito
Frequenza di calcolo Periodo di tempo durante il quale viene calcolato il volume delle transazioni (o del volume relativo agli attributi personalizzati). Seleziona un numero di mesi (1-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 voler addebitare un costo 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 piani di notifica regolabili utilizzando l'interfaccia utente di Edge classico:

  1. Seleziona Adjustable Notification (Notifica regolabile) in Tipo di piano tariffario della scheda Dettagli piano della finestra Piano tariffario.

    Consulta la sezione Creare un piano tariffario utilizzando l'interfaccia utente per informazioni sull'accesso alla finestra Piano tariffario.

  2. Imposta il campo Durata rinnovo sul numero di mesi in cui il piano venga rinnovato automaticamente (a meno che lo sviluppatore non risolva il contratto prima di questa data). Se se imposti questo valore su 0, il piano rimane attivo 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 il volume di vengono aggregate. Seleziona un numero compreso tra 1 e 24 mesi. Il valore predefinito è 1 mese.
  5. Fai clic su Applica e chiudi.
  6. Fai clic su Salva bozza.
  7. Pubblica il piano solo quando hai la certezza assoluta che sia definitivo. Consulta Piani tariffari di pubblicazione 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 una tariffa dopo la sua pubblicazione, ma puoi far scadere il piano tariffario e sostituirlo con una tariffa futura come descritto in Fai scadere una tariffa pubblicata .

Configurazione di un piano di notifica modificabile mediante l'API

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

Per specificare un piano di notifica modificabile, specifica i seguenti valori nel 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 dell'aggregazione, insieme a durationType. Per i piani tariffari regolabili, imposta questo valore su un numero intero compreso tra 1 e 24.
durationType

Imposta il periodo di tempo per la base dell'aggregazione, insieme a durationType. Imposta questo valore per i piani tariffari di notifica regolabili a MONTH.

Per ulteriori informazioni sulle proprietà di configurazione che possono essere impostate quando specifichi dettagli del piano di notifica modificabile, consulta Dettagli del piano tariffario impostazioni di configurazione.

Ad esempio, quanto segue definisce un piano di notifica modificabile con una base di aggregazione impostato 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

Impostare il target numero di transazioni per ogni sviluppatore di app che utilizza l'API

Per ogni sviluppatore di app che ha accettato il piano del tasso di notifica regolabile, devi: imposta il numero di transazioni target. 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 una volta raggiunto il numero target.

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

Impostare il numero target di transazioni quando si accetta il 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 /organizations/{org_name}/developers/{developer_id}/developer-rateplans risorsa. Imposta quotaTarget su un numero intero positivo o su 0 per disattivare le notifiche per l'app sviluppatore. Se non specificato, il valore predefinito di quotaTarget è 0.

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

$ 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 al /organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id} risorsa. Imposta quotaTarget su un numero intero positivo o su 0 per disattivare notifiche per lo sviluppatore dell'app. Se non specificato, il valore predefinito di quotaTarget è 0.

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

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 la tariffa sviluppatore inoltrando 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 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 seguente richiesta 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@azienda.it"
   },
   "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