Accengage Upgrade — Français

Mettez à jour vos utilisateurs Accengage vers Airship.

 Note

This content is also provided in English.

Bienvenue ! Si vous lisez cette documentation, vous êtes prêt à transférer votre audience Accengage vers Airship. Et nous sommes prêts à vous aider à atteindre cet objectif.

Une grande partie de ce processus est automatisée par Airship, mais vous devrez effectuer certaines actions de votre côté, comme la création d’un compte Airship, la configuration de votre projet sur notre interface, et l’implémentation du SDK Airship. Ce guide vous accompagnera à travers ces étapes.

Créer un compte Airship

Après avoir signé votre contrat Airship, vous devez créer un compte Airship via ce lien d’inscription.

La personne de votre entreprise qui crée ce compte sera le contact principal qui interagit avec l’équipe Airship. Typiquement, il s’agit de votre responsable marketing, chef de projet ou chef de produit.

Accès de l’équipe

Le propriétaire de votre compte peut autoriser l’accès à d’autres personnes dans Settings » Team Access. Suivez les étapes de la section Manage Messaging Team Invitations.

 Important

Votre développeur doit avoir accès à votre projet, avec un Full Access (accès complet) ou Administrator access (administrateur). Ceci est nécessaire pour compléter les étapes d’intégration.

Configuration du projet (environnement)

 Important

Chez Accengage, vous possédez un environnement unique pour chaque canal. Chez Airship, vous bénéficierez d’un seul projet auquel vous pouvez ajouter plusieurs canaux, par exemple, application, web, SMS, etc.

Vous aurez au moins deux projets pour chaque site Web: un pour les environnements Live (production) et un de Test (développement). Vous pouvez éventuellement créer des projets supplémentaires pour d’autres environnements de test ou de pré-production.

Airship créera vos projets pour vous. Si vous déplacez vos environnements mobile et/ou Web depuis Accengage à Airship :

  • Web — Airship configurera votre channel Web avec les détails de votre environnement Push Web, notamment votre URL et votre image par défaut.

     Important

    La transition Accengage vers Airship pour le push web n’est pas compatible avec Safari. Le website push ID Accengage ne pourra être utilisé sur Airship. En effet, en raison du fonctionnement du push Web sur Safari, un nouvel identifiant website push ID est nécessaire. Par conséquent, Airship ne configurera pas le support de Safari pour vous, il sera nécessaire de l’ajouter par vous-même lors de la configuration de votre canal Web.

    • Les prérequis et les étapes afin d’ajouter le push web sur Safari sont incluses dans notre documentation Web indiquée dans la section Intégrer le SDK Airship Web de cette page. Nous vous recommandons de configurer Safari lorsque vous intégrez pour la première fois le SDK Web Airship. Si vous ajoutez le web sur Safari à une date ultérieure, vous devez mettre à jour votre site web avec les nouveaux fichiers de configuration. (Chaque fois que vous modifiez la configuration de votre canal web, vous devez mettre à jour votre site web avec les nouveaux fichiers de configuration).

    • Vous pouvez envoyer des messages à vos utilisateurs Safari existants via Accengage. En revanche, dans Airship, il sera nécessaire de créer une nouvelle audience pour les utilisateurs qui revisitent le site Web et s’optinisent à nouveau (après avoir configuré Safari dans Airship et terminé la configuration pour le Web).

  • iOS et Android — Vous devez configurer vos canaux iOS et Android. Les étapes à suivre pour ce faire sont fournies dans la section Configuration des applications.

Le propriétaire de votre compte ou un membre de l’équipe avec l’autorisation Administrator (administrateur) ou Full Access (accès complet) doit mettez à jour le secteur d’activité et la spécialisation pour votre projet dans Settings » Edit Project. Voir nos types d’industries pour des exemples.

Nous vous recommandons de lire notre Platform Overview, What Is Airship?, avant de commencer les étapes de configuration.

Configuration des applications

Le propriétaire de votre compte ou un membre de l’équipe avec l’autorisation Administrator (administrateur) ou Full Access (accès complet) doit effectuer les actions suivantes :

  1. Allez dans Settings » Quickstart Guide.

  2. Cliquez sur Add Channel   et sélectionnez les channels applications (iOS et/ou Android) que vous souhaitez gérer dans votre projet. Cliquez en dehors de la case afin de fermer cette section.

  3. Cliquez sur un channel et suivez les instructions.

  4. Configurez votre push provider:

    Dans cette étape, vous configurerez le push provider des notifications pour chacune de vos applications: APNs pour iOS, FCM pour Android. Suivez les instructions ci-dessous pour chaque OS, puis passez à Étape 5 pour installer le SDK de transition.

    iOS

    Nous recommandons d’utiliser le Token signature pour l’authentification de votre application dans Airship. Completez les étapes des deux section suivantes de notre documentation iOS afin d’enregistrer votre clef d’authentification et de configurer votre token authentification dans Airship:

    • Configuration Apple
    • Configuration Airship
       Important

      Si vous choisissez cependant d’utiliser un certificat d’authentification, vous devrez générer un nouveau certificat de push APNs pour votre application dans Airship. N’utilisez pas le même certificat que celui utilisé dans l’interface Accengage.

      Complétez les étapes des deux sections suivantes de notre documentation iOS afin de créer, exporter, et télécharger votre certificat de push Apple:

    Android

    Vous devez réutiliser le même projet et package FCM dans Airship que dans Accengage. Nous vous recommandons également d’utiliser votre server key existante.

  5. Installez le SDK Airship.

    Nous fournissons des modules dans nos SDK iOS et Android afin de vous accompagner lors de la transition d’Accengage à Airship.

  6. Envoyez une notification de test sur votre application:

  7. Mettez à jour les appels du SDK Airship qui font partie de votre intégration.

    Maintenant que vous avez installé notre SDK mobile et configuré les notifications, les fonctionnalités suivantes seront ajoutées automatiquement ou nécessiteront une adaptation minime:

    • Device ID: Les Device IDs contiendront les mêmes valeurs mais seront liés aux Channel IDs dans Airship.

    • Attributes: Tous les attributs qui existent au niveau de Accengage migreront vers Airship mais vous devrez les définir sur l’interface Airship. Voir Ajouter des attributs à votre Projet pour savoir comment.

    • Customer IDs est associé à Named Users.

    Les fonctionnalités suivantes sont disponibles dans le SDK Airship mais ne sont pas reliées directement au SDK Accengage.

 Note

Vos deep links peuvent déjà fonctionner avec le SDK Airship. Si ce n’est pas le cas, notre documention vous aidera à les paramétrer. Voir les liens de la documentation iOS et Android à l’étape 7 ci-dessus.

Après l’implementation

Après avoir configuré votre Application avec Airship :

  1. Continuez à utiliser Accengage afin d’envoyer des notifications à votre base complète pendant ~30 jours. Vous pourrez envoyer des notifications aux utilisateurs ayant ou non mis à jour l’application, ainsi que tous les nouveaux utilisateurs qui se seront enregistrés via le SDK Airship depuis que celui-ci a été intégré à votre application. Si vous utilisez la fonction In-App d’Accengage, nous recommandons de créer un message in-app encourageant vos utilisateurs à mettre à jour leur application.

  2. Après ~30 jours, lorsque la plupart ou la totalité de votre base d’utilisateurs actifs aura mis à jour son application, commencez à utiliser exclusivement l’interface Airship pour toutes vos notifications.

 Note

Il n’est pas possible de garantir que chaque utilisateur migrera d’Accengage à Airship au cours de ce processus. Une différence de profils enregistrés peut être observé en raison d’utilisateurs inactifs, d’enregistrement obsolètes (nouveaux appareils enregistrés) ou d’appareils d’utilisateurs hors ligne pendant une période prolongée, etc.

Pendant cette période de 30 jours, les données contenus dans les rapport de statistiques sont affectées selon la provenance du message (Accengage ou Airship) et si l’utilisateur a mis à jour son application :

  • Si vous utilisez Accengage, le message est envoyé à tous les utilisateurs.
    • Pour les utilisateurs non mis à jour, un rapport complet (envoi + ouverture) est disponible sur l’interface Accengage.
    • Pour les utilisateurs mis à jour et qui sont désormais sur Airship, le rapport d’envoi est disponible sur Accengage et celui d’ouverture sur Airship.
    • Pour les nouveaux utilisateurs (ils ont téléchargé votre application pour la première fois après l’intégration du SDK Airship), le rapport d’envoi est disponible sur Accengage et celui d’ouverture sur Airship.
  • Si vous utilisez Airship pour envoyer vos push, votre message sera envoyé aux utilisateurs ayant migrés (ceux qui ont effectués la mise à jour de l’application et remontent désormais sur Airship) ainsi que les nouveaux utilisateurs. Le rapport complet (envoi et clic) est disponible sur Airship.

Configuration Web Push

Le propriétaire de votre compte ou un membre de l’équipe avec l’autorisation Administrator (administrateur) ou Full Access (accès complet) doit confirmez votre URL par défaut et votre image par défaut dans Settings » Channels » Web Notifications et mettez à jour toute valeur incorrecte ou obsolète. Ces champs ont été transférés du système Accengage dans le cadre du processus de mise à niveau.

Avant de commencer le processus d’implémentation, nous vous recommandons d’envoyer une notification globale à l’ensemble de votre audience via l’interface Accengage. Le but de cette étape est de s’assurer que votre base de donnée est à jour. Si vous envoyez déjà régulièrement des notifications à votre audience, vous pouvez sauter cette étape.

Les étapes de la section Intégration doivent être gérées par votre développeur Web. Il doit disposer d’un compte Airship avec Full Access (accès complet) ou Administrator access (accès administrateur) pour votre projet. Voir la section Accès de l’équipe ci-dessus.

Intégration — Utilisation propre nom de domaine

Réalisez les étapes ci-dessous si vous avez activé le paramètre utiliser mon propre nom de domaine sur la plateforme Accengage. Sinon, passez directement à la section intégration - domaine Accengage.

  1. À la racine de votre site web, supprimez uniquement le fichier acc_ww.js. Ne supprimez pas le Service Worker Accengage (acc_sw.js).

  2. Supprimez le snippet JavaScript Accengage de chaque page de votre site Web.

    Snippet JavaScript d’Accengage
        <script>
        (function(l,o,a,d,i,n,g,w,e,b){
        g='AccengageWebSDKObject';w='script';l[g]=l[g]||{};l[g][n]=d;
        l[d]=l[d]||[];l[d].p={'date':1*new Date(),'window':l,'document':o,'params':a};
        e=o.createElement(w);b=o.getElementsByTagName(w)[0];e.async=1;
        e.src='https://'+n+i+'/init.js';b.parentNode.insertBefore(e,b);
        })(window,document,{},'ACC','/pushweb/assets','customer-by.accengage.net');
        </script>
        

    Note: Dans les anciennes intégrations Accengage, nous nous appuyions sur un fichier manifest.json afin de stocker le sender ID GCM. Ce fichier n’est plus nécessaire puisque nous utilisons désormais le protocole VAPID web push.

    Vous pouvez supprimer en toute sécurité la ligne <link rel="manifest" href="/manifest.json"> ainsi que le fichier manifest.json si vous n’utilisez pas ce fichier pour d’autres usages.

  3. Connectez-vous à l’interface Airship, go.airship.eu.

  4. Ouvrez votre projet et allez dans Settings » Channels » Web Notifications » Accengage Upgrade.

  5. Cliquez sur Start Upgrade et cliquez sur Yes.

Après avoir cliqué sur Yes, le message suivant s’affiche “Do not cancel upgrade unless you’re instructed to by Airship” (“N’annulez pas la mise à jour à moins d’y être invité par Airship”). Vous êtes maintenant prêt à intégrer le SDK Web Airship dans votre site Web.

Intégrer le SDK Airship Web

  1. Configurez votre canal Web et ajoutez Safari si nécessaire; Vous trouverez toutes les informations sur ce sujet dans la Configuration du projet (environnement) ci-dessus. Lors de la dernière étape, vous devrez télécharger le SDK bundle.

  2. Remplacer le contenu du fichier acc_sw.js d’Accengage par le contenu du fichier push-worker.js d’Airship.

  3. Si vous avez besoin de combiner le push worker avec un service worker existant, il sera nécessaire de spécifier un nouvel emplacement pour votre dossier. Vous pouvez le faire en ajoutant une workerUrl: "/acc_sw.js", en le plaçant dans le on-page snippet de votre service worker ainsi que dans le secure-bridge.html si vous en utilisez un.

  4. Implémentez le SDK Airship en suivant les étapes dans Web: Getting Started.

Intégration — Domaines Accengage

Réalisez les étapes ci-dessous si vous utilisez un domaine hébergé par Accengage (maintenant Airship) pour enregistrer (optin) vos utilisateurs web. Sinon, suivez les étapes de la section intégration - utilisation propre nom de domaine.

Initiate Upgrade

  1. Supprimez le snippet JavaScript Accengage de chaque page de votre site Web.

    Snippet JavaScript d’Accengage
        <script>
        (function(l,o,a,d,i,n,g,w,e,b){
        g='AccengageWebSDKObject';w='script';l[g]=l[g]||{};l[g][n]=d;
        l[d]=l[d]||[];l[d].p={'date':1*new Date(),'window':l,'document':o,'params':a};
        e=o.createElement(w);b=o.getElementsByTagName(w)[0];e.async=1;
        e.src='https://'+n+i+'/init.js';b.parentNode.insertBefore(e,b);
        })(window,document,{},'ACC','/pushweb/assets','customer-by.accengage.net');
        </script>
        
  2. Connectez-vous à l’interface Airship, go.airship.eu.

  3. Ouvrez votre projet et allez dans Settings » Channels » Web Notifications » Accengage Upgrade.

  4. Cliquez sur Start Upgrade et cliquez sur Yes.

Après avoir cliqué sur Yes, le message suivant s’affiche “Do not cancel upgrade unless you’re instructed to by Airship” (“N’annulez pas la mise à jour à moins d’y être invité par Airship”). Vous êtes maintenant prêt à intégrer le SDK Web Airship dans votre site Web.

Intégrer le SDK Airship Web

Avant de commencer l’implémentation du SDK Web Airship, il est nécessaire de lire le Secure Bridge/Gestion des Opt-in multi-domaines.

  1. Configurez votre canal Web et ajoutez Safari si nécessaire; Vous trouverez toutes les informations sur ce sujet dans la Configuration du projet (environnement) ci-dessus. Lors de la dernière étape, vous devrez télécharger le SDK bundle.

  2. Si vous avez besoin de combiner le push worker avec un service worker existant, il sera nécessaire de spécifier un nouvel emplacement pour votre dossier. Vous pouvez le faire en ajoutant une workerUrl: "/acc_sw.js", en le plaçant dans le on-page snippet de votre service worker ainsi que dans le secure-bridge.html si vous en utilisez un.

  3. Implémentez le SDK Airship en suivant les étapes dans Web: Getting Started.

Secure Bridge/Gestion des Opt-in multi-domaines

Si vous avez utilisé un domaine hébergé chez Accengage afin de collecter vos opt-in Web et que vous souhaitez également utiliser le SDK Airship sur votre propre site Web, consultez les instructions dans la section Web: Getting Started. Cette configuration vous permet par exemple de demander l’approbation de l’utilisateur avant de le rediriger vers le domaine d’enregistrement. Si vous utilisez votre propre domaine HTTPS pour enregistrer les utilisateurs Web (opt-in), la section Secure Bridge n’est pas nécessaire.

 Note

Dans Airship, le nom de domaine Maître est connu sous le nom de Registration domain et vos domaines enregistrés sont vos allowed domains.

  1. Lors de la configuration de votre canal Web dans Settings » Channels » Web Notifications, activez Secure Bridge. Par défaut, le secure bridge communique uniquement avec la version non HTTPS du domaine d’enregistrement. Si vous avez besoin d’utiliser le secure bridge avec d’autres domaines, entrez ces domaines dans la zone Allowed Domains.

    Lorsque vous sélectionnez l’option Secure Bridge, votre SDK comprend un fichier secure-bridge.html. Ce fichier doit être placé sur votre domaine d’enregistrement.

  2. Placez l’extrait JavaScript (contenu dans le fichier snippet.html) sur chaque domaine autorisé sur lequel vous voulez afficher la pop-up de demande d’opt-in aux visiteurs de votre site Web.

  3. Assurez-vous que les champs registrationDomain et secureBridgePath sont spécifiés pour tous les domaines autorisés sur lesquels vous souhaitez inviter les utilisateurs. La propriété registrationDomain doit être un nom de domaine accessible via HTTPS, mais il doit être spécifié dans la configuration sans le préfixe https. Exemples :

        “airship.com”, “www.mydomain.com”, “mysubdomain.domain.com”
        

    Lors de la spécification d’un domaine d’enregistrement, appeler sdk.register() échouera s’il n’est pas exécuté sur ce domaine d’enregistrement spécifié. La demande retournée sera rejetée avec le message “Domain is not allowed for registration”.

Multiple Domaines d’Enregistrement

Certains clients utilisent un domaine hébergé par Accengage afin de pouvoir procéder à l’optinisation des utilisateurs sur des sites web non sécurisés (non-https). Par exemple, Acme Corp peut utiliser le domaine acme-corp-by.accengage.net sur son site web acme-corp.com afin de procéder à l’optinisation des utilisateurs.

Pour migrer vers Airship avec ce scenario, il vous faudra vous assurer que les étapes suivantes sont correctement réalisées:

  1. Pour tout nouvel opt-in, vous utiliserez votre propre nom de domaine, en utilisant le secure bridge si nécessaire.
  2. Les utilisateurs déjà opt-in pourront être reconnu que ce soit en HTTP ou HTTPS en utilisant les paramètres décrits plus bas. De cette façon, tous vos utilisateurs préalablement optinisés sur votre-site.com ou votre-societe-by.accengage.net recevront vos notifications.
 Note

Si vous souhaitez procéder à l’optin de vos utilisateur sur différents sites web / URLs, utilisez le secure bridge en combinaison avec les paramètres registrationDomain et allowedDomains.

Si vous utilisez ou avez déjà utilisé dans le passé un nom de domaine hébergé par Accengage pour optiniser vos utilisateurs, il est impératif de configurer le secure bridge avec le paramètre secureBridgeUrl égal à https://your-company-by.accengage.net/pushweb/assets/secure-bridge.html. À adapter en fonction du domaine.

Vous pouvez combiner l’utilisation des paramètres registrationDomain/allowedDomains avec le paramètre secureBridgeUrl si necessaire.

Ces éléments de configuration vous permettront de vous assurer qu’un utilisateur est optin sur un seul domaine et éviteront ainsi les doublons de profils et/ou de notifications.

Mise en place

Configurez le SDK Web Airship avec les valeurs suivantes:

  1. Renseignez la valeur de mixedRegistrationDomains à true.

  2. Renseignez la valeur de registrationDomain avec l’URL de votre site, par exemple, mon-domaine.com.

  3. allowedDomains doit contenir les domaines HTTP et HTTPS de votre site afin de permettre l’optin de vos utilisateurs sur des pages non-sécurisées.

  4. Si vous utilisiez un domaine Accengage comme “YOUR-COMPANY-by.accengage.net”, vous devez préciser la valeur de secureBridgeUrl avec par exemple, https://your-company-by.accengage.net/secure-bridge.html. Remplacer YOUR-COMPANY par votre master domain Accengage.

  5. Téléchargez push-worker.js sur votre propre nom de domaine. Aucune configuration spécifique n’est à prévoir.

 Note

Il y a 2 méthodes pour préciser la valeur finale de l’URL du secure bridge.

  • secureBridgeUrl — Permet de renseigner l’URL complète. Exemple: your-domain.com/path/to/secure-bridge.html
  • secureBridgePath — Permet de renseigner uniquement le chemin du fichier HTML. Dans ce cas, le SDK va concaténer ce chemin avec la valeur de registrationDomain pour déterminer l’URL finale. Exemple: /path/to/secure-bridge.html

Exemple de configuration pour la gestion des domaines multiples:
var config = {
    workerUrl: "/push-worker.js",
    registrationDomain: "your-domain.com",
    mixedRegistrationDomains: true,
    secureBridgeUrl: 'https://your-domain.com/path/to/secure-bridge.html',
    allowedDomains: [
        'http://your-domain.com'
        'https://your-domain.com'
    ]
};

La configuration serveur des domaines Accengage est totalement transparente car gérée par les équipes d’Airship.

Après l’intégration

Une fois que votre développeur web a terminé les étapes d’intégration du SDK :

  1. Assurez-vous que personne dans votre organisation ne tente d’envoyer des notifications, que ce soit depuis Accengage ou Airship, pendant 24 heures. La période d’attente de 24 heures est obligatoire en raison du fonctionnement des services workers.

  2. Après 24 heures à compter du moment où votre développeur Web a finalisé les étapes d’intégration du SDK, envoyez une notification à l’ensemble de votre audience à partir de l’interface Accengage. Il doit s’agir d’une notification diffusée à tous les utilisateurs. Tout utilisateur final qui reçoit la notification de push sera transféré sur Airship sans avoir à visiter votre site Web et sans avoir à accepter à nouveau les notifications. Les appareils doivent être en ligne pour recevoir cette notification.

  3. Continuez à utiliser l’interface Accengage pour envoyer des notifications à l’ensemble de votre base pendant environ 30 jours. Vous pourrez utiliser l’interface Accengage pour envoyer des notifications aux utilisateurs non mis à jour, mis à jour et à tout nouvel utilisateur qui s’est enregistré via le SDK Airship depuis son installation.

  4. Après 30 jours, ou lorsque environ 80 % de votre base de donnée est passée sur Airship (selon la première éventualité), commencez à utiliser l’interface Airship exclusivement pour toutes les notifications Web.

 Note

Il n’est pas possible de garantir que chaque utilisateur passera d’Accengage à Airship au cours de ce processus, en raison d’utilisateurs inactifs, d’enregistrements obsolètes dus à de nouveaux appareils, ou d’appareils hors ligne pendant une période prolongée, etc.

Mapping utilisateur

Lorsqu’un utilisateur passe d’Accengage à Airship, il conserve le même identifiant unique (UUID) dans la base de données Airship. Dans Accengage, cet ID était connu sous le nom de Device ID. Dans Airship, il est connu sous le nom de Channel ID.

Si vous avez déjà associé vos Devices ID Accengage à un numéro de client ou à un autre identifiant interne à l’aide d’un champ Accengage de type “ID Client”, vous pouvez rétablir l’association aux Channels ID en utilisant les Named UsersA customer-provided identifier used for mapping multiple devices and channels to a specific individual. .

Exemple de migration des Named User

Dans cet exemple, nous allons exporter un fichier CSV contenant l’ensemble de vos profils et utiliser l'ID client de chacun en tant que nouveau Named User Airship.

 Note

Si vous utilisez cet exemple, assurez-vous de faire correspondre le device_type dans l’appel associate à la plateforme aux utilisateurs que vous migrez vers Airship. Par exemple, pour migrer vos utilisateus iOS, vous utiliseriez named_user.associate(device_id, 'ios').

  1. Téléchargez votre base cliente à partir de l’interface Accengage. Cliquez sur Ciblage »» Cibles export.

  2. Cliquez sur Exporter la base actuelle et sauvegardez le fichier.

  3. Utilisez la route d’API Named User Association afin d’associer vos ID Client Accengage vers de nouveaux Named Users Airship.

    L’exemple ci-dessous utilise la Librairie Python Airship afin de boucler sur les lignes de votre fichier CSV et d’associer chaque ID Client en tant que Named User.

    Vous pouvez également utiliser nos autres librairies pour un même résultat.

    import csv
    import urbanairship as ua

    app_key="<YOUR_APP_KEY>"
    master_secret="<YOUR_MASTER_SECRET>"

    # Créez un objet Airship

    airship = ua.Airship(app_key, master_secret)

    with open('export_xxx.csv') as migration_file:
        next(migration_file)
        accengage = csv.reader(migration_file, delimiter=';')
        for row in accengage:

            # Récupérez le "Device ID" (première colonne).
            device_id = row[0]

            # Dans cet exemple, l'ID client correspond à la dernière colonne de notre fichier CSV
            # Adaptez le code pour  utiliser la colone adéquate
            customer_id = row[-1]

            # Créez un named user et associez-y votre ID client
            named_user = ua.NamedUser(airship, customer_id)

            # Associez votre named user avec votre Channel ID (anciennement device ID).
            r = named_user.associate(device_id, 'web')

            # Affichez le resultat sur la console
            print(r, "Channel ID: ", device_id, "Named User: ", customer_id)