Configurando a autenticação do SDK

A autenticação do SDK permite fornecer prova criptográfica (gerada no lado do servidor) para solicitações do SDK feitas em nome de usuários registrados.

Como funciona?

Depois de ativar este recurso em seu app, você pode configurar o dashboard do Braze para rejeitar quaisquer solicitações com um JSON Web Token (JWT) inválido ou ausente, que inclui:

Envio de eventos personalizados, atributos, compras e dados de sessão
Criação de novos usuários em seu espaço de trabalho no Braze
Atualização das atribuições do perfil de usuário padrão
Receber ou disparar mensagens

Agora é possível impedir que usuários registrados não autenticados usem a chave de API SDK do seu app para executar ações mal-intencionadas, como simulação de outros usuários.

Configurando a autenticação

Etapa 1: Configure seu servidor

Etapa 1.1: Gerar um par de chaves públicas/privadas

Gerar um par de chaves públicas/privadas RSA256. A chave pública será eventualmente adicionada ao dashboard da Braze, enquanto a chave privada deverá ser armazenada com segurança em seu servidor.

Recomendamos usar uma chave de RSA com 2048 bits para uso com o algoritmo RS256 JWT.

warning:

Lembre-se de manter suas chaves privadas em sigilo. Nunca exponha ou codifique sua chave privada em seu app ou site. Qualquer pessoa que conheça sua chave privada pode fazer simulação ou criar usuários em nome do seu aplicativo.

Etapa 1.2: Crie um JSON Web Token para o usuário atual

Depois de obter a chave privada, o aplicativo no lado do servidor deve usá-la para retornar um JWT ao seu app ou site para o usuário atualmente registrado.

Normalmente, essa lógica pode ser acessada em qualquer lugar em que o aplicativo normalmente solicite o perfil do usuário atual, como um endpoint de login ou em qualquer lugar em que o aplicativo atualize o perfil do usuário atual.

Ao gerar o JWT, os seguintes campos são esperados:

Cabeçalho JWT

Campo	Obrigatória	Descrição
`alg`	Sim	O algoritmo suportado é `RS256`.
`typ`	Sim	O tipo deve ser igual a `JWT`.

Carga útil do JWT

Campo	Obrigatória	Descrição
`sub`	Sim	O “assunto” deve ser igual ao ID de usuário que você forneceu ao SDK da Braze ao chamar `changeUser`
`exp`	Sim	A “expiração” de quando você deseja que esse token expire.

tip:

Para saber mais sobre os tokens da Web JSON ou para navegar pelas muitas bibliotecas de código aberto que simplificam esse processo de fazer login, consulte https://jwt.io.

Etapa 2: Configurar o SDK

Esse recurso está disponível a partir das seguintes versões do SDK:

Swift: 5.0.0+ Web: 3.3.0+ Android: 14.0.0+

note:

Para integrações de iOS, esta página detalha as etapas para a Braze Swift SDK. Para obter exemplos de uso no AppboyKit iOS SDK legado, consulte este arquivo e este arquivo.

Etapa 2.1: Ative a autenticação no SDK do Braze.

Quando essa capacitação for ativada, o SDK da Braze anexará o último JWT conhecido do usuário atual às solicitações de rede feitas aos Braze Currents.

note:

Não se preocupe, a inicialização apenas com essa opção não afetará a coleta de dados de forma alguma, até que você comece a aplicar a autenticação no dashboard do Braze.

Ao chamar initialize, defina a propriedade opcional enableSdkAuthentication como true.

import * as braze from"@braze/web-sdk";
braze.initialize("YOUR-API-KEY-HERE", {
  baseUrl: "YOUR-SDK-ENDPOINT-HERE",
  enableSdkAuthentication: true,
});

Ao configurar a instância do Braze, chame setIsSdkAuthenticationEnabled para true.

BrazeConfig.Builder brazeConfigBuilder = new BrazeConfig.Builder()
    .setIsSdkAuthenticationEnabled(true);
Braze.configure(this, brazeConfigBuilder.build());

Como alternativa, você pode adicionar <bool name="com_braze_sdk_authentication_enabled">true</bool> ao seu braze.xml.

Ao configurar a instância do Braze, chame setIsSdkAuthenticationEnabled para true.

BrazeConfig.Builder brazeConfigBuilder = BrazeConfig.Builder()
    .setIsSdkAuthenticationEnabled(true)
Braze.configure(this, brazeConfigBuilder.build())

Como alternativa, você pode adicionar <bool name="com_braze_sdk_authentication_enabled">true</bool> ao seu braze.xml.

Para ativar a autenticação do SDK, defina a propriedade configuration.api.sdkAuthentication de seu objeto BRZConfiguration como YES antes de inicializar a instância da Braze:

BRZConfiguration *configuration =
    [[BRZConfiguration alloc] initWithApiKey:@"{BRAZE_API_KEY}"
                                    endpoint:@"{BRAZE_ENDPOINT}"];
configuration.api.sdkAuthentication = YES;
Braze *braze = [[Braze alloc] initWithConfiguration:configuration];
AppDelegate.braze = braze;

Para ativar a autenticação do SDK, defina a propriedade configuration.api.sdkAuthentication de seu objeto Braze.Configuration como true ao inicializar o SDK:

let configuration = Braze.Configuration(apiKey: "{YOUR-BRAZE-API-KEY}",
                                        endpoint: "{YOUR-BRAZE-ENDPOINT}")
configuration.api.sdkAuthentication = true
let braze = Braze(configuration: configuration)
AppDelegate.braze = braze

Atualmente, a autenticação do SDK deve ser ativada como parte da inicialização do SDK no código nativo do iOS e do Android. Para ativar a autenticação do SDK no Flutter SDK, siga as integrações para iOS e Android nas outras guias. Depois que a autenticação do SDK for ativada, o restante do recurso poderá ser integrado ao Dart.

Etapa 2.2: Defina o JWT do usuário atual

Sempre que seu app chamar o método changeUser do Braze, forneça também o JWT que foi gerado no servidor.

Também é possível configurar o token para ser atualizado no meio da sessão para o usuário atual.

note:

Lembre-se de que o endereço changeUser só deve ser chamado quando a ID do usuário for realmente alterada. Você não deve usar este método como uma forma de atualizar o token de autenticação (JWT) se o ID do usuário não tiver mudado.

Forneça o JWT ao chamar changeUser:

import * as braze from "@braze/web-sdk";
braze.changeUser("NEW-USER-ID", "JWT-FROM-SERVER");