Skip to main content
Instale o SDK do OneSignal e faça sua primeira integração funcionar. Siga as seções em ordem para uma configuração inicial ou vá diretamente para a área necessária.
  1. Primeiros passos: encontre seu App ID e chaves de API
  2. Instalar o SDK: instale o SDK móvel ou web
  3. Usuários e identidade: identifique Usuários, gerencie Assinaturas e proteja o acesso
  4. Testar sua integração: verifique a entrega antes de ir ao ar
  5. Solução de problemas: depure problemas de entrega

Primeiros passos

Se sua equipe já tem uma conta OneSignal, peça a um administrador para convidá-lo à Organização. Caso contrário, crie uma conta para começar. Seu App OneSignal armazena dados de usuários e mensagens, incluindo o App ID e as chaves de API necessárias para a configuração do SDK. Saiba como Apps, Organizações e contas se relacionam se você gerencia vários projetos ou ambientes.

Chaves e IDs

Encontre seu App ID, chave de API REST e Organization ID para autenticação.

Instalar o SDK

Instale o SDK do OneSignal para sua plataforma.

Configuração do SDK móvel

Configuração do SDK para iOS, Android, Huawei e Amazon. Habilita notificações push, mensagens in-app e Live Activities.

Configuração do SDK web

Instalação do Web SDK e configuração de notificações push do navegador.
As seguintes plataformas também são compatíveis via nossa API REST:

Usuários e identidade

O OneSignal atribui a cada pessoa um OneSignal ID e rastreia seus dispositivos, endereços de email e números de telefone como Assinaturas. Os Usuários são anônimos até você chamar login com um External ID para identificá-los. Identificar Usuários unifica suas Assinaturas em todos os canais e dispositivos.

Usuários

Modelo de Usuário, External ID, Usuários anônimos vs. identificados e login/logout.

Assinaturas

Dispositivos, endereços de email e números de telefone que recebem suas mensagens.

Tags

Adicione propriedades personalizadas aos usuários para personalização e segmentação.

Eventos personalizados

Rastreie ações de Usuários para acionar Jornadas ou potencializar análises.

Testar sua integração

Verifique a entrega, a renderização e os deep links com Usuários de teste antes de enviar para toda a sua audiência.

Usuários de teste

Encontre e configure usuários de teste para push, email e SMS.

Solução de problemas

Comece com um log de depuração e, em seguida, use o guia da plataforma que corresponde à sua integração.

Solução de problemas móvel

Resolva problemas comuns de entrega de push, APNs e mensagens in-app.

Solução de problemas do SDK web

Corrija erros de service worker, incompatibilidades de origem e notificações que não aparecem.

Logs de depuração

Habilite o log detalhado, reproduza o problema e compartilhe os logs com o suporte.

Redefinir permissões de web push

Limpe o cache do navegador, service workers e permissões de notificação para um teste limpo.

Após a configuração

Explore casos de uso comuns e consulte métodos do SDK ou endpoints da API REST enquanto desenvolve.

Tutoriais e casos de uso

Navegue pelos guias de implementação para carrinhos abandonados, fluxos de integração, campanhas de reengajamento e mais.

Tags

Adicione propriedades personalizadas aos usuários para personalização e segmentação.

Eventos personalizados

Rastreie ações de Usuários para acionar Jornadas ou potencializar análises.

Referência de SDK móvel

Métodos, classes e event hooks para SDKs de iOS, Android e multiplataforma.

Referência de SDK web

Inicialização, gerenciamento de Usuários, métodos de Assinatura e gatilhos personalizados.

Referência de SDK de servidor

Instale e configure SDKs de servidor para Node.js, Python, Java, Go, PHP, Ruby, C# e Rust.

Visão geral da API REST

Endpoints, autenticação, limites de taxa e formatos de requisição/resposta.

Perguntas frequentes

Como identifico Usuários em vários dispositivos?

Chame OneSignal.login("your_external_id") em cada dispositivo após o usuário fazer login. O OneSignal une todas as Assinaturas com o mesmo External ID sob um único Usuário. Consulte Usuários para detalhes de implementação.

Preciso configurar a verificação de identidade?

A verificação de identidade é opcional, mas fortemente recomendada para apps em produção. Sem ela, qualquer cliente pode chamar login com um External ID arbitrário. Habilitar a verificação de identidade requer atualizar o SDK do OneSignal para usar um JWT gerado pelo servidor, evitando personificação.

Posso usar o OneSignal sem o SDK móvel ou web?

Sim. Você pode enviar email e SMS, gerenciar Usuários e acionar mensagens com a API REST ou um SDK de servidor. Os SDKs móvel e web são necessários para notificações push, mensagens in-app e identificação de Usuários no lado do cliente.

Como envio mensagens do meu servidor?

Use a API REST ou um SDK de servidor. Autentique-se com sua chave de API REST de Chaves e IDs. Nunca incorpore a chave de API REST em um cliente móvel ou web.