Configurare le notifiche con modelli di notifica

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

Che cosa sono i modelli di notifica?

La monetizzazione fornisce un insieme di modelli che definiscono il testo di esempio per vari tipi di notifiche relative agli eventi. Puoi personalizzare uno di questi modelli per:

  • Inviare notifiche a tutti gli sviluppatori su eventi quali nuovi prodotti, nuove versioni dei TdC o nuovi piani tariffari.
  • Informa gli sviluppatori interessati di eventi come un piano tariffario rivisto.
  • Inviare una notifica a un fornitore di API in merito a eventi relativi agli sviluppatori, ad esempio quando uno sviluppatore si registra per un account o per un piano tariffario.
  • Invia una notifica a tutti gli amministratori dell'azienda su un evento specifico.

In alternativa, puoi creare un webhook che definisce un gestore di callback HTTP, quindi configurare la condizione che attiva l'webhook, come descritto in Configurare le notifiche utilizzando i webhook.

Esplorazione della pagina Notifiche

Accedi alla pagina Notifiche, come descritto di seguito.

Edge

Per accedere alla pagina Notifiche utilizzando la UI Edge:

  1. Accedi ad apigee.com/edge.
  2. Seleziona Pubblicazione > Monetizzazione > Notifiche nella barra di navigazione a sinistra.

Viene visualizzata la pagina Notifiche.

Come evidenziato nella figura, la pagina Notifiche ti consente di:

Edge classico (private cloud)

Per accedere alla pagina Notifiche utilizzando l'interfaccia utente classica di Edge:

  1. Accedi a http://ms-ip:9000, dove ms-ip è l'indirizzo IP o il nome DNS del nodo del server di gestione.

  2. Seleziona Amministrazione > Notifiche nella barra di navigazione in alto.

La pagina Notifiche ti consente di:

Modifica delle notifiche

Per modificare una notifica utilizzando l'interfaccia utente:

  1. Accedi alla pagina Notifiche.
  2. Fai clic su accanto alla notifica da modificare per espandere i dettagli.
  3. Modifica i campi Oggetto, Testo e Destinatario (se disponibile), come richiesto.

    Per informazioni sulle variabili che possono essere specificate all'interno di un modello di notifica, consulta la sezione Utilizzo delle variabili nei modelli di notifica.

    Per saperne di più sulla modifica delle notifiche in ogni categoria, consulta le sezioni seguenti:

  4. Attiva una notifica selezionando la casella di controllo adiacente.
  5. Ripeti i passaggi da 2 a 4 per modificare altre notifiche.
  6. Fai clic su Salva per salvare tutte le modifiche.

Viene visualizzato un messaggio che conferma che le notifiche sono state salvate. L'operazione di salvataggio potrebbe richiedere alcuni minuti.

Modificare le notifiche per inviare una notifica a tutti gli sviluppatori

Le notifiche per i tipi di eventi selezionati nella sezione Avvisa tutti gli sviluppatori vengono inviate a tutti gli sviluppatori.

Le notifiche sono pianificate per essere inviate alla fine della giornata. Dopo l'invio delle notifiche, le caselle di controllo degli eventi vengono deselezionate automaticamente. Devi selezionarli di nuovo per pianificare le notifiche per i tipi di eventi associati.

La tabella seguente elenca le notifiche in base ai tipi di evento nella sezione Avvisa tutti gli sviluppatori. Per ulteriori informazioni, consulta la sezione Modificare le notifiche utilizzando l'interfaccia utente.

Tipo di evento Trigger Note
Nuovo pacchetto È disponibile un nuovo pacchetto API

Aggiungi il nome di ogni nuovo pacchetto (e dei prodotti contenuti in ogni pacchetto) al corpo del modello email nell'ambito dell'aggiornamento. Puoi anche aggiungere un link al portale per gli sviluppatori o a qualsiasi altro sito web che fornisca ulteriori informazioni sulla notifica.
Nuovo prodotto È disponibile un nuovo prodotto API

Aggiungi il nome di ogni nuovo prodotto al corpo del modello email nell'ambito dell'aggiornamento. Puoi anche aggiungere un link al portale per gli sviluppatori o a qualsiasi altro sito web che fornisca ulteriori informazioni sulla notifica.
Nuovi mercati/copertura I nuovi prodotti API sono disponibili in mercati geografici specifici

Aggiungi il nome di ogni nuovo mercato e dei prodotti pertinenti al corpo del modello email nell'ambito dell'aggiornamento. Puoi anche aggiungere un link al portale per gli sviluppatori o a qualsiasi altro sito web che fornisca ulteriori informazioni sulla notifica.

Modificare le notifiche per informare gli sviluppatori interessati

Le notifiche per i tipi di eventi selezionati nella sezione Avvisa gli sviluppatori interessati vengono inviate solo agli sviluppatori interessati da questi tipi di eventi. Ad esempio, se selezioni l'evento Piano tariffario modificato, viene inviata una notifica solo agli sviluppatori che hanno accettato il piano tariffario.

Nella tabella seguente sono elencate le notifiche in base ai tipi di eventi nella sezione Avvisa gli sviluppatori interessati. Per ulteriori informazioni, consulta la sezione Modificare le notifiche utilizzando l'interfaccia utente.

Tipo di evento Trigger Note
Termini e condizioni non accettati o scaduti È stato pubblicato un nuovo insieme di TdC e lo sviluppatore non li ha ancora accettati

La notifica viene inviata 30 giorni, 7 giorni e 1 giorno prima dell'entrata in vigore dei nuovi TdC.
Nuovo piano tariffario Nuovi piani tariffari pubblicati

Se il piano tariffario è:

  • piano Standard, tutti gli sviluppatori ricevono una notifica.
  • Piano tariffario della categoria sviluppatore: solo gli sviluppatori appartenenti a quella categoria vengono avvisati.
  • Piano tariffario sviluppatore, solo lo sviluppatore specifico riceve una notifica.
Piano tariffario rivisto È disponibile una versione più recente di un piano tariffario acquistato

Solo gli sviluppatori che hanno acquistato la versione corrente riceveranno una notifica. La notifica consente agli sviluppatori di esaminare la nuova versione e di annullare o cambiare piano se non vogliono accettare le nuove tariffe.
Piano tariffario scaduto Il piano tariffario è scaduto senza alcun piano tariffario di follow-up

Questa notifica viene inviata quando imposti inizialmente la scadenza del piano tariffario, con altre notifiche inviate 30, 7 e 1 giorno prima della data di scadenza. Solo gli sviluppatori che hanno acquistato il piano tariffario in scadenza riceveranno una notifica.
Piano tariffario rinnovato L'abbonamento al piano tariffario è stato rinnovato.

Comunica allo sviluppatore che verranno addebitate le commissioni applicabili.
Limite di frequenza superato È stato superato il limite del piano tariffario

Comunica allo sviluppatore che verranno addebitate le commissioni applicabili.
Piano tariffario freemium esaurito I periodi di utilizzo senza costi, misurati in base al numero di transazioni o ai giorni, sono stati esauriti

Il periodo di utilizzo senza costi è definito dal tuo piano tariffario freemium.
Documento di fatturazione pubblicato

Sono disponibili i documenti di fatturazione (ad esempio le fatture) per lo sviluppatore.
Lo sviluppatore si registra al nuovo piano tariffario Lo sviluppatore sottoscrive un nuovo piano tariffario.

Modifica delle notifiche per i fornitori dell'API Notify

Le notifiche per i tipi di eventi selezionati nella sezione Invia notifiche al provider dell'API vengono inviate al provider dell'API specificato.

Nella tabella seguente sono elencate le notifiche in base ai tipi di evento nella sezione Provider API Notify. Per ulteriori informazioni, consulta la sezione Modificare le notifiche utilizzando l'interfaccia utente.

Tipo di evento Trigger
Registrazione di nuovi sviluppatori

Lo sviluppatore ha registrato un account.
Lo sviluppatore aggiunge un'app

Lo sviluppatore ha creato una nuova applicazione.
Registrazione degli sviluppatori al nuovo piano tariffario

Lo sviluppatore ha sottoscritto un piano tariffario.
Lo sviluppatore modifica i dettagli finanziari

Lo sviluppatore ha modificato i dati finanziari, ad esempio il nome o l'indirizzo della sua azienda.

Attivare o disattivare una notifica

Per attivare o disattivare una notifica utilizzando l'interfaccia utente:

  1. Accedi alla pagina Notifiche.
  2. Attiva o disattiva una notifica selezionando o deselezionando la casella di controllo adiacente.
  3. Fai clic su Salva per salvare tutte le modifiche.

L'operazione di salvataggio potrebbe richiedere alcuni minuti. Viene visualizzato un messaggio che conferma che le notifiche sono state salvate.

Configurazione delle notifiche utilizzando i modelli tramite l'API

Configura le notifiche utilizzando l'API, come descritto nelle sezioni seguenti.

Gestione dei modelli di notifica utilizzando l'API

Gestisci i modelli di notifica utilizzando l'API, come descritto nelle sezioni seguenti:

Visualizzazione di tutti i modelli di notifica utilizzando l'API

Puoi elencare tutti i modelli di notifica forniti dalla monetizzazione inviando una richiesta GET a /mint/organizations/{org_name}/notification-email-templates. Ad esempio:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/notification-email-templates" \
  -u email:password

Ad esempio, di seguito è riportato un modello di evento che comunica agli sviluppatori la disponibilità di un nuovo prodotto API:

{
    "createdDate" : 1376975394984,
    "htmlImage" : "<p>Dear ${developer.legalName} , ${developer.name} <br /> Introducing _________. For more details visit us at _________________</p>",
    "id" : "4d81ea64-d005-4010-b0a7-6ec8a5c3954b",
    "name" : "DEFAULT_NEW_PRODUCT_TEMPLATE",
    "orgId" : "myorg",
    "source" : "Mail Man Test",
    "subject" : "Notification of new product",
    "updatedDate" : 1376975394984
}

Visualizzazione di un modello di notifica utilizzando l'API

Visualizza un modello di notifica inviando una richiesta GET a /mint/organizations/{org_name}/notification-email-templates/{template_id}, dove {template_id} è l'ID del modello. Ad esempio:

curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-email-templates/4d81ea64-d005-4010-b0a7-6ec8a5c3954b" \
  -H "Accept:application/json"  \
  -u email:password

Gli elementi nei modelli che iniziano con $ sono variabili. Per ulteriori informazioni, consulta la sezione Utilizzare le variabili nei modelli di notifica. Supponiamo che le variabili nella notifica vengano valutate con i seguenti valori:

  • ${developer.legalName}.XYZ company
  • ${developer.name}.DEV1
  • ${QUOTA_TYPE}.Transactions
  • ${PERCENT}.90%
  • ${QUOTA_UNIT}.Calls
  • ${QUOTA_LIMIT}.100
  • ${ratePlan.monetizationPackage.products.name}.X
  • ${EXPIRY_DATE}.2016-09-30

Il messaggio di notifica fornito dal modello sarà:

    "Dear XYZ company, DEV1
    You have exceeded Transactions of 90% calls of 100 calls for X product. Your API calls will be blocked till 2016-09-30"

Modifica di un modello di notifica utilizzando l'API

Modifica un modello di notifica inviando una richiesta PUT a /nint/organizations/{org_name}/notification-email-templates/{template_id}. Fornisci i contenuti modificati del modello nel corpo della richiesta.

Quando personalizzi il messaggio in un modello di notifica, puoi includere una o più variabili. Per ulteriori informazioni, consulta la sezione Utilizzare le variabili nei modelli di notifica.

Ad esempio, la seguente richiesta modifica i contenuti di una nuova notifica di prodotto API:

curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-email-templates/4d81ea64-d005-4010-b0a7-6ec8a5c3954b " \
  -H "Content-Type: application/json" \
  -d '{
    "id" : "4d81ea64-d005-4010-b0a7-6ec8a5c3954b",
    "htmlImage" : "<p>Exciting news, we have added a new product :${Product.name}. See details in <a href="${Product.url}">New Products</a> </p>",
    "name" : "NewProductNotification",
    "organization": {
    "id": "{org_name}"
    },
    "source" : "Mail Man Test ",
    "subject" : "New Product Available: ${Product.name}"
  }' \
  -u email:password

Gestione delle condizioni e delle azioni di notifica utilizzando l'API

Gestisci le condizioni e le azioni di notifica utilizzando l'API, come descritto nelle sezioni seguenti.

Creazione di una condizione e di un'azione di notifica utilizzando l'API

Crea una condizione e un'azione di notifica che generino una notifica automatica inviando una richiesta POST a /mint/organizations/{org_name}/notification-conditions.

Quando effettui la richiesta, specifica nel corpo della richiesta la condizione che genera la notifica e le azioni da intraprendere quando viene raggiunta la condizione (ad esempio l'invio di un'email di notifica).

Definisci i dettagli della condizione di notifica specificando uno o più valori dell'attributo. Per un elenco di attributi, consulta Proprietà di configurazione per le condizioni di notifica. Per una notifica di evento, la condizione potrebbe essere attivata quando viene pubblicato un nuovo prodotto.

Quando definisci actions, fai riferimento al modello di notifica applicabile. Consulta Proprietà di configurazione per le azioni di notifica per un elenco di azioni.

Ad esempio, la seguente richiesta specifica che quando l'attributo è NEW_PRODUCT e il valore dell'attributo PUBLISHED è true, invia la notifica nel modello con l'ID 01191bf9-5fdd-45bf-8130-3f024694e63 (ovvero DEFAULT_NEW_PRODUCT_TEMPLATE).

curl -X POST "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-conditions" \
  -H "Content-Type:application/json"
  -d '{
    "notificationCondition": [
    {
      "attribute": "NEW_PRODUCT"
    },
    {
      "attribute": "PUBLISHED",
      "value": "true"
    }
    ],
    "actions": [{
      "actionAttribute": "DEV_ID",
      "value": "ANY",
      "templateId": "01191bf9-5fdd-45bf-8130-3f024694e63"
    }]
  }' \
  -u email:password

Visualizzazione di una condizione e di un'azione di notifica mediante l'API

Visualizza una condizione e un'azione di notifica inviando una richiesta GET a organizations/{org_name}/notification-conditions/{condition_Id}, dove {condition_Id} è l'ID della condizione. L'ID viene restituito quando crei la condizione di notifica. Ad esempio:

curl -X GET "https://api.enterprise.apigee.com /v1/mint/organizations/{org_name}/notification-conditions/2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4" \
  -H "Accept:application/json" \
  -u email:password

Di seguito è riportato un esempio di risposta:

    {
    "actions" : [ {
    "actionAttribute" : "DEV_ID",
    "id" : "141ba00c-d7bd-4fef-b339-9d58b83255f4",
    "templateId" : "766aba4f-0f7a-4555-b48e-d707c48b8f4c",
    "value" : "ANY"
    }, {
    "actionAttribute" : "ORG_EMAIL",
    "id" : "21486ce1-4290-4a55-b415-165af3e93c9d",
    "templateId" : "efa4ce63-7c08-4876-984b-6878ec435994",
    "value" : "DEFAULT_LIMIT_NOTIFICATION_EMAIL"
    } ],
    "notificationCondition" : [ {
    "attribute" : "Balance",
    "id" : "2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4",
    "organization" : {
    ...
    },
    "value" : "< 0"
    } ]
    }

Modifica di una condizione e di un'azione di notifica utilizzando l'API

Modifica una condizione e un'azione di notifica inviando una richiesta POST a organizations/{org_name}/notification-conditions/{condition_Id}, dove {condition_Id} è l'ID della condizione. L'ID viene restituito quando crei la condizione di notifica. Quando emetti la richiesta, specifica nel corpo della richiesta le modifiche che vuoi apportare alla condizione o all'azione di notifica.

Ad esempio:

   $ curl -H "Content-Type:application/json" -X POST -d \
    ' {
    "notificationCondition": [
    {
      "attribute": "NEW_PRODUCT"
    },
    {
    "attribute": "PUBLISHED",
    "value": "true"
    }
    ],
    "actions": [{
      "actionAttribute": "DEV_ID",
      "value": "ANY",
      "templateId": "01191bf9-5fdd-45bf-8130-3f024694e63"
    }]
    }' \
    "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-conditions/2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4" \
  -u email:password

Eliminazione di una condizione e di un'azione di notifica utilizzando l'API

Elimina una condizione di notifica inviando una richiesta DELETE a organizations/{org_name}notification-conditions/{condition_Id}. Ad esempio:

curl -X DELETE "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-conditions/2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4"  \
  -H "Accept:application/json"  \
  -u email:password

Proprietà di configurazione per le condizioni di notifica

Quando si utilizza l'API, sono disponibili le seguenti proprietà di configurazione per le condizioni di notifica.

Nome Descrizione Predefinito Obbligatorio?
attribute

Dettagli della condizione di notifica. Puoi specificare uno o più attributi per perfezionare la condizione di notifica.

Il valore può essere uno o più dei seguenti:

  • ADD_RATEPLAN
  • ADHOC_NOTIFY_DEVELOPERS
  • BILLING_DOCS_PUBLISHED
  • COMPANY_ACCEPTS_INVITATION
  • COMPANY_CANCELS_INVITATION
  • COMPANY_DECLINES_INVITATION
  • COMPANY_INVITES_DEVELOPER
  • CREATE_APPLICATION
  • CREATE_DEVELOPER
  • DATE
  • DEVELOPER_ACCEPTS_INVITATION
  • DEVELOPER_CANCELS_INVITATION
  • DEVELOPER_DECLINES_INVITATION
  • DEVELOPER_INVITES_COMPANY
  • EXPIRING_TNC
  • FeeExposure
  • FREEMIUM_USED_UP
  • NEW_PACKAGE
  • NEW_PRODUCT
  • PUBLISHED
  • RATEPLAN
  • RATEPLAN_ACCEPTED
  • RATEPLAN_ENDED
  • RATEPLAN_EXPIRED
  • RATEPLAN_RENEWED
  • RATEPLAN_REVISION
  • Transactions
  • UPDATE_DEVELOPER
  • UsageTarget (valido solo per la configurazione degli webhook)
 N/D Sì
value

Valore dell'attributo.

 N/D No
associatedCondition

Riferimento a una condizione associata.

 N/D No

Proprietà di configurazione per le azioni di notifica

Quando utilizzi l'API, sono disponibili le seguenti proprietà di configurazione per le azioni di notifica.

Nome Descrizione Predefinito Obbligatorio?
actionAttribute

Metodo utilizzato per identificare il destinatario della notifica. Il valore può essere uno o più dei seguenti:

  • ORG_EMAIL. Il destinatario della notifica è identificato dall'indirizzo email.
  • DEV_ID. Il destinatario della notifica è identificato dall'ID sviluppatore (indirizzo email).
  • COMPANY_ADMINS. La notifica viene inviata a tutti gli amministratori dell'azienda, indipendentemente dal valore impostato. Tieni presente che gli amministratori dell'azienda sono diversi dagli amministratori dell'organizzazione.
  • WEBHOOK. Le informazioni sul destinatario della notifica vengono inviate al gestore del callback del webhook. Consulta Configurare le notifiche tramite webhook.
 N/D Sì
value

Valore dell'attributo action.

Se actionAttribute è impostato su ORG_EMAIL o DEV_ID, un valore ANY invia la notifica a qualsiasi destinatario applicabile, ad esempio qualsiasi indirizzo ORG_EMAIL o qualsiasi DEV_ID.

Se actionAttribute è impostato su WEBHOOK, imposta questo valore sull'ID del webhook.

Se actionAttribute è impostato su COMPANY_ADMINS, questo valore viene ignorato; la notifica viene inviata a tutti gli amministratori dell'azienda.

 N/D Sì
templateID

ID del modello di notifica.

Nota:questa opzione non è valida se actionAttribute è impostato su WEBHOOK.

 N/D Sì
postURL

Gestore del callback per l'webhook.

Nota: questa opzione è obbligatoria se actionAttribute è impostato su WEBHOOK. Questa opzione non è valida se il valore è impostato su ORG_EMAIL, DEV_ID o COMPANY_ADMINS.

 N/D Sì

Utilizzo delle variabili nei modelli di notifica

Quando modifichi il messaggio in un modello di notifica, puoi includere una o più variabili utilizzando Spring Expression Language (SpEL) per rappresentare i valori restituiti nell'oggetto Transaction.

La tabella seguente riassume le variabili dei modelli di notifica più utilizzate.

Variabile Descrizione
${application.name}

Nome di un'applicazione.
${application.products.name} Nome di un prodotto incluso in un'applicazione.
${BALANCE} Saldo per una determinata quota.
${developer.legalName}

Nome dell'azienda di uno sviluppatore.
${developer.name}

Nome di uno sviluppatore.
${EXPIRY_DATE}

Data o ora in cui un limite scade o viene reimpostato.
${LONG_PERCENT} Percentuale di un limite raggiunto dall'utilizzo corrente, senza il simbolo %. Ad esempio, 50
${PERCENT}

Percentuale di un limite raggiunto dall'utilizzo corrente, con il simbolo %. Ad esempio, il 50%.
${products.displayName} Nome visualizzato definito per un prodotto.
${QUOTA_TYPE}

Tipo di limite (volume di transazioni, limite di spesa o esposizione alle commissioni).
${QUOTA_UNIT}

Unità di base per un limite: valuta (per un limite di spesa) o chiamate (per un limite di transazioni).
${QUOTA_LIMIT}

Importo di un limite.
${ratePlan.displayName} Nome visualizzato definito per un piano tariffario.
${ratePlan.endDate} Data in cui un fornitore di API ha terminato un piano tariffario.
${ratePlan.monetizationPackage.displayName}

Nome di un pacchetto API.
${ratePlan.monetizationPackage.name} Nome di un pacchetto di monetizzazione.
${ratePlan.monetizationPackage.products.displayName}

Nome visualizzato definito per un prodotto API.
${ratePlan.monetizationPackage.products.name} Nome di un prodotto incluso in un pacchetto di monetizzazione.
${ratePlan.startDate} Data di creazione di un piano tariffario.
${USAGE} Utilizzo attuale (entrate o addebiti totali oppure volume).
${USER}

Nome di un utente.

Personalizzare l'indirizzo email per le risposte

Per la monetizzazione, è configurato un indirizzo noreply@apigee.com predefinito da utilizzare per le notifiche email inviate a aziende e sviluppatori. Contatta l'assistenza Apigee per configurare un nome e un indirizzo di risposta personalizzati per la tua organizzazione.