Pular para o conteúdo principal
Este guia ajuda os desenvolvedores a integrar o OneSignal em aplicativos móveis e web. Siga as seções em ordem para uma configuração inicial ou vá diretamente para a área necessária.
  1. Primeiros passos — acesse seu App OneSignal e encontre suas chaves de API
  2. Configurar canais de mensagens — instale o SDK e configure os canais
  3. Referência de SDK e API — documentação detalhada de métodos, classes e endpoints
  4. Usuários e identidade — identifique Usuários, gerencie Assinaturas e proteja o acesso
  5. Testes e depuração — verifique sua integração antes de ir ao ar
  6. Webhooks e eventos — receba eventos de mensagens no lado do servidor

​
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 é onde os dados de usuários e mensagens ficam armazenados. Cada App tem seu próprio App ID, chaves de API e canais de mensagens. Você pode ter vários Apps em uma única Organização para diferentes projetos ou ambientes.

Apps, Organizações e contas

Como Apps, Organizações e contas se relacionam entre si.

Chaves e IDs

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

Adicionar Membros da Equipe

Convide desenvolvedores e atribua funções dentro da sua Organização.

Uso e Cobrança

Cobrança, faturas e detalhes de uso.

​
Configurar canais de mensagens

Instale o SDK do OneSignal para criar e rastrear o engajamento dos usuários em suas plataformas. Cada canal de mensagens tem seu próprio guia de configuração cobrindo credenciais, inicialização do SDK e tutoriais.

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.

Push web

Instalação do Web SDK e configuração de notificações push do navegador.

Email

Configuração do canal de email e verificação do domínio do remetente.

Mensagens in-app

Exiba mensagens ricas e interativas dentro do seu aplicativo móvel.

SMS

Configuração do canal SMS e registro na operadora.

RCS

Mensagens ricas com conteúdo de marca e confirmações de leitura.

Live Activities

Atualizações dinâmicas da tela de bloqueio do iOS. Recursos semelhantes disponíveis para Android.

Prompts push móvel

Configure prompts de opt-in para coletar Assinaturas push em dispositivos móveis.

Prompts push web

Configure prompts de opt-in para coletar Assinaturas push na web.

​
Referência de SDK e API

Documentação detalhada para SDKs de cliente, SDKs de servidor e a API REST.

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.

Mensagens transacionais

Envie OTPs, recibos e alertas urgentes via API com dados personalizados.

SDKs de servidor no GitHub

Código-fonte e exemplos para todas as bibliotecas de SDK de servidor.

​
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.

Verificação de identidade

Exige JWTs gerados pelo servidor para evitar a personificação de Usuários.

Aliases

Mapeie identificadores personalizados para Usuários para rastreamento multiplataforma e integrações.

Tags

Defina dados chave-valor nos Usuários para personalização e segmentação.

Eventos personalizados

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

​
Testes e depuração

Verifique se sua integração funciona antes de enviar para toda sua audiência.
Sempre teste primeiro com Assinaturas de teste. Isso permite verificar entrega, renderização e deep links sem afetar Usuários reais.

Assinaturas de teste

Encontre e configure Assinaturas de teste para push, email e SMS.

Logs de depuração

Capture logs detalhados do SDK de aplicativos móveis para solução de problemas.

Solução de problemas móvel

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

Solução de problemas web

Corrija problemas de service worker, compatibilidade de navegador e push web.

​
Webhooks e eventos

Receba eventos de mensagens no lado do servidor para análises, automação ou sincronização com sistemas externos.

Event Streams

Transmita cliques, aberturas, recebimentos e outros eventos de mensagens para seu data warehouse em tempo real.

Webhooks de Jornada

Envie requisições HTTP para seu servidor a partir das etapas da Jornada.

Webhooks push web

Callbacks HTTP para eventos de exibição, clique e descarte de push web.

​
Perguntas frequentes

​
Como autentico requisições à API REST?

Inclua sua chave de API REST no cabeçalho Authorization como um token Bearer: Authorization: Key YOUR_REST_API_KEY. Encontre sua chave em Configurações > Chaves e IDs no painel do OneSignal. Consulte Chaves e IDs para detalhes.

​
Qual é a diferença entre SDKs de cliente e SDKs de servidor?

Os SDKs de cliente (mobile e web) são executados no seu app no dispositivo do Usuário. Eles gerenciam o registro de Assinaturas, prompts de permissão, mensagens in-app e identificação de Usuário via login. Os SDKs de servidor são executados no seu backend e chamam a API REST para enviar mensagens, gerenciar Usuários e exportar dados.

​
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.
Need help?Chat with our Support team or email support@onesignal.comPlease include:
  • Details of the issue you’re experiencing and steps to reproduce if available
  • Your OneSignal App ID
  • The External ID or Subscription ID if applicable
  • The URL to the message you tested in the OneSignal Dashboard if applicable
  • Any relevant logs or error messages
We’re happy to help!