API Config
  • 8 Minutes to read
  • PDF

API Config

  • PDF

Article summary

Général

Pour accéder à la configuration, il vous suffit de cliquer sur l'onglet API

Capture d’écran 2023-01-11 à 15.18.55.png

Domaine

Les premiers paramètres sont les paramètres de domaine
Vous trouvez ici votre domaine pour votre site en francais et / ou en anglais

Vous pouvez également relier les "mails systèmes" directement depuis cet onglet :

  • Mail pour réinitialisation du mot de passe : mail automatique envoyé lorsqu'un participant clique sur "mot de passe oublié" sur la plateforme
  • Mail d'activation : mail envoyé aux participants pour la 1ere connexion à la plateforme. Ce mail permet de créer le mot de passe
Mails

Il faut d'abord avoir créé les mails dans la partie mailing pour pouvoir les relier ici

image.png

Domaine

C'est votre chef de projet qui s'occupe de mettre en place le domaine dans les API

Domaines autres langues

Si votre plateforme est en une autre langue que francais ou anglais, vous ne verrez pas le domaine associé ici et ne pourrez pas relier les mails de réinitialisation de mot de passe / d'activation
Rapprochez-vous de votre chef de projets !

Code PIN & PWA

Code PIN

Lorsque votre app est encapsulée dans l'application AppCraft "Your event in the pocket", vous devez définir un PIN qui permet aux participants d'arriver sur la page login de votre app

C'est ici que vous pouvez le définir. Il peut contenir des lettres, chiffres, majuscules, miniscules...

image.png

PWA

Cette partie permet de configurer les éléments de la progressive webapp
La progressive webapp permet d'ajouter votre site sur mobile sur l'écran d'accueil comme une application, sans avoir l'étape du téléchargement sur les stores

  • Start_url : domaine de votre événement
  • Portée : slug de la page d'accueil de votre app, il s'agit généralement de "/"
  • Short_name & Name : nom qui s'affiche sur le téléphone sous l'image de la PWA lorsque l'on l'ajoute à l'écran d'accueil
  • Couleur du thème : couleur principale de votre événement
  • Couleur de fond : couleur qui va s'afficher, sur android, lors du lancement de la PWA avant d'arriver sur la login (pendant le court instant de chargement)
  • Icon : image qui s'affiche sur votre écran d'accueil pour accéder à la PWA. Format : 512x512px

image.png

Mise en place PWA

Rapprochez-vous de votre chef de projets pour le paramétrage de la PWA. D'autres paramètres sont à faire par celui-ci pour que cela soit fonctionnel

Notifications

Vous pouvez ici ajouter l'icone qui s'affichera sur le téléphone lorsque vous recevrez une notification sur la PWA

image.png

Notifications

Pour garantir la délivrabilité des notifications, notamment sur iOS, la PWA doit être encapsulée dans l'application AppCraft Your event in the pocket

Authentification

La partie authentification permet de définir le type de mot de passe pour la connexion des participants à la plateforme/PWA

Configuring API Authentication and Password Options in Appcraft - Step 2.png

Les différents types de mot de passe

Mot de passe utilisateur

Chaque participant définit son propre mot de passe
Pour cela, ils recoivent un mail avec un bouton qui les redirige vers la création de leur mot de passe
Une fois celui-ci créé, ils sont connectés
En cas de mot de passe oublié, ils peuvent s'envoyer un mail de réinitialisation de mot de passe via la page login et le bouton "mot de passe oublié"

Configuring API Authentication and Password Options in Appcraft - Step 5.png

Mot de passe utilisateur

Ce mode de connexion est le plus sécurisé

Mot de passe par défaut

Le mot de passe par défaut permet de définir un mot de passe générique, le même pour tous
A la 1ère connexion, les participants doivent se connecter avec leur adresse mail et ce mot de passe
Une fois connectés, une pop-up s'ouvre pour qu'ils puissent choisir leur propre mot de passe
En cas de mot de passe oublié, ils peuvent s'envoyer un mail de réinitialisation de mot de passe via la page login et le bouton "mot de passe oublié"

Configuring API Authentication and Password Options in Appcraft - Step 8.png

Le mot de passe par défaut voulu est à entrer dans la case en dessous de la liste déroulante du choix du type de mot de passe

Même mot de passe pour tous

Le mot de passe est le même pour tous, et le participant n'a pas la possibilité de le changer, ni de s'envoyer de mail de réinitialisation de mot de passe

Configuring API Authentication and Password Options in Appcraft - Step 11.png

Le mot de passe voulu est à entrer dans la case en dessous de la liste déroulante du choix du type de mot de passe

Mot de passe à usage unique

Ce mode de connexion est recommandé uniquement si aucun contenu sensible ou personnel n'est accessible sur votre plateforme/PWA

Mot de passe à usage unique

Le mot de passe à usage unique permet d'envoyer par mail à chaque participant un mot de passe par mail, propre à chacun.
Ce mot de passe permet de se connecter une fois, et doit ensuite être modifié par le participant.
Le mot de passe est ensuite expiré.

Mot de passe à usage unique

Pour paramétrer le mot de passe à usage unique, il faut créer un template de mail avec à l'intérieur la variable {password} qui permet de générer un mot de passe pour chaque participant.
N'hésitez pas à vous rapprocher de votre chef de projet pour les tests.

Connexion via SSO

La connexion via SSO est également possible, rapprochez-vous de votre chef de projets pour la mise en place
C'est une option non incluse de base

SEO Robot.txt

Le bouton SEO Robto.txt permet d'activer le référecement sur les navigateurs, une fois le SEO mis en place sur la plateforme/PWA

Formulaire de contact

Cette partie vous permet de définir l'adresse mail sur laquelle les mails du formulaire de contact intégré sur la plateforme seront reçu, et le template de mail

  • Email de contact : email de réception des mails des participants utilisant le formulaire de contact de la plateforme
  • Template de mail : template de mail qui sera reçu sur l'adresse mail de contact définie au dessus
  • Autoriser accès public : si votre plateforme est semi-ouverte et que la page contact est accessible sans connexion, cohez cette case pour que des personnes non connectées puissent utiliser le formulaire

image.png

Formulaire de contact

Pour que cela soit fonctionnel, il faut dans un premier temps ajouter le block "contact" sur une de vos pages sur la plateforme
Pour le template de mail, rapprochez-vous de votre chef de projets pour qu'il paramètre les bonnes variables dans ce template

Participants

Sur votre plateforme, vous pouvez intégrer une page "who is who" qui reprend la liste des participants
Sur cette page, vous pouvez afficher certaines données participants
Pour des questions de RGPD, il faut dans un premier temps, rendre public les champs que vous souhaitez faire afficher sur cette page

  • Les participants à exposer : permet de définir les participants à afficher sur la page who is who. Par exemple, vous pouvez exclure les comptes tests ou les admins, ne pas afficher les VIP...
  • Liste publique des participants : case à cocher pour définir les champs à autoriser
  • Champs publics pour les participants : vous retrouverez ici toutes les colonnes présentes dans les participants. Vous pouvez définir les champs publics, qui pourront ensuite être affichés sur la page who is who

image.png

Champs participants à afficher

Une fois vos champs rendus publics, rendez-vous sur la page who-is-who pour choisir les champs à afficher

Fermeture forcée de la plateforme

Avant l'ouverture de votre plateforme, ou parès la fermeture de celle-ci, vous pouvez forcer la fermeture de la plateforme pour que les participants n'y accèdent pas
Cependant, vous pouvez définir un mot de passe pour que certains participants (admins par exemple) puissent y accéder et voir le contenu

  • Fermeture forcée : case à cocher pour forcer la fermeture
  • Déverouiller le mot de passe : mot de passe qui permet d'y accéder
  • Utilisateurs autorisés : vous pouvez sélectionner ici, parmis tous les participants, ceux qui sont autorisés à y accéder

image.png

Accès après fermeture

Rapprochez-vous de vore chef de projet pour obtenir le lien avec le mot de passe défini forcé à l'intérieur et ainsi accéder à la plateforme
Si votre plateforme est semi-ouverte, demandez à votre chef de projet de vous expliquer comment fermer les pages non soumises à connexion

Social wall

Vous avez la possibilité de blacklister des mots et / ou des emojis sur le social wall
Les posts des participants qui essaieront de publier un message contenant un mot / emoji blacklistés ne seront pas affichés sur le social wall

Il faut entrer ici vos mots & emojis les uns en dessous des autres

image.png

Gamification

Le block gamification vous permet d'activer la gamification sur votre plateforme, si cela est prévu dans le projet

  • Activer : permet de l'activer
  • Rendre la gamification disponible à : permet de filtrer les participants qui y ont accès ou non
  • Délai de fermeture automatique de la notification : à chaque badge débloqué, celui-ci s'affiche quelques secondes sur la droite de la plateforme. Vous pouvez définir ici le temps d'affichage de celui-ci, en secondes

image.png

Gamification

Une fois la gamification activée, il faut paramétrer tous vos badges dans l'onglet gamification du backoffice

Modération sur le formulaire d'inscription

Lorsque la modération d'inscription est active, les participants peuvent tomber automatiquement en "Pending moderation". Cela signifie qu'une action d'un admin est nécessaire pour accepter ou refuser son inscription. Losqu'une de ces actions est déclenchée, vous avez la possibilité de paramétrer des mails automatique. Ces paramétrages sont donc à faire dans la section Moderation notifications Pour les activer, il vous suffira de cliquer sur le bouton à droite.

Capture d’écran 2023-01-11 à 15.21.06.png

  • Modification ==> registered : pour passer un participant en registered = yes. Vous acceptez son inscription donc il apparaitra dans la liste des participants inscrits
  • Modification ==> registered : pour refuser l'inscription d'un participant. Il sera affiché comme Refused dans la liste des participants

Lorsque vous activez ces options, vous pourrez paramétrer les mails automatiques :

  • Enabled : rendre le mail automatique effetif
  • Email template : choisir le template de mail a envoyer selon le cas de figure
    • Par exemple : pour passer un participant en registered = yes, vous pouvez réutiliser le template de confirmation d'inscription. Pour refuser un participant, vous pouvez prévoir un template spécifique.

Capture d’écran 2023-01-11 à 15.23.31.png


What's Next