Você está lendo a documentação do Apigee Edge.
Acesse a documentação da
Apigee X. info
O que são modelos de notificação?
A monetização oferece um conjunto de modelos que definem um texto de exemplo para vários tipos de notificações de eventos. Você pode personalizar qualquer um desses modelos para:
- Notifique todos os desenvolvedores sobre eventos como novos produtos, novas versões dos Termos e Condições ou novos planos de tarifas.
- Notificar os desenvolvedores afetados sobre eventos, como um plano de tarifas revisado.
- Notificar um provedor de API sobre eventos relacionados a desenvolvedores, como quando um desenvolvedor se registra para uma conta ou quando um desenvolvedor assina um plano de taxas.
- Notificar todos os administradores da empresa sobre um evento específico.
Como alternativa, crie um webhook que defina um gerenciador de callback HTTP e configure a condição que aciona o webhook, conforme descrito em Configurar notificações usando webhooks.
Como explorar a página "Notificações"
Acesse a página "Notificações", conforme descrito abaixo.
Edge
Para acessar a página "Notificações" usando a IU do Edge:
- Faça login em apigee.com/edge.
- Selecione Publicar > Monetização > Notificações na barra de navegação à esquerda.
A página "Notificações" é exibida.
Conforme destacado na figura, a página "Notificações" permite:
- Abrir e fechar detalhes da notificação
- Editar os detalhes da notificação e salvar todas as edições
- Ativar ou desativar uma notificação
Classic Edge (nuvem privada)
Para acessar a página "Notificações" usando a IU clássica do Edge:
- Faça login em
http://ms-ip:9000, em que ms-ip é o endereço IP ou o nome DNS do nó do servidor de gerenciamento. Selecione Administrador > Notificações na barra de navegação superior.
Na página "Notificações", é possível:
Notificações de edições
Para editar uma notificação usando a interface:
- Acesse a página de notificações.
- Clique em
ao lado da notificação que você quer editar para abrir os detalhes. - Edite os campos "Assunto", "Corpo" e "Destinatário" (se disponíveis) conforme necessário.
Para informações sobre variáveis que podem ser especificadas em um modelo de notificação, consulte Como usar variáveis em modelos de notificação.
Consulte as seções a seguir para mais informações sobre como editar notificações em cada categoria:
- Para ativar uma notificação, marque a caixa de seleção ao lado dela.
- Repita as etapas de 2 a 4 para editar outras notificações.
- Clique em Salvar para armazenar todas as mudanças.
Uma mensagem é exibida para confirmar que as notificações foram salvas. A operação de salvamento pode levar alguns minutos.
Edição de notificações para "Notificar todos os desenvolvedores"
As notificações dos tipos de eventos selecionados na seção Notificar todos os desenvolvedores são enviadas a todos os desenvolvedores.
As notificações são programadas para serem enviadas no fim do dia. Depois que as notificações forem enviadas, as caixas de seleção de eventos serão desmarcadas automaticamente. É preciso selecionar novamente para programar notificações para os tipos de eventos associados.
A tabela a seguir lista as notificações com base nos tipos de eventos na seção "Notificar todos os desenvolvedores". Para mais informações, consulte Editar notificações usando a interface.
| Tipo de evento | Gatilho | Observações |
|---|---|---|
| Novo pacote | Novo pacote de API disponível |
Adicione o nome de cada novo pacote (e os produtos contidos em cada um deles) ao corpo do modelo de e-mail como parte da atualização. Você também pode adicionar um link para o portal do desenvolvedor ou qualquer outro site que forneça mais informações sobre a notificação. |
| Novo produto | Novo produto de API disponível |
Adicione o nome de cada novo produto ao corpo do modelo de e-mail como parte da sua atualização. Você também pode adicionar um link para o portal do desenvolvedor ou qualquer outro site que forneça mais informações sobre a notificação. |
| Novos mercados/cobertura | Novos produtos de API estão disponíveis em mercados geográficos específicos |
Adicione o nome de cada novo mercado e os produtos relevantes ao corpo do modelo de e-mail como parte da atualização. Você também pode adicionar um link para o portal do desenvolvedor ou qualquer outro site que forneça mais informações sobre a notificação. |
Edição de notificações para avisar os desenvolvedores afetados
As notificações para os tipos de eventos selecionados na seção Notificar desenvolvedores afetados são enviadas apenas aos desenvolvedores afetados por esses tipos de eventos. Por exemplo, se você selecionar o evento "Plano de taxas revisado", uma notificação será enviada apenas aos desenvolvedores que aceitaram o plano de taxas.
A tabela a seguir lista as notificações com base nos tipos de eventos na seção "Notificar desenvolvedores afetados". Para mais informações, consulte Editar notificações usando a interface.
| Tipo de evento | Gatilho | Observações |
|---|---|---|
| Termos e Condições não aceitos ou expirados | Um novo conjunto de Termos e Condições foi publicado, mas o desenvolvedor ainda não os aceitou. |
A notificação é enviada 30 dias, 7 dias e 1 dia antes da entrada em vigor dos novos Termos e Condições. |
| Novo plano de tarifas | Novos planos de taxas são publicados |
Se o plano de tarifas for:
|
| Plano de tarifa revisado | Uma versão mais recente de um plano de taxas comprado está disponível |
Somente os desenvolvedores que compraram a versão atual vão receber uma notificação. A notificação permite que os desenvolvedores analisem a nova versão e encerrem ou troquem de plano se não quiserem aceitar as novas taxas. |
| Plano de tarifas expirado | O plano de tarifas expirou e não há um plano de tarifas de acompanhamento |
Essa notificação é enviada quando você define inicialmente o plano de tarifas para expirar, com notificações adicionais enviadas 30, 7 e 1 dia antes da data de expiração. Somente os desenvolvedores que compraram o plano de preços que vai expirar vão receber uma notificação. |
| Plano de tarifas renovado | A assinatura do plano de taxas foi renovada. |
Informar ao desenvolvedor que as taxas aplicáveis serão cobradas. |
| Limite de taxa excedido | O limite do plano de tarifas foi excedido |
Informar ao desenvolvedor que as taxas aplicáveis serão cobradas. |
| Plano de tarifas freemium esgotado | Os períodos de uso sem custo financeiro, medidos por contagem de transações ou dias, foram esgotados |
O período de uso sem custo financeiro é definido pelo seu plano de preços freemium. |
| Documento de faturamento publicado |
Os documentos de faturamento (como faturas) do desenvolvedor estão disponíveis. |
|
| O desenvolvedor se inscreve em um novo plano de taxas | O desenvolvedor se inscreve em um novo plano de tarifas. |
Edição de notificações para provedores de API de notificação
As notificações dos tipos de eventos selecionados na seção Notificar provedor de API são enviadas ao provedor de API especificado.
A tabela a seguir lista as notificações com base nos tipos de eventos na seção "Provedor da API Notify". Para mais informações, consulte Editar notificações usando a interface.
| Tipo de evento | Gatilho |
|---|---|
| Novo desenvolvedor se inscreve |
O desenvolvedor se registrou para criar uma conta. |
| O desenvolvedor adiciona um app |
O desenvolvedor criou um novo aplicativo. |
| Inscrição de desenvolvedor para um novo plano de taxas |
O desenvolvedor se inscreveu em um plano de taxas. |
| O desenvolvedor muda os detalhes financeiros |
O desenvolvedor mudou detalhes financeiros, como o nome ou o endereço da empresa. |
Ativar ou desativar uma notificação
Para ativar ou desativar uma notificação usando a interface:
- Acesse a página de notificações.
- Para ativar ou desativar uma notificação, marque ou desmarque a caixa de seleção ao lado dela.
- Clique em Salvar para armazenar todas as mudanças.
A operação de salvamento pode levar alguns minutos. Uma mensagem é exibida para confirmar que as notificações foram salvas.
Configurar notificações usando modelos com a API
Configure notificações usando a API, conforme descrito nas seções a seguir.
Como gerenciar modelos de notificação usando a API
Gerencie modelos de notificação usando a API, conforme descrito nas seções a seguir:
- Como visualizar todos os modelos de notificação usando a API
- Como visualizar um modelo de notificação usando a API
- Editar um modelo de notificação usando a API
Como visualizar todos os modelos de notificação usando a API
É possível listar todos os modelos de notificação fornecidos pela monetização enviando uma solicitação GET para /mint/organizations/{org_name}/notification-email-templates. Exemplo:
curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/notification-email-templates" \ -u email:password
Por exemplo, este é um modelo de evento que notifica os desenvolvedores sobre a disponibilidade de um novo produto de 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
}Como visualizar um modelo de notificação usando a API
Para conferir um modelo de notificação, emita uma solicitação GET para
/mint/organizations/{org_name}/notification-email-templates/{template_id},
em que {template_id} é o ID do modelo. Exemplo:
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
Os itens nos modelos que começam com $ são variáveis. Para mais informações, consulte Como usar variáveis em modelos de notificação. Suponha que as variáveis na notificação sejam avaliadas com os seguintes valores:
${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
A mensagem de notificação fornecida pelo modelo seria:
"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"Editar um modelo de notificação usando a API
Edite um modelo de notificação enviando uma solicitação PUT para
/nint/organizations/{org_name}/notification-email-templates/{template_id}.
Forneça o conteúdo alterado do modelo no corpo da solicitação.
Ao personalizar a mensagem em um modelo de notificação, você pode incluir uma ou mais variáveis. Para mais informações, consulte Usar variáveis em modelos de notificação.
Por exemplo, a solicitação a seguir edita o conteúdo de uma nova notificação de produto de 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
Como gerenciar condições e ações de notificação usando a API
Gerencie condições e ações de notificação usando a API, conforme descrito nas seções a seguir.
- Criar uma condição e uma ação de notificação usando a API
- Como visualizar uma condição e uma ação de notificação usando a API
- Editar uma condição e uma ação de notificação usando a API
- Excluir uma condição e uma ação de notificação usando a API
Como criar uma condição e uma ação de notificação usando a API
Crie uma condição e uma ação de notificação que resultem em uma notificação automática emitindo
uma solicitação POST para /mint/organizations/{org_name}/notification-conditions.
Ao fazer a solicitação, especifique no corpo da solicitação a condição que resulta na notificação e as ações a serem tomadas quando a condição for atingida (como enviar um e-mail de notificação).
Você define os detalhes da condição de notificação especificando um ou mais valores de atributo. Consulte Propriedades de configuração para condições de notificação para uma lista de atributos. Para uma notificação de evento, a condição pode ser acionada quando um novo produto é publicado.
Ao definir o actions, faça referência ao modelo de notificação aplicável. Consulte
Propriedades de configuração para ações de notificação para uma lista de ações.
Por exemplo, a solicitação a seguir especifica que, quando o atributo for
NEW_PRODUCT e o valor do atributo PUBLISHED for
true, envie a notificação no modelo com o ID
01191bf9-5fdd-45bf-8130-3f024694e63 (este é o
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
Como visualizar uma condição e uma ação de notificação usando a API
Para conferir uma condição e uma ação de notificação, emita uma solicitação GET para
organizations/{org_name}/notification-conditions/{condition_Id}, em que
{condition_Id} é o ID da condição. O ID é retornado quando você cria a
condição de notificação. Exemplo:
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
Veja a seguir um exemplo de resposta:
{
"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"
} ]
}Editar uma condição e uma ação de notificação usando a API
Edite uma condição e uma ação de notificação emitindo uma solicitação POST para
organizations/{org_name}/notification-conditions/{condition_Id}, em que
{condition_Id} é o ID da condição. O ID é retornado quando você cria a
condição de notificação. Ao emitir a solicitação, especifique no corpo dela as mudanças que você quer fazer na condição ou ação de notificação.
Exemplo:
$ 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:passwordComo excluir uma condição e uma ação de notificação usando a API
Exclua uma condição de notificação emitindo uma solicitação DELETE para
organizations/{org_name}notification-conditions/{condition_Id}. Exemplo:
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
Propriedades de configuração para condições de notificação
As seguintes propriedades de configuração para condições de notificação estão disponíveis ao usar a API.
| Nome | Descrição | Padrão | Obrigatório? |
|---|---|---|---|
attribute |
Detalhes da condição de notificação. É possível especificar um ou mais atributos para refinar a condição de notificação. O valor pode ser um ou mais dos seguintes:
|
N/A | Sim |
value |
Valor do atributo. |
N/A | Não |
associatedCondition |
Referência a uma condição associada. |
N/A | Não |
Propriedades de configuração para ações de notificação
As seguintes propriedades de configuração estão disponíveis para ações de notificação ao usar a API.
| Nome | Descrição | Padrão | Obrigatório? |
|---|---|---|---|
actionAttribute |
Método usado para identificar o destinatário da notificação. O valor pode ser um ou mais dos seguintes:
|
N/A | Sim |
value |
Valor do atributo "action". Se Se Se |
N/A | Sim |
templateID |
ID do modelo de notificação. Observação:essa opção não é válida se |
N/A | Sim |
postURL |
Gerenciador de callback para o webhook. Observação:essa opção é obrigatória se |
N/A | Sim |
Como usar variáveis em modelos de notificação
Ao editar a mensagem em um modelo de notificação, é possível incluir uma ou mais variáveis usando a linguagem de expressão Spring (SpEL) para representar valores retornados no objeto Transaction.
A tabela a seguir resume as variáveis de modelo de notificação usadas com frequência.
| Variável | Descrição |
|---|---|
${application.name} |
Nome de um aplicativo. |
${application.products.name} |
Nome de um produto incluído em um aplicativo. |
${BALANCE} |
Saldo de uma determinada cota. |
${developer.legalName} |
Nome da empresa de um desenvolvedor. |
${developer.name} |
Nome de um desenvolvedor. |
${EXPIRY_DATE} |
Data ou hora em que um limite expira ou é redefinido. |
${LONG_PERCENT} |
Porcentagem de um limite atingido pelo uso atual, sem o símbolo %. Por exemplo, 50 |
${PERCENT} |
Porcentagem de um limite atingido pelo uso atual, com o símbolo %. Por exemplo, 50%. |
${products.displayName} |
Nome de exibição definido para um produto. |
${QUOTA_TYPE} |
Tipo de limite (volume de transações, limite de gasto ou exposição a taxas). |
${QUOTA_UNIT} |
Unidade básica para um limite: moeda (para um limite de gastos) ou chamadas (para um limite de transações). |
${QUOTA_LIMIT} |
Valor de um limite. |
${ratePlan.displayName} |
Nome de exibição definido para um plano de taxa. |
${ratePlan.endDate} |
Data em que um provedor de API encerrou um plano de taxas. |
${ratePlan.monetizationPackage.displayName} |
Nome de um pacote de API. |
${ratePlan.monetizationPackage.name} |
Nome de um pacote de monetização. |
${ratePlan.monetizationPackage.products.displayName} |
Nome de exibição definido para um produto de API. |
${ratePlan.monetizationPackage.products.name} |
Nome de um produto incluído em um pacote de monetização. |
${ratePlan.startDate} |
Data de criação de um plano de preços. |
${USAGE} |
Uso atual (receita ou cobranças totais, ou volume). |
${USER} |
Nome de um usuário. |
Personalizar o endereço de e-mail para resposta
Para monetização, um endereço padrão noreply@apigee.com é configurado para ser usado em notificações por e-mail enviadas a empresas e desenvolvedores. Entre em contato com o suporte da Apigee para configurar um nome e um endereço de resposta personalizados para sua organização.