Configurar notificações usando modelos de notificação

Esta é a documentação do Apigee Edge.
Acesse Documentação da Apigee X. informações

O que são modelos de notificação?

A monetização oferece um conjunto de modelos que definem o texto de amostra para vários tipos de eventos notificações. 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 novidades dos planos de preços.
• 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 ou quando um desenvolvedor se inscreve em um plano de preços.
• Notificar todos os administradores da empresa sobre um evento específico.

Como alternativa, é possível criar um webhook que define um gerenciador de callback HTTP e configurar 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.

Como editar notificações

Para editar uma notificação usando a interface:

1. Acesse a página Notificações.
2. Clique no ao lado da notificação que você quer editar para expandir os detalhes.
3. Edite os campos Assunto, Corpo e Destinatário (se disponível), 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 obter mais informações sobre a edição de notificações em cada categoria:

   • Como editar notificações para notificar todos os desenvolvedores
   • Como editar notificações para notificar os desenvolvedores afetados
   • Como editar notificações para os provedores de API Notify
4. Ative uma notificação marcando a caixa de seleção ao lado dela.
5. Repita as etapas de 2 a 4 para editar outras notificações.
6. Clique em Salvar para salvar todas as mudanças.

Uma mensagem será exibida para confirmar que as notificações foram salvas. O salvamento pode levar alguns minutos.

Como editar notificações para notificar todos os desenvolvedores

Notificações para os tipos de eventos selecionados em Notificar todos os desenvolvedores são enviadas a todos os desenvolvedores.

As notificações estão programadas para serem executadas no final do dia. Depois que as notificações for enviado, as caixas de seleção do evento serão desmarcadas automaticamente. Selecione-os novamente para programar notificações para os tipos de evento associados.

A tabela a seguir lista as notificações com base nos tipos de evento da seção Notificar todos os desenvolvedores. Para mais informações, consulte Como editar notificações usando a interface.

Como editar notificações para notificar os desenvolvedores afetados

Notificações para os tipos de eventos selecionados na seção Notificar Desenvolvedores são enviadas apenas aos desenvolvedores afetados por esses tipos de eventos. Por exemplo, se você selecionar o evento "Plano de tarifa revisado", a notificação será enviada somente para os desenvolvedores que aceitaram o plano de tarifas.

A tabela a seguir lista as notificações com base nos tipos de evento da seção "Notificar os desenvolvedores afetados". Para mais informações, consulte Como editar notificações usando a interface.

Como editar notificações para os provedores de API Notify

Notificações para os tipos de eventos selecionados no Provedor de API de notificação serão enviadas ao provedor da API especificado.

A tabela a seguir lista as notificações com base nos tipos de evento da seção Notificar o provedor da API. Para mais informações, consulte Como editar notificações usando a interface.

Como ativar ou desativar uma notificação

Para ativar ou desativar uma notificação usando a interface:

1. Acesse a página Notificações.
2. Para ativar ou desativar uma notificação, marque ou desmarque, respectivamente, a caixa de seleção ao lado da notificação.
3. Clique em Salvar para salvar todas as mudanças.

O salvamento pode levar alguns minutos. Uma mensagem será exibida para confirmar que as notificações foram salvas.

Como 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
• Como editar um modelo de notificação usando a API

Visualizar todos os modelos de notificação usando a API

Você pode emitir uma solicitação GET para listar todos os modelos de notificação fornecidos por monetização solicitação 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, veja a seguir 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

Visualize um modelo de notificação emitindo 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 com base nos 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

Editar um modelo de notificação emitindo 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, é possível incluir uma ou mais variáveis. Para mais informações, consulte Como usar variáveis na notificação de modelos.

Por exemplo, a solicitação a seguir edita o conteúdo de uma nova notificação de produto da 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 o API, conforme descrito nas seções a seguir.

• Como 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
• Como editar uma condição e ação de notificação usando a API
• Como 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 ação de notificação que resulte 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 o envio de uma e-mail de notificação).

Você define os detalhes da condição de notificação especificando um ou mais atributos e a distribuição dos valores dos dados. Para ver uma lista, consulte Propriedades de configuração das condições de notificação. de atributos. Para uma notificação de evento, a condição pode ser acionada quando um novo produto é publicadas.

Ao definir o actions, consulte o modelo de notificação aplicável. Consulte Propriedades de configuração de ações de notificação para ver 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 (esta é a 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

Veja uma condição e ação de notificação emitindo 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 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"
    } ]
    }

Como editar uma condição e ação de notificação usando a API

Edite uma condição e 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 condição de notificação. Ao emitir a solicitação, especifique no corpo dela as alterações que você quer fazer à 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:password

Como 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 das 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.

Propriedades de configuração para ações de notificação

As propriedades de configuração a seguir estão disponíveis para ações de notificação ao usar a API.

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 Spring Expression Language (SpEL), para representar valores retornados na transação objeto.

A tabela a seguir resume as variáveis do modelo de notificação mais usadas.