Etapes de mise en place d’un projet via l’API d’Avizi
La mise en place du projet nécessite un certain nombre d’étapes et d’acteurs qui sont spécifiés dans le schéma ci-dessous :
Points importants :
- Tous les tests doivent être realisés sur l’environnement de démonstration dans un premier temps. Ils doivent être validés par la structure porteuse du projet. En cas de doutes, l’équipe de Proximit Tourisme se réserve le droit de réaliser des tests technique complémentaires.
- Les comptes sur l’environnement de démo et de production sont nominatifs et leurs accès ne doivent pas être divulgués. Des comptes spécifiques pour les prestataires sont créés dès la remise des accès API sur l’environnement de démonstration afin de faciliter leurs développements et leurs tests.
Déterminez vos paramétrages au préalable
Consulter les paramétrages de l’API
Depuis le menu Admin > Gestion des clés API, il vous est possible de consulter la configuration actuelle de la clé qui vous a été fournie.
Vous pourrez notamment savoir si le double opt-in est activé ou non (cf section suivante pour plus de précisions) et si la clé est bien active.
Paramétrage opt-in/pré-optin
Pour gérer les consentements concernant les préférences d’abonnements des personnes qui vous contactent via un formulaire depuis votre site web, il faut déterminer le paramétrage opt-in/pré opt-in.
Prenons exemple sur une personne qui souhaite s’abonner à vos newsletters.
Cas d’un paramétrage opt-in (Désactiver le double opt-in à oui):
- -> La personne sera automatiquement abonnée à vos newsletters.
Cas d’un paramétrage pré-opt-in (Désactiver le double opt-in à non) :
- -> La personne recevra un email indiquant ses préférences d’abonnement, elle devra alors confirmer qu’elle souhaite bien s’abonner à vos newsletters.
En fonction de votre besoin, veuillez nous faire part du paramétrage que vous souhaitez mettre en place pour votre structure.
Paramétrage des listes de diffusion
Dans le cas où vous souhaiteriez procéder à l’inscription de personnes sur des listes de diffusion, il est nécessaire d’effectuer la création de ces dernières dans l’environnement de production.
Pour cela, rendez-vous dans le menu Campagnes > Classiques, puis créez une liste de diffusion, tout en cochant bien l’option « Visible via l’API »
Lorsque que vos listes diffusions sont créées, veuillez nous contacter afin que nous réalisions le paramétrage nécessaire sur l’environnement de démo.
Paramétrage des critères Qualif+
Dans le cas ou vous souhaiteriez associer un critère Qualif+ à un formulaire, il faut au préalable déterminer le type de critère que vous souhaitez utiliser. Il en existe deux :
- des critères qualifiant des demandes
- des critères qualifiant des contacts
Vous devez au préalable les créer (ainsi que leurs modalités) depuis le menu Admin > Qualif+ afin que vos prestataires puissent les utiliser par la suite via l’API. Les créations de Qualif+ (et modalités) s’effectuent sur l’environnement de démo, ils doivent être identiques à ceux de l’environnement de production.
Il est important de faire la distinction entre les types de critères car cela à un impact sur leur utilisation via l’API, il faut aussi bien cocher le paramètre « Visible via l’API ».