Configuration initiale du SDK

Cet article de référence explique comment installer le SDK Braze pour Flutter. Suivez ces instructions pour installer le SDK Flutter de Braze qui contient un package permettant aux intégrateurs d’utiliser les API de Braze dans des apps Flutter écrites en Dart.

Ce plug-in offre une fonctionnalité d’analytique de base et vous permet d’intégrer des messages in-app et des cartes de contenu pour iOS et Android à l’aide d’une base de code unique.

Conditions préalables

Pour terminer l’installation, vous aurez besoin de la clé API de l’identifiant d’application ainsi que de l’endpoint du SDK. Tous deux sont situés sous Gérer les paramètres dans le tableau de bord.

Avant de suivre ces étapes, installez et configurez le SDK Flutter. Assurez-vous que votre machine et votre projet utilisent les versions minimales requises de Flutter et de Dart indiquées ici.

Étape 1 : Intégrez la bibliothèque Braze

Ajoutez le kit SDK Braze pour Flutter à partir de la ligne de commande.

1
flutter pub add braze_plugin

Cela ajoutera la ligne appropriée à votre pubspec.yaml.

Étape 2 : Configuration native complète

• 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;
}

Étape 3 : Utilisation

Pour importer le plug-in dans votre code Dart, utilisez ce qui suit :

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

Ensuite, initialisez une instance du plug-in Braze en appelant new BrazePlugin() comme dans notre exemple d’application.

Testez votre intégration de base

À ce stade, vous pouvez vérifier que le SDK est intégré en vérifiant les statistiques de session dans le tableau de bord. Si vous exécutez votre application sur l’une ou l’autre plateforme, vous devriez voir une nouvelle session dans le tableau de bord (dans la section Aperçu ).

Vous pouvez ouvrir une session pour un utilisateur particulier en appelant le code suivant dans votre application.

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

Ensuite, recherchez l’utilisateur avec {some-user-id} dans le tableau de bord sous Audience > Rechercher des utilisateurs. Vous pouvez y vérifier que les données de session et d’appareil ont été enregistrées.