REST
Para registrar um provedor de notificação REST, execute o seguinte procedimento:
No menu lateral selecione a opção Notification Providers então selecione Register, após isso na seleção de provedores clique no logo REST API e selecione Next.
No formulário preencha as seguintes informações:
- Para preencher as informações do provedor de notificação REST API genérico os seguintes campos aceitam variáveis:
- Message Template
- URL
- Request Headers
- Request Body
- Request Parameters
- As variáveis são as seguintes:
${identifer}
: o identificador do usuário (username).${token}
: o token de autenticação.${phone}
: o telefone do usuário.${email}
: o e-mail do usuário.
- Name: Um nome de sua escolha para o provedor, exemplo:
REST API
- Timeout: O Tempo limite em segundos que o MFAO irá esperar por uma resposta do serviço de REST.
- Message Template: Esta mensagem será enviada para os usuários.
- Exemplo:
Olá ${identifier} portador do telefone ${phone} e do e-mail ${email} seu token de autenticação é: ${token}
- Exemplo:
- URL: A URL da API de notificação, exemplo:
http://api.notification-rest/notify/${identifier}
- HTTP Method: Selecione o método HTTP desejado, exemplo: POST
- Request Headers: Os headers a serem enviados na requisição, exemplo:
{"username": "identifier", "message": "${message}", "to": "${phone}"}
- Request Body: O corpo JSON enviado na requisição, exemplo:
{"username": "identifier", "message": "${message}", "to": "${phone}"}
- Request Parameters: Os parametros de URL enviados na requisição, exemplo:
{"username": "identifier", "message": "${message}", "to": "${phone}"}
- Validation: Nesta parte deverá configurar como o MFAO irá entender que a requisição ocorreu com sucesso.
- String in Body: Caso a resposta do servidor REST tenha esta string em seu conteudo.
- Status Code: Caso a resposta do servidor REST tenha este status code.
- Para preencher as informações do provedor de notificação REST API genérico os seguintes campos aceitam variáveis:
Clicar em Next
Na tela de confirmação verificar se está tudo correto e clicar em Finish