Os recursos descritos nesta página exigem um plano que inclua notificações push.
O conceito básico sobre enviar notificações push para usuários individuais do seu aplicativo é o seguinte:
Neste guia, "usuário" sempre se refere a uma pessoa que tem uma conta de usuário em seu site.
- Seu usuário João abre o aplicativo.
- Seu site chama a função javascript
getNotificationTokenque retorna o token de notificação push da instância do aplicativo. - Seu site armazena o token (por exemplo, na entrada de João em seu banco de dados de usuários).
- Quando você quiser enviar uma notificação para João, você chama a webtoapp.design API com o token e nós entregaremos a notificação.
Usando a função Javascript
Recomendamos que verifique a função
executeWhenAppReady() do nosso script auxiliar de aplicação. Ele garante que seu site não tente interagir com o aplicativo antes que ele esteja pronto ou quando o site for carregado usando um navegador comum (ReferenceError, a função não está definida). Esta é a antiga implementação usada em aplicativos criados/atualizados antes de agosto de 2021.
Você precisa definir a função receivePushNotificationToken em seu site para que ela possa ser chamada pelo aplicativo. Você pode fazer isso da seguinte forma:
<script>
// this function automatically gets called by the app
function receivePushNotificationToken(token) {
// store the token (or whatever you want to do with it)
}
</script>
Coisas a ter em mente:
- O aplicativo ativará a função javascript em cada carregamento de página. É normal que você às vezes não faça nada com o token, por exemplo, quando o usuário não está logado e, portanto, você não pode armazenar o token no banco de dados do usuário.
- O aplicativo não ativará a função javascript se, por alguma razão, o aplicativo não puder determinar o token de notificação push (muito improvável, mas pode teoricamente acontecer).
- Obviamente nem todo visitante do seu site estará usando seu aplicativo, então a função não será ativada em cada carregamento de página.
Quando você quiser obter o token de notificação push de uma instância de aplicativo, basta chamar a função getNotificationToken.
<script>
try {
var token = (await getNotificationToken())["token"];
}
catch (e) {
// Can occur if:
// - the app couldn't connect to the native code. Should be very unlikely.
// - the app couldn't get the push notification token, maybe because of connection issues. Should be very unlikely.
// - push notifications are not included in your current plan
console.log(e);
}
</script>
Coisas a ter em mente:
- O token é um fio longo, por exemplo:
- O token de um usuário pode mudar,
- quando o mesmo usuário usa o aplicativo em um dispositivo diferente
- quando o aplicativo é desinstalado e reinstalado
- quando os dados do aplicativo são apagados
- Mantenha o segredo dos tokens de notificação push.
Referência de endpoint da API
Obtenha sua chave de API específica do aplicativo em seu painel do aplicativo.
Envie sua chave de API como uma consulta na URL e o corpo da solicitação no formato JSON.