Configuração inicial do SDK

Este artigo de referência aborda como instalar o SDK da Braze para o Flutter. Siga estas instruções para instalar o Braze Flutter SDK que contém um pacote para permitir que os integradores usem as APIs da Braze em apps Flutter escritos em Dart.

Esse plug-in fornece a funcionalidade básica de análise de dados e permite integrar mensagens no app e cartões de conteúdo para iOS e Android com uma única base de código.

Pré-requisitos

Para concluir a instalação, você precisará da chave de API do identificador do app, bem como do endpoint do SDK. Ambas estão localizadas em Manage Settings (Gerenciar configurações ) no dashboard.

Antes de seguir estas etapas, instale e configure o Flutter SDK. Sua máquina e seu projeto devem estar executando as versões mínimas necessárias do Flutter e do Dart, notadas aqui.

Etapa 1: Integrar a biblioteca do Braze

Adicione o pacote Braze Flutter SDK a partir da linha de comando.

1
flutter pub add braze_plugin

Isso adicionará a linha adequada a pubspec.yaml.

Etapa 2: Configuração nativa completa

• android
• ios

1
2
3
4
5
<?xml version="1.0" encoding="utf-8"?>
<resources>
<string name="com_braze_api_key">YOUR_APP_IDENTIFIER_API_KEY</string>
<string translatable="false" name="com_braze_custom_endpoint">YOUR_CUSTOM_ENDPOINT_OR_CLUSTER</string>
</resources>

1
2
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

1
2
import BrazeKit
import braze_plugin

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
static var braze: Braze? = nil

func application(
  _ application: UIApplication,
  didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil
) -> Bool {
  // Setup Braze
  let configuration = Braze.Configuration(
    apiKey: "<BRAZE_API_KEY>",
    endpoint: "<BRAZE_ENDPOINT>"
  )
  // - Enable logging or customize configuration here
  configuration.logger.level = .info
  let braze = BrazePlugin.initBraze(configuration)
  AppDelegate.braze = braze

  return true
}

1
@import BrazeKit;

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
- (BOOL)application:(UIApplication *)application
    didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
  // Setup Braze
  BRZConfiguration *configuration =
      [[BRZConfiguration alloc] initWithApiKey:@"<BRAZE_API_KEY>"
                                      endpoint:@"<BRAZE_ENDPOINT>"];
  // - Enable logging or customize configuration here
  configuration.logger.level = BRZLoggerLevelInfo;
  Braze *braze = [BrazePlugin initBraze:configuration];
  AppDelegate.braze = braze;

  [self.window makeKeyAndVisible];
  return YES;
}

#pragma mark - AppDelegate.braze

static Braze *_braze = nil;

+ (Braze *)braze {
  return _braze;
}

+ (void)setBraze:(Braze *)braze {
  _braze = braze;
}

Etapa 3: Uso

Para importar o plug-in em seu código Dart, use o seguinte:

1
import 'package:braze_plugin/braze_plugin.dart';

Em seguida, inicialize uma instância do plug-in da Braze chamando new BrazePlugin() como em nosso app de amostra.

Teste sua integração básica

Nesse ponto, você pode verificar se o SDK está integrado verificando as estatísticas da sessão no dashboard. Se você executar seu aplicativo em qualquer uma das plataformas, deverá ver uma nova sessão no dashboard (na seção Visão geral ).

Você pode abrir uma sessão para um usuário específico chamando o seguinte código em seu app.

1
2
BrazePlugin braze = BrazePlugin();
braze.changeUser("{some-user-id}");

Em seguida, procure o usuário com {some-user-id} no dashboard em Público > Pesquisar usuários. Lá, é possível verificar se os dados da sessão e do dispositivo foram registrados.