Skip to content


Terminer l’intégration

Avant de suivre ces étapes, assurez-vous d’avoir intégré le SDK en utilisant Carthage, CocoaPods, le gestionnaire de paquets swift ou une intégration manuelle.

Étape 1 : Mettre à jour le délégué de votre application

Si vous intégrez le SDK Braze avec CocoaPods, Carthage ou avec une intégration manuelle dynamique, ajoutez la ligne de code suivante à votre fichier AppDelegate.m :

1

#import "Appboy-iOS-SDK/AppboyKit.h"

Si vous procédez à une intégration avec le gestionnaire de paquets swift ou à une intégration manuelle statique, utilisez cette ligne à la place :

1

#import "AppboyKit.h"

Ensuite, dans votre fichier AppDelegate.m, ajoutez l’extrait de code suivant dans votre méthode application:didFinishLaunchingWithOptions: :

1
2
3

[Appboy startWithApiKey:@"YOUR-APP-IDENTIFIER-API-KEY"
          inApplication:application
      withLaunchOptions:launchOptions];

Mettez à jour YOUR-APP-IDENTIFIER-API-KEY avec la valeur correcte depuis votre page Gérer les paramètres. Consultez notre documentation sur l’API pour savoir où trouver la clé API de votre identifiant d’application.

Si vous intégrez le SDK Braze avec CocoaPods, Carthage ou avec une intégration manuelle dynamique, ajoutez la ligne de code suivante à votre fichier AppDelegate.swift :

1

import Appboy_iOS_SDK

Si vous procédez à une intégration avec le gestionnaire de paquets swift ou à une intégration manuelle statique, utilisez cette ligne à la place :

1

import AppboyKit

Reportez-vous à la documentation des développeurs Apple pour plus d’informations sur l’utilisation du code Objective-C dans les projets Swift.

Ensuite, dans AppDelegate.swift, ajoutez l’extrait de code suivant à votre méthode application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool :

1

Appboy.start(withApiKey: "YOUR-APP-IDENTIFIER-API-KEY", in:application, withLaunchOptions:launchOptions)

Mettez à jour YOUR-APP-IDENTIFIER-API-KEY avec la valeur correcte depuis votre page Gérer les paramètres. Consultez notre documentation sur l’API pour savoir où trouver la clé API de votre identifiant d’application.

Étape 2 : Spécifier votre cluster de données

Si vous disposez d’un endpoint personnalisé préexistant :

  • À partir du SDK Braze pour iOS v3.0.2, vous pouvez définir un endpoint personnalisé à l’aide du fichier Info.plist. Ajoutez le dictionnaire Braze à votre fichier Info.plist. À l’intérieur du dictionnaire Braze, ajoutez la sous-entrée de chaîne de caractères Endpoint et définissez la valeur sur l’autorité de l’URL de votre endpoint personnalisé (par exemple, sdk.iad-01.braze.com, et non https://sdk.iad-01.braze.com). Notez qu’avant le SDK Braze pour iOS v4.0.2, la clé de dictionnaire Appboy doit être utilisée à la place de Braze.

Votre conseiller Braze devrait déjà vous avoir indiqué l’endpoint correct.

Configuration de l’endpoint à l’exécution

Si vous disposez d’un endpoint personnalisé préexistant :

  • À partir du SDK Braze pour iOS v3.17.0+, vous pouvez remplacer votre endpoint via ABKEndpointKey à l’intérieur du paramètre appboyOptions transmis à startWithApiKey:inApplication:withLaunchOptions:withAppboyOptions:. Définissez la valeur sur l’autorité de l’URL de votre endpoint personnalisé (par exemple, sdk.iad-01.braze.com, et non https://sdk.iad-01.braze.com).

Intégration SDK terminée

Braze devrait maintenant collecter des données depuis votre application et votre intégration de base devrait être terminée. Consultez les articles suivants pour activer le suivi des événements personnalisés, l’envoi de messages push et la suite complète des fonctionnalités de Braze.

Personnaliser Braze au démarrage

Si vous souhaitez personnaliser Braze au démarrage, vous pouvez utiliser la méthode d’initialisation startWithApiKey:inApplication:withLaunchOptions:withAppboyOptions: et transmettre un NSDictionary facultatif de clés de démarrage Braze.

Dans votre fichier AppDelegate.m, au sein de votre méthode application:didFinishLaunchingWithOptions:, ajoutez la méthode Braze suivante :

1
2
3
4

[Appboy startWithApiKey:@"YOUR-APP-IDENTIFIER-API-KEY"
          inApplication:application
      withLaunchOptions:launchOptions
      withAppboyOptions:appboyOptions];

Notez que cette méthode remplace la méthode d’initialisation startWithApiKey:inApplication:withLaunchOptions:.

Dans AppDelegate.swift, au sein de votre méthode application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool, ajoutez la méthode Braze suivante, où appboyOptions est un Dictionary de valeurs de configuration de démarrage :

1
2
3
4

Appboy.start(withApiKey: "YOUR-APP-IDENTIFIER-API-KEY",
                 in:application,
                 withLaunchOptions:launchOptions,
                 withAppboyOptions:appboyOptions)

Notez que cette méthode remplace la méthode d’initialisation startWithApiKey:inApplication:withLaunchOptions:.

Cette méthode est appelée avec les paramètres suivants :

  • YOUR-APP-IDENTIFIER-API-KEY – Votre clé API d’identifiant d’application depuis le tableau de bord de Braze.
  • application – L’application actuelle.
  • launchOptions – Les options NSDictionary que vous obtenez de application:didFinishLaunchingWithOptions:.
  • appboyOptions – Un NSDictionary facultatif avec les valeurs de configuration de démarrage de Braze.

Consultez Appboy.h pour obtenir la liste des clés de démarrage de Braze.

Appboy.sharedInstance() et la nullabilité Swift

Contrairement à la pratique courante, le singleton Appboy.sharedInstance() est facultatif. Cela s’explique par le fait que sharedInstance est nil avant l’appel de startWithApiKey:, et qu’il existe des implémentations non standard mais valides dans lesquelles une initialisation retardée peut être utilisée.

Si vous appelez startWithApiKey: dans votre délégué didFinishLaunchingWithOptions: avant tout accès au sharedInstance d’Appboy (l’implémentation standard), vous pouvez utiliser le chaînage optionnel, comme Appboy.sharedInstance()?.changeUser("testUser"), pour éviter des vérifications fastidieuses. Le comportement sera identique à celui d’une implémentation Objective-C qui supposait un sharedInstance non nul.

Ressources complémentaires

Une documentation complète sur les classes iOS est disponible pour fournir des conseils supplémentaires sur toutes les méthodes du SDK.
New Stuff!