Apprenez à intégrer un formulaire de consentement aux conditions de service dans une application mobile Android native à l'aide du backoffice Right Consents.
Utilisez les connaissances acquises dans les guides précédents
Créer des conditions d'utilisation à l'aide de l'application web backoffice et les utiliser dans une application mobile
Dans ce guide, vous intégrerez un formulaire de consentement nouvellement créé, y compris les conditions de service, dans une application mobile.
Ce guide couvre également certains aspects fondamentaux de la conception de la mise en page du formulaire de consentement en assemblant les éléments de votre bibliothèque de consentement de différentes manières.
Installation
Environnement Docker Fair&Smart
Assurez-vous d'avoir une pile configurée en cours d'exécution avec tous les composants nécessaires pour faire fonctionner une instance locale de Right Consents. Le tutoriel est disponible ici
Keycloak
Afin d'activer une redirection vers l'application après l'ouverture de session, vous devez modifier la configuration du client keycloak.
Tout d'abord, accédez à la configuration du client consent-manager-gui, qui se trouve à l'adresse suivante
Sur la page du client, vous verrez, dans la section Paramètres, un champ de saisie intitulé URI de redirection valides. Veillez à ajouter l'URI suivant
fs://oauthresponse*
Android Studio
Une installation à jour d'Android Studio est nécessaire pour exécuter l'application Android. Visitez le site web d'Android Studio pour terminer l'installation du logiciel.
Importer le projet dans Android Studio
Android Studio est désormais opérationnel.
La première étape consiste à télécharger le code source de l'application Android. Vous pouvez le trouver sur le dépôt des sources sur GitHub ou en exécutant la commande suivante dans votre terminal
$ git clone https://gitlab.fairandsmart.tech/opensource/manage-tos-mobile-app-guide.git
Importez le projet nouvellement téléchargé dans Android Studio, en procédant comme suit :
Cliquez sur Fichier > Nouveau > Importer un projet.
Dans la fenêtre qui s'affiche, naviguez jusqu'au répertoire racine du projet que vous souhaitez importer.
Cliquez sur OK.
Android Studio ouvre alors le projet dans une nouvelle fenêtre de l'IDE et indexe son contenu.
Créer un émulateur Android
Le projet est maintenant importé dans Android Studio. Vous aurez besoin d'un appareil virtuel, appelé émulateur, pour exécuter l'application Android localement. Quelques étapes sont nécessaires pour le créer, un tutoriel complet est disponible sur le site d'Android Studio ici.
Voici un exemple d'émulateur créé dans Android Studio :
Version du système d'exploitation : Android 11.0
Type d'appareil : Google Pixel 5
Orientation : Portrait
Configuration
Ce guide présente un cas d'utilisation sur la façon de créer des conditions d'utilisation en utilisant la plateforme communautaire Right Consents et comment les mettre en œuvre dans une application Android.
Créer des conditions de service
Pour une présentation complète du backoffice, veuillez consulter le guide de démarrage rapide.
Les conditions de service peuvent être créées en utilisant l'interface du backoffice et en initialisant un modèle de données de conditions.
Pour commencer, veuillez vous rendre sur le site web de backoffice localisé ici avec les informations d'identification suivantes :
Nom d'utilisateur : demo@demo.com
Mot de passe : demo42
Allez dans la bibliothèque Conditions générales située dans la section Configuration.
Dans la section Configuration, vous devriez pouvoir ouvrir la sous-section Conditions générales et cliquer sur le plus pour en créer une nouvelle.
Choisissez un nom et une description pertinents pour ce modèle (uniquement pour la gestion interne). Après la création du modèle, une clé est attribuée à ce modèle (conditions.001) que vous devrez utiliser ultérieurement comme référence à ce modèle. Vous pouvez ensuite remplir le contenu des données du modèle. Un seul modèle peut avoir plusieurs versions de contenu de données.
Exemple de contenu de données :
- Title: Android application Terms of Service
- Body: The following Terms of Service
Agreement (the "TOS") is a legally binding agreement that shall govern the relationship
with our users and others which may interact or interface with the Application and its services
- Behaviour: Check or Uncheck the box depending on the wanted behaviour
INFO
Pour une documentation complète sur le modèle de données des conditions d'utilisation, veuillez consulter le document sur les éléments de consentement.
Vous êtes maintenant prêt à publier cette version du modèle de conditions en cliquant sur le bouton "Enregistrer le projet", puis sur le bouton "Activer".
En activant la version, vous pourrez l'utiliser pour recueillir le consentement. Dès qu'un consentement aura été recueilli à l'aide de cette version du modèle de conditions, vous ne pourrez plus le supprimer.
Les informations relatives au cycle de vie du modèle sont visibles en haut du panneau de droite. Vous pouvez remarquer que la version 1.0 est active et qu'un numéro de série unique a été attribué à cette version particulière.
Si vous effectuez des modifications sur ce modèle, vous devrez activer la version suivante et une fenêtre contextuelle vous demandera une évolution majeure ou mineure de la version. Une évolution majeure aura pour effet de bloquer les consentements déjà recueillis dans ces conditions, tandis qu'une évolution mineure sera compatible avec les consentements déjà recueillis, mais remplacera le précédent dans la prochaine transaction de consentement générée.
Mise en œuvre
Les conditions de service sont maintenant créées, publiées et activées. Vous pouvez maintenant les utiliser dans cette application Android en quelques étapes :
Ouvrez le projet dans Android Studio
Dans l'explorateur de fichiers, localisez le fichier CmApiConfig.kt (sous app > java > com.fs.managetosmobileapp > config folder)
Insérer la clé correspondant au modèle de données des conditions d'utilisation.
object ConsentManagerConfig {
const val baseUrl = "http://10.0.2.2:4287"
const val redirectUri = "fs://tos"
const val conditionsKey = "conditions.001" <- Key of Terms of Service
}
Exécuter l'application
L'application est configurée, le contexte de consentement incluant les conditions de service nouvellement créées est implémenté. La dernière chose à faire avant de tester l'application est de démarrer l'émulateur Android Studio créé ici
Veuillez procéder comme suit :
Dans la barre d'outils, sélectionnez app dans le menu déroulant des configurations d'exécution.
Dans le menu déroulant du dispositif cible, sélectionnez le dispositif que vous avez créé.
Cliquez sur le bouton Exécuter, symbolisé par un triangle vert.
Voilà, vous avez lancé l'application localement sur votre émulateur.
Pour obtenir plus d'informations sur la façon de démarrer un émulateur avec Android studio, veuillez vous référer au site officiel.
Application
L'application est maintenant en cours d'exécution, l'environnement communautaire Right Consents est en place. Plongeons dans le flux de travail de l'application et voyons comment générer des formulaires de consentement qui incluent les conditions de service créées.
Workflow
En lançant l'application, vous initiez le processus de connexion/signature. L'application ouvrira une fenêtre web qui redirigera l'utilisateur vers le site web de Keycloak.
L'utilisateur peut :
créer un nouveau compte en utilisant ses informations personnelles
Utiliser un compte existant pour se connecter à l'application
Une fois la phase d'identification terminée, l'application vérifie si l'utilisateur connecté a déjà soumis un consentement incluant les conditions de service. Pour ce faire, elle récupère les enregistrements de l'utilisateur connecté et vérifie si la dernière valeur de consentement soumise est valide
Si l'utilisateur a déjà soumis un consentement, la page principale s'affiche (comportement normal) ; dans le cas contraire, une nouvelle vue Web non verrouillable s'ouvre et affiche la page de consentement correspondante. L'utilisateur ne pourra pas revenir à la page principale si le consentement n'a pas été soumis.
L'utilisateur peut à tout moment accéder au consentement créé précédemment pour le revoir. Une webview similaire à la précédente s'affichera.
Si le modèle de données des conditions de service est mis à jour et qu'une version majeure est publiée, le consentement sera révoqué. En conséquence, l'application affichera le formulaire de consentement à l'utilisateur. L'utilisateur ne pourra pas accéder à l'application s'il n'a pas donné son consentement.
Pour plus d'informations sur le modèle de données des conditions, veuillez consulter la section ci-dessus.
En récupérant les enregistrements des utilisateurs, l'application peut également afficher le contenu en conséquence. Si un utilisateur a accepté ou refusé les conditions d'utilisation de l'application, un message sera affiché en fonction de sa réponse. Le même comportement s'applique à tout enregistrement non pertinent ou obsolète.
Récupérer les dossiers de consentement
La dernière étape, afin d'accéder aux enregistrements de consentement créés à l'aide de l'application Android, se rend dans le Back office sous la page Intégration > Recherche.
Ici, vous pouvez accéder aux enregistrements de consentement générés par les utilisateurs et les filtrer par entrée et entrée de valeur comme suit :
Cliquez ensuite sur rechercher, une liste de consentements s'affichera dans un tableau.
A partir de là, vous pouvez exporter tous les enregistrements de consentement générés en cliquant sur le bouton d'exportation :
Un fichier .CSV sera créé, contenant toutes les informations liées à l'enregistrement du consentement de l'utilisateur (clé de l'enregistrement, valeur de l'enregistrement, adresse électronique...).