Introdução: Visão geral da integração
Este artigo fornece uma visão geral básica do processo de integração.

Como recurso técnico, você capacitará sua equipe integrando a Braze ao seu stack de tecnologia. A integração é dividida, em linhas gerais, em quatro etapas:
- Descoberta e planejamento: Trabalhe com sua equipe para alinhar o escopo, planejar uma estrutura para dados e campanhas e criar uma estrutura de espaço de trabalho apropriada.
- Integração: Execute seu plano integrando o SDK e a API, ativando canais de envio de mensagens e configurando a importação e exportação de dados.
- Controle de qualidade: Confirme se o loop de dados e envio de mensagens entre a plataforma Braze e seu app ou site está funcionando conforme o esperado.
- Manutenção: Depois de passar a Braze para a sua equipe de marketing, você continuará a garantir que tudo funcione sem problemas.
Reconhecemos que cada organização tem suas necessidades distintas, e a Braze foi criada para atender a uma gama diversificada de opções de personalização que podem ser adaptadas às suas necessidades específicas. Os tempos de integração variam de acordo com seu caso de uso.
Descoberta e planejamento
Durante essa fase, você trabalhará com a sua equipe para definir o escopo das tarefas de integração e garantir que todas as partes interessadas estejam alinhadas a um objetivo comum.
Sua equipe realizará o planejamento de ponta a ponta dos seus casos de uso para garantir que tudo possa ser criado conforme o esperado, com os dados corretos disponíveis para isso. Essa fase inclui o líder do projeto, o líder de CRM, a engenharia de front e back-end, os proprietários de produtos e os profissionais de marketing.
A fase de descoberta e planejamento leva, em média, cerca de seis semanas. Os líderes de engenharia podem esperar passar de 2 a 4 horas por semana durante essa fase. Os desenvolvedores que trabalham com o produto podem esperar passar de 10 a 20 horas por semana na Braze durante a fase de descoberta e planejamento.
Durante o período de integração da sua empresa, a Braze realizará sessões de visão geral técnica. Recomendamos enfaticamente que os engenheiros participem dessas sessões. As sessões de visão geral técnica oferecem a oportunidade de conversar sobre a escalabilidade da arquitetura da plataforma e ver exemplos práticos de como empresas do seu porte foram bem-sucedidas em casos de uso semelhantes.

Planejamento de campanhas
Sua equipe de CRM planejará os casos de uso de envio de mensagens que serão lançados em um futuro próximo. Isso inclui:
- Canal (por exemplo, notificações por push ou mensagens no app)
- Método de entrega (por exemplo, entrega programada ou entrega baseada em ação)
- Público-alvo
- Métricas de sucesso
Por exemplo, uma Campaign para novos clientes pode ser: um e-mail enviado diariamente às 10h para um segmento de clientes que registraram sua primeira sessão ontem. O evento de conversão (a métrica de sucesso) é o registro de uma sessão.
A integração não pode começar até que a etapa de planejamento de campanhas esteja concluída. Essa etapa determinará quais partes da Braze precisam ser configuradas durante a fase de integração.
Criação de requisitos de dados
Em seguida, sua equipe de CRM deve definir quais dados são necessários para lançar as campanhas planejadas, criando requisitos de dados.
Muitos tipos comuns de atributos de usuário, como nome, e-mail, data de nascimento, país e similares, são automaticamente rastreados após a integração do SDK da Braze. Outros tipos de dados precisarão ser definidos como dados personalizados.
Como desenvolvedor, você trabalhará com sua equipe para definir quais dados adicionais e personalizados fazem sentido rastrear. Seus dados personalizados afetarão a forma como sua base de usuários será classificada e segmentada. Você configurará uma taxonomia de eventos em todo o seu growth stack, estruturando seus dados para que sejam compatíveis com seus sistemas à medida que entram e saem da Braze.
Mantenha a nomenclatura dos dados consistente em todas as ferramentas. Por exemplo, seu data warehouse pode registrar “comprar oferta por tempo limitado” de uma maneira específica. Você precisará decidir se é necessário um evento personalizado na Braze para corresponder a esse formato.
Saiba mais sobre dados coletados automaticamente e dados personalizados.
Planejamento de personalizações
Converse com seus profissionais de marketing sobre as personalizações desejadas. Por exemplo, você deseja implementar os Content Cards padrão da Braze? Deseja ajustar ligeiramente a aparência e o comportamento para que correspondam às diretrizes da sua marca? Deseja desenvolver uma interface de usuário totalmente nova para um componente e fazer com que a Braze rastreie sua análise de dados? Diferentes níveis de personalização exigem diferentes níveis de escopo.
Como obter acesso ao dashboard
O dashboard da Braze é nossa interface de usuário na web. Os profissionais de marketing usarão o dashboard para fazer seu trabalho e criar conteúdo. Os desenvolvedores usam o dashboard para gerenciar as configurações de integração de apps, como chaves de API e credenciais de notificação por push.
O administrador da sua equipe deve adicionar você (e todos os outros membros da equipe que precisam de acesso à Braze) como usuários no seu dashboard.
Espaços de trabalho e chaves de API
O administrador da sua equipe também criará diferentes espaços de trabalho. Os espaços de trabalho agrupam seus dados — usuários, segmentos, chaves de API — em um único local. Como prática recomendada, sugerimos colocar apenas versões diferentes do mesmo app ou de apps muito semelhantes em um único espaço de trabalho.
É importante ressaltar que os espaços de trabalho fornecem chaves de API para várias plataformas (como iOS e Android). Você usará as chaves de API correlacionadas para associar os dados do SDK a um espaço de trabalho específico. Navegue até seus espaços de trabalho para acessar a chave de API de cada um de seus apps. Confira se cada chave de API tem as permissões corretas para executar o trabalho que você definiu como escopo. Consulte o artigo sobre provisionamento da API para saber mais.
É importante que você configure ambientes diferentes para desenvolvimento e produção. A configuração de um ambiente de teste evitará que você gaste dinheiro real durante a integração e o controle de qualidade. Para criar um ambiente de teste, configure um espaço de trabalho de teste e certifique-se de usar a respectiva chave de API para não preencher o espaço de trabalho de produção com dados de teste.
Integração

A Braze oferece suporte a apps iOS, apps Android, apps web e muito mais. Você também pode optar por usar um wrapper SDK multiplataforma, como o React Native ou o Unity. Normalmente, vemos os clientes se integrarem em um período de 1 a 6 semanas. Muitos clientes integraram a Braze com apenas um engenheiro, dependendo da amplitude de suas habilidades técnicas e da disponibilidade. Depende inteiramente do seu escopo específico de integração e de quanto tempo sua equipe dedica ao projeto Braze.
Você precisará de desenvolvedores que estejam familiarizados com:
- Trabalhar na camada nativa do seu app ou site
- Criação de processos para acessar nossa REST API
- Teste de integração
- Autenticação de token da web JSON
- Habilidades gerais de gerenciamento de dados
- Configuração de registros DNS
Integração com parceiros de CDP
Muitos clientes usam a integração da Braze como uma oportunidade de também se integrar a uma plataforma de dados do cliente (CDP) como parceiro de integração. A Braze oferece rastreamento e análise de dados, enquanto uma CDP pode oferecer roteamento e orquestração de dados adicionais. A Braze oferece integração perfeita com muitas CDPs, como a mParticle e o Segment.
Se estiver realizando a integração lado a lado com uma CDP, você mapeará as chamadas do SDK da sua CDP para o SDK da Braze. Essencialmente, você irá:
- Mapear chamadas de identificação para
changeUser(Android, iOS, web) e definir atributos. - Mapear chamadas de flush de dados para
requestImmediateDataFlush(Android, iOS, web). - Registrar eventos personalizados ou compras.
Exemplos de integrações entre o SDK da Braze e a CDP de sua escolha podem estar disponíveis, dependendo da plataforma que você escolheu. Para saber mais, consulte nossa lista de parceiros de tecnologia CDP.
Integração do SDK da Braze
O SDK da Braze fornece duas funcionalidades essenciais: coleta e sincroniza os dados de usuários em um perfil de usuário consolidado e alimenta os canais de envio de mensagens, como notificações por push, mensagens no app e Content Cards.
Quando estiver totalmente integrado ao seu app ou site, o SDK da Braze oferece um nível de sofisticação de marketing totalmente realizado. Se você adiar a integração do SDK da Braze, algumas das funcionalidades descritas na documentação não estarão disponíveis.
Para adicionar uma camada adicional de segurança, você pode ativar a autenticação do SDK para evitar solicitações não autorizadas ao SDK. Este recurso está disponível em todas as principais plataformas, incluindo Web, iOS, Android, React Native, Flutter, Unity, Cordova, .NET MAUI (Xamarin) e Expo.
Durante a implementação do SDK, você irá:
- Escrever o código de integração do SDK para cada plataforma à qual deseja oferecer suporte.
- Ativar os canais de envio de mensagens para cada plataforma, garantindo que o SDK da Braze rastreie os dados das interações com seus clientes por e-mail, SMS, notificações por push e outros canais.
- Criar quaisquer personalizações de componentes de UI planejadas (por exemplo, Content Cards personalizados). Para conteúdo totalmente personalizado, será necessário registrar a análise de dados, pois a coleta automática de dados do SDK não estará ciente dos seus novos componentes. Você pode padronizar essa implementação com base nos nossos componentes padrão.
Usando a API da Braze
Você usará nossa REST API para diferentes tarefas em diferentes momentos ao longo do seu tempo de uso da Braze. A API da Braze é útil para:
- Importação de dados históricos; e
- Atualizações contínuas que não são disparadas na Braze. Por exemplo, o perfil de um usuário faz upgrade para VIP sem que ele faça login em um app, portanto, a API precisa comunicar essas informações à Braze.
Comece com a API da Braze.
Ao usar a API, certifique-se de agrupar suas solicitações em lote e enviar apenas valores delta. A Braze reescreve todos os atributos que são enviados. Não atualize nenhum atributo personalizado se seu valor não tiver sido alterado.
Configuração da análise de dados do produto
A Braze tem tudo a ver com dados. Os dados na Braze são armazenados no perfil do usuário.
Os pontos de dados são uma estrutura por meio da qual você garante que está capturando os dados certos para seus profissionais de marketing, e não apenas “qualquer” dado que possa ser aspirado. Familiarize-se com os pontos de dados.
Migração de dados de usuários antigos
Você pode usar o /users/track endpoint da Braze para migrar dados históricos que foram registrados fora da Braze. Exemplos de dados comumente importados incluem tokens por push e compras anteriores. Esse endpoint pode ser usado para importações pontuais ou atualizações regulares em lote.
Também é possível importar usuários e atualizar os valores dos atributos de clientes por meio de um único upload de CSV para o dashboard. Fazer upload de CSVs pode ser útil para profissionais de marketing, enquanto nossa REST API permite maior flexibilidade.
Configuração do rastreamento de sessão
O SDK da Braze gera pontos de dados de “sessão aberta” e “sessão fechada”. O SDK da Braze também libera os dados em intervalos regulares. Consulte esses links para obter os valores padrão de rastreamento de sessão, todos os quais podem ser personalizados (Android, iOS, web).
Rastreamento de eventos personalizados, atributos e eventos de compra
Coordene-se com sua equipe para configurar o esquema de dados planejado, incluindo eventos personalizados, atributos de usuários e eventos de compra. Seu esquema de dados personalizado será inserido usando o dashboard e deve corresponder exatamente ao que foi implementado durante a integração do SDK.
Os IDs de usuário, chamados de external_ids na Braze, devem ser definidos para todos os usuários conhecidos. Eles devem ser imutáveis e acessíveis quando um usuário abre o app, permitindo o rastreamento dos seus usuários entre dispositivos e plataformas. Consulte o artigo Ciclo de vida do usuário para obter as práticas recomendadas.
Outras ferramentas
Com base no seu caso de uso, pode haver outras ferramentas que você precise configurar. Por exemplo, talvez seja necessário configurar uma ferramenta como geofences para realizar suas histórias de usuários. Descobrimos que os clientes que têm a capacidade de configurar essas ferramentas adicionais depois de concluir as etapas essenciais de integração são mais bem-sucedidos.
Controle de qualidade
Ao executar a integração, você realizará o controle de qualidade para garantir que tudo o que está sendo configurado esteja funcionando conforme o esperado. Esse controle de qualidade se divide em duas categorias gerais: ingestão de dados e canais de envio de mensagens.
Confira se os seus ambientes de produção e teste estão configurados antes de iniciar o controle de qualidade.
| Ingestão de dados de controle de qualidade | Envio de mensagens de controle de qualidade |
|---|---|
| Você realizará o controle de qualidade na forma como os dados são ingeridos, armazenados e exportados. | Você garantirá que as mensagens estão sendo enviadas corretamente aos usuários e que tudo está excelente. |
| Execute testes para confirmar que os dados estão armazenados corretamente. | Crie segmentos de usuários. |
| Confirme se os dados da sessão estão corretamente atribuídos ao espaço de trabalho pretendido na Braze. | Lance Campaigns e Canvas com sucesso. |
| Confirme se o início e o fim da sessão estão sendo registrados. | Confirme se as Campaigns corretas estão sendo exibidas para os segmentos de usuários corretos. |
| Confirme se as informações de atributos do usuário estão corretamente registradas nos perfis de usuário. | Confirme se os tokens por push estão sendo registrados corretamente. |
| Teste se os dados personalizados estão sendo registrados corretamente nos perfis de usuários. | Confirme se os tokens por push foram removidos corretamente. |
| Crie perfis de usuário anônimos. | Teste se as campanhas push estão sendo enviadas corretamente para os dispositivos e se o engajamento está registrado. |
Confirme se os perfis de usuário anônimos se tornam perfis de usuário conhecidos quando o método changeUser() é chamado. |
Teste se as mensagens no app são entregues e se as métricas são registradas. |
| Teste se os Content Cards são entregues e se as métricas são registradas. | |
| Facilite o Conteúdo conectado (por exemplo, AccuWeather). | |
| Confirme se todas as integrações de canais de envio de mensagens estão funcionando corretamente. |
Ao realizar o controle de qualidade na sua integração de SDK, use o Depurador do SDK para solucionar problemas sem ativar o registro detalhado para seu app.
Passando a Braze para os profissionais de marketing
Depois de integrar a plataforma ou o site, envolva a equipe de marketing para passar a propriedade da plataforma para eles. Esse processo é diferente em cada empresa, mas pode incluir o seguinte:
- Criação de uma lógica Liquid complexa
- Ajuda para facilitar o aquecimento de IP de e-mail
- Garantia de que outras partes interessadas entendam o tipo de dados que estão sendo rastreados
Desenvolver para o futuro
Você já herdou uma base de código e não tinha a menor ideia do que o desenvolvedor inicial estava pensando? Pior ainda, você já escreveu um código, entendeu-o completamente e depois ficou completamente perplexo quando voltou a ele um ano depois?
Durante a integração da Braze, as decisões coletivas tomadas em relação a dados, perfis de usuários, quais integrações estavam e não estavam no escopo, como as personalizações deveriam funcionar e muito mais, parecerão frescas em sua mente e, portanto, óbvias. Quando sua equipe quiser expandir a Braze ou quando outros recursos técnicos forem atribuídos ao seu projeto Braze, essas informações serão obscuras.
Crie um recurso para consolidar as informações que você aprendeu durante as sessões de visão geral técnica. Esse recurso ajudará a reduzir o tempo de integração de novos desenvolvedores que se juntam à sua equipe (ou servirá como um lembrete para você mesmo quando precisar expandir sua implementação atual da Braze).
Manutenção
Após a transferência para seus profissionais de marketing, você continuará a servir como um recurso para manutenção. Você prestará atenção às atualizações do iOS e do Android que possam afetar o SDK da Braze e garantirá que seus fornecedores terceirizados estejam atualizados.
Você fará o rastreamento das atualizações da plataforma Braze por meio do GitHub da Braze. Ocasionalmente, seu administrador também receberá e-mails sobre atualizações urgentes e correções de bugs diretamente da Braze.
Limites de taxa do SDK
Usuários ativos mensais CY 24-25, MAU universal, MAU web e MAU móvel
Para clientes que adquiriram Usuários Ativos Mensais CY 24-25, MAU Universal, MAU Web e MAU Móvel, a Braze aplica limites de taxa do lado do servidor nas solicitações de API usadas por nossos SDKs para atualizar sessões, atributos de usuário, eventos e outros dados de perfil de usuário. Isso é para garantir a estabilidade da plataforma e manter um serviço rápido e confiável.
- Os limites de taxa por hora são definidos de acordo com o tráfego esperado do SDK na sua conta, que pode corresponder ao número de usuários ativos mensais (MAU) que você adquiriu, setor, sazonalidade ou outros fatores. Quando o limite de taxa por hora é atingido, a Braze limitará as solicitações até a próxima hora.
- Todas as solicitações com limite de taxa são automaticamente reprocessadas pelo SDK.
- As solicitações do SDK estão correlacionadas com a quantidade de dados personalizados coletados na sua implementação. Se você está consistentemente perto ou no seu limite de taxa por hora, considere:
- Revisar sua integração de SDK para reduzir a coleta excessiva de dados.
- Bloquear dados personalizados que não são essenciais para seus casos de uso de marketing.
- Os limites de taxa de burst são limites de curta duração que se aplicam quando um alto volume de solicitações chega em um período muito curto (ou seja, em segundos). Você não precisa tomar medidas quando os limites de burst ocorrem, e o SDK tentará novamente em breve.
- Os limites de taxa constantes controlam o volume de solicitações sustentadas ao longo de uma janela móvel maior que a janela de burst (por exemplo, vários minutos) e ajudam a suavizar o tráfego contínuo entre os limites de burst e seu limite de taxa por hora.
Encontrando seus limites de taxa
Para encontrar os limites atuais com base na taxa de transferência esperada do SDK, acesse Configurações > APIs e identificadores > Limites de API e SDK.
Para uso histórico, acesse Configurações > APIs e identificadores > Dashboard de API e SDK.
Solicitando limites de taxa mais altos
Se você precisar de um limite de taxa mais alto na Braze, entre em contato com o suporte da Braze ou seu gerente de sucesso do cliente e inclua os seguintes detalhes:
- Se você precisa de um aumento temporário ou permanente.
- Por que você precisa do aumento.
- Quais endpoints e ambientes são afetados.
- Seu volume de tráfego aproximado e cronograma, incluindo data de início, duração e horários de pico.
- Se você pode agrupar chamadas ou distribuir o tráfego ao longo do tempo.
Após enviar sua solicitação, a Braze a revisa e atualiza você com o resultado.
Mudanças e suporte
A Braze pode modificar os limites de taxa para proteger a estabilidade do sistema ou permitir um aumento na taxa de transferência de dados na sua conta. Entre em contato com o suporte da Braze ou com seu gerente de sucesso do cliente para perguntas ou preocupações sobre limites de taxa e como eles impactam seu negócio.