Configura il piano di notifiche regolabili

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

Introduzione

In un piano di notifica regolabile, il fornitore dell'API può regolare 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.

Configurare un piano di notifica regolabile utilizzando la UI

Configura i piani di notifica regolabili come descritto di seguito.

Edge

Per configurare un piano di notifica regolabile utilizzando la UI di Edge, quando aggiungi o modifici 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 delle transazioni (o il volume correlato all'attributo personalizzato). 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 basato su 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 un importo in base al numero di byte trasmessi nella richiesta API.
  • Raggruppare più chiamate API in un'unica transazione.
    In questo caso, seleziona Utilizza parametro di valutazione personalizzato e seleziona 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 i piani di notifica regolabili utilizzando la UI di Classic Edge:

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

    Per informazioni su come accedere alla finestra Piano tariffario, consulta Creare un piano tariffario utilizzando la UI.

  2. Imposta il campo Periodo di rinnovo sul numero di mesi dopo i quali il piano viene rinnovato automaticamente (a meno che lo sviluppatore non rescinda il contratto prima di quella data). Se imposti questo valore su 0, il piano rimane in vigore finché lo sviluppatore non sceglie 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. Il valore predefinito è 1 mese.
  5. Fai clic su Applica e chiudi.
  6. Fai clic su Salva bozza.
  7. Pubblica il piano solo quando sei assolutamente certo che sia definitivo. Per informazioni su come impostare la data di pubblicazione e pubblicare il piano, consulta Pubblicare i piani tariffari.

    Dopo aver pubblicato un piano tariffario, puoi modificarne solo la data di fine. 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.

Configurare un piano di notifica regolabile utilizzando l'API

Specifica i dettagli del piano di notifica regolabile nella ratePlanDetails proprietà 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 nel corpo della richiesta:

Proprietà Valore
type Imposta su USAGE_TARGET.
meteringType Imposta su DEV_SPECIFIC.
duration Imposta sul periodo di tempo per la base di aggregazione, insieme a durationType. Per i piani tariffari di notifica regolabili, imposta questo valore su un numero intero compreso tra 1 e 24.
durationType

Imposta sul periodo di tempo per la base di aggregazione, insieme a durationType. Per i piani tariffari di notifica regolabili, imposta questo valore a MONTH.

Per saperne di più sulle proprietà di configurazione che possono essere impostate quando si specificano i dettagli del piano di notifica regolabile, consulta Impostazioni di configurazione dei dettagli del piano tariffario.

Ad esempio, la seguente definizione di 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

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

Per ogni sviluppatore di app che ha accettato il piano tariffario di notifica regolabile, devi impostare il numero target di transazioni. 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.

Puoi impostare il numero target di transazioni per uno sviluppatore di app quando lo sviluppatore accetta il piano tariffario e puoi aggiornare il valore 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 quotaTarget proprietà 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 0 per disattivare le notifiche per lo sviluppatore di 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 quando si aggiorna il piano tariffario accettato

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

Il valore {developer_rateplan_id} viene restituito nella risposta quando accetti il 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 il {developer-rateplan-id} per il piano tariffario 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 saperne di più, consulta 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@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