Stai visualizzando la documentazione di Apigee Edge.
Vai alla
documentazione di Apigee X. informazioni
Che cosa sono i modelli di notifica?
La monetizzazione fornisce un insieme di modelli che definiscono un testo di esempio per vari tipi di notifiche di eventi. Puoi personalizzare uno qualsiasi di questi modelli per:
- Comunicare a tutti gli sviluppatori gli eventi relativi a nuovi prodotti, nuove versioni dei termini e condizioni o nuovi piani tariffari.
- Avvisare gli sviluppatori interessati in merito a eventi quali una revisione del piano tariffario.
- Avvisa un provider di API in merito a eventi relativi allo sviluppatore, ad esempio quando uno sviluppatore si registra a un account o quando si registra a un piano tariffario.
- Inviare una notifica a tutti gli amministratori dell'azienda in merito a un evento specifico.
In alternativa, puoi creare un webhook che definisca un gestore di callback HTTP e configurare la condizione che attiva il webhook, come descritto in Configurare le notifiche utilizzando i webhook.
Esplorazione della pagina Notifiche
Accedi alla pagina Notifiche, come descritto di seguito.
Perimetrale
Per accedere alla pagina Notifiche utilizzando l'interfaccia utente Edge:
- Accedi ad apigee.com/edge.
- Seleziona Pubblica > Monetizzazione > Notifiche nella barra di navigazione a sinistra.
Viene visualizzata la pagina Notifiche.
Come evidenziato nella figura, la pagina Notifiche consente di:
- Espandi e comprimi i dettagli delle notifiche
- Modificare i dettagli delle notifiche e salvare tutte le modifiche
- Attivare o disattivare una notifica
Classic Edge (private cloud)
Per accedere alla pagina Notifiche utilizzando l'interfaccia utente classica di Edge:
- Accedi a
http://ms-ip:9000, dove ms-ip è l'indirizzo IP o il nome DNS del nodo del server di gestione. Seleziona Amministrazione > Notifiche nella barra di navigazione in alto.
La pagina Notifiche consente di:
Modifica delle notifiche
Per modificare una notifica utilizzando l'interfaccia utente:
- Accedi alla pagina Notifiche.
- Fai clic su
accanto alla notifica che vuoi modificare per espanderne i dettagli. - Modifica i campi Oggetto, Corpo e Destinatario (se disponibile) come richiesto.
Per informazioni sulle variabili che possono essere specificate all'interno di un modello di notifica, consulta la sezione Utilizzare le variabili nei modelli di notifica.
Fai riferimento alle sezioni seguenti per ulteriori informazioni sulla modifica delle notifiche in ogni categoria:
- Attiva una notifica selezionando la casella di controllo adiacente.
- Ripeti i passaggi da 2 a 4 per modificare altre notifiche.
- Fai clic su Salva per salvare tutte le modifiche.
Viene visualizzato un messaggio per confermare che le notifiche sono state salvate. L'operazione di salvataggio potrebbe richiedere alcuni minuti.
Modifica delle notifiche per inviare una notifica a tutti gli sviluppatori
Le notifiche relative ai tipi di eventi selezionati nella sezione Invia notifica a tutti gli sviluppatori vengono inviate a tutti gli sviluppatori.
L'esecuzione delle notifiche è programmata alla fine della giornata. Dopo l'invio delle notifiche, le caselle di controllo degli eventi vengono cancellate automaticamente. Devi selezionarli di nuovo per pianificare le notifiche per i tipi di eventi associati.
Nella tabella seguente sono elencate le notifiche in base ai tipi di eventi nella sezione Invia notifica a tutti gli sviluppatori. Per ulteriori informazioni, consulta la sezione Modifica delle notifiche utilizzando l'interfaccia utente.
| Tipo di evento | Trigger | Note |
|---|---|---|
| Nuovo pacchetto | È disponibile un nuovo pacchetto API |
Nell'ambito dell'aggiornamento, aggiungi il nome di ogni nuovo pacchetto (e dei prodotti al suo interno) al corpo del modello email. Puoi anche aggiungere un link al portale per gli sviluppatori o a qualsiasi altro sito web che fornisce ulteriori informazioni sulla notifica. |
| Nuovo prodotto | È disponibile un nuovo prodotto API |
Aggiungi il nome di ogni nuovo prodotto al corpo del modello email durante l'aggiornamento. Puoi anche aggiungere un link al portale per gli sviluppatori o a qualsiasi altro sito web che fornisce ulteriori informazioni sulla notifica. |
| Nuovi mercati/copertura | Sono disponibili nuovi prodotti basati su API in mercati geografici specifici |
Aggiungi il nome di ogni nuovo mercato e dei prodotti pertinenti al corpo del modello email come parte dell'aggiornamento. Puoi anche aggiungere un link al portale per gli sviluppatori o a qualsiasi altro sito web che fornisce ulteriori informazioni sulla notifica. |
Modifica delle notifiche per inviare una notifica agli sviluppatori interessati
Le notifiche relative ai tipi di eventi selezionati nella sezione Invia notifica agli sviluppatori interessati vengono inviate soltanto agli sviluppatori interessati da questi tipi di eventi. Ad esempio, se selezioni l'evento del piano tariffario rivisto, viene inviata una notifica solo agli sviluppatori che hanno accettato il piano tariffario.
La tabella riportata di seguito elenca le notifiche in base ai tipi di eventi nella sezione Invia notifiche agli sviluppatori interessati. Per ulteriori informazioni, consulta la sezione Modifica delle notifiche utilizzando l'interfaccia utente.
| Tipo di evento | Trigger | Note |
|---|---|---|
| Termini e condizioni non accettati o scaduti | È stato pubblicato un nuovo insieme di Termini e condizioni e lo sviluppatore non li ha ancora accettati. |
La notifica viene inviata 30 giorni, 7 giorni e 1 giorno prima della data di entrata in vigore dei nuovi Termini e condizioni. |
| Nuovo piano tariffario | Pubblicazione dei nuovi piani tariffari |
Se il piano tariffario è:
|
| Piano tariffario rivisto | È disponibile una versione più recente di un piano tariffario acquistato |
Verranno avvisati solo gli sviluppatori che hanno acquistato la versione corrente. La notifica consente agli sviluppatori di esaminare la nuova versione e terminare 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 inizialmente imposti la scadenza del piano tariffario, con notifiche aggiuntive inviate il 30, 7 e un giorno prima della data di scadenza. Verrà inviata una notifica solo agli sviluppatori che hanno acquistato il piano tariffario per la scadenza. |
| Piano tariffario rinnovato | L'abbonamento del piano tariffario è stato rinnovato. |
Comunica allo sviluppatore che verranno addebitate le commissioni applicabili. |
| Limite di frequenza superato | Il limite del piano tariffario è stato superato |
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 esauriti |
Il periodo di utilizzo senza costi è definito dal tuo piano tariffario freemium. |
| Documento di fatturazione pubblicato |
Sono disponibili i documenti di fatturazione dello sviluppatore, ad esempio le fatture. |
|
| Sviluppatore che si registra a un nuovo piano tariffario | Lo sviluppatore sottoscrive un nuovo piano tariffario. |
Modifica delle notifiche per inviare una notifica ai provider API
Le notifiche relative ai tipi di eventi selezionati nella sezione Notifica provider API vengono inviate al provider API specificato.
La tabella seguente elenca le notifiche in base ai tipi di eventi nella sezione Notifica provider API. Per ulteriori informazioni, consulta la sezione Modifica delle notifiche utilizzando l'interfaccia utente.
| Tipo di evento | Trigger |
|---|---|
| Registrazioni di nuovi sviluppatori |
Lo sviluppatore si è registrato per un account. |
| Lo sviluppatore aggiunge un'app |
Lo sviluppatore ha creato una nuova applicazione. |
| Registrazione sviluppatore per un nuovo piano tariffario |
Lo sviluppatore ha sottoscritto un piano tariffario. |
| Dettagli finanziari delle modifiche dello sviluppatore |
Lo sviluppatore ha modificato i dettagli finanziari, ad esempio il nome o l'indirizzo della società. |
Attivazione o disattivazione di una notifica
Per attivare o disattivare una notifica utilizzando l'interfaccia utente:
- Accedi alla pagina Notifiche.
- Abilita o disabilita una notifica selezionando o deselezionando, rispettivamente, la casella di controllo adiacente.
- Fai clic su Salva per salvare tutte le modifiche.
L'operazione di salvataggio potrebbe richiedere alcuni minuti. Viene visualizzato un messaggio per confermare che le notifiche sono state salvate.
Impostazione delle notifiche utilizzando modelli mediante l'API
Configura le notifiche utilizzando l'API, come descritto nelle sezioni seguenti.
Gestione dei modelli di notifica mediante 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
- Visualizzare un modello di notifica utilizzando l'API
- Modificare un modello di notifica utilizzando l'API
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 restituiscano 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 sarebbe:
"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 Utilizzo della variabile nei modelli di notifica.
Ad esempio, la seguente richiesta modifica il contenuto di una nuova notifica relativa a un 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
- Visualizzazione di una condizione e di un'azione di notifica utilizzando l'API
- Modificare una condizione e un'azione di notifica utilizzando l'API
- Eliminare una condizione e un'azione di notifica utilizzando l'API
Creazione di una condizione e di un'azione di notifica utilizzando l'API
Crea una condizione e un'azione di notifica che generi 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 la condizione viene raggiunta, ad esempio l'invio di un'email di notifica.
Puoi definire i dettagli della condizione di notifica specificando uno o più valori degli attributi. Consulta Proprietà di configurazione per le condizioni di notifica per un elenco di attributi. 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. Per un elenco delle azioni, consulta Proprietà di configurazione per le azioni di notifica.
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 (si tratta di
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 utilizzando 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 della 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 invii 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 | Campo 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:
|
N/A | Sì |
value |
Valore dell'attributo. |
N/A | No |
associatedCondition |
Riferimento a una condizione associata. |
N/A | No |
Proprietà di configurazione per le azioni di notifica
Quando si utilizza l'API sono disponibili le seguenti proprietà di configurazione per le azioni di notifica.
| Nome | Descrizione | Predefinito | Campo obbligatorio? |
|---|---|---|---|
actionAttribute |
Metodo utilizzato per identificare il destinatario della notifica. Il valore può essere uno o più dei seguenti:
|
N/A | Sì |
value |
Valore dell'attributo dell'azione. Se Se Se |
N/A | Sì |
templateID |
ID del modello di notifica. Nota: questa opzione non è valida se |
N/A | Sì |
postURL |
Gestore di callback per il webhook. Nota: questa opzione è obbligatoria se |
N/A | 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 seguente tabella riassume le variabili del modello 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} |
La data o l'ora in cui un limite scade o viene reimpostato. |
${LONG_PERCENT} |
Percentuale di un limite raggiunta dall'utilizzo corrente, senza simbolo %. Ad esempio, 50 |
${PERCENT} |
Percentuale di un limite raggiunto dall'utilizzo corrente, con il simbolo %. Ad esempio, 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 del 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 nel pacchetto di monetizzazione. |
${ratePlan.startDate} |
Data in cui è stato creato un piano tariffario. |
${USAGE} |
Utilizzo attuale (entrate o addebiti totali o volume). |
${USER} |
Il nome di un utente. |
Personalizzazione dell'indirizzo email per le risposte
Per la monetizzazione, è configurato un indirizzo predefinito noreply@apigee.com per l'invio di notifiche via email ad aziende e sviluppatori. Contatta l'assistenza Apigee per configurare un nome e un indirizzo di risposta personalizzati per la tua organizzazione.