Comment créer un contact en utilisant les APIs

Cet article décrit comment conserver vos formulaires et utiliser nos APIs pour créer un contact dans Plezi

Charles Dolisy avatar
Écrit par Charles Dolisy
Mis à jour il y a plus d’une semaine

Introduction

Il est possible d’utiliser vos propres formulaires sans passer par ceux de Plezi. Il est toujours possible de raccorder vos formulaires et récupérer le fonctionnement usuel de Plezi via notre API. La manipulation associée à la création d'un webservice nécessite un léger développement au niveau : 

  • du traitement de votre formulaire existant ;

  • de la reproduction ce formulaire dans Plezi. 

Mais une fois effectué, les contacts générés par ce formulaire créerons bien des contacts dans Plezi tout en gardant l'événement de soumission du formulaire, sa source et ses données.

Dans quels cas remplacer les formulaires de Plezi ?

Cela peut s'appliquer lorsque que votre formulaire a des fonctionnalités particulières, que cela soit dans l’affichage ou le traitement des données après soumission par l’utilisateur, conditionné par des règles spécifiques que le formulaire Plezi ne pourrait reprendre. Des exemples : 

  • un formulaire de création de compte, générant un mot de passe (cf. exemple plus bas) ; 

  • un email est envoyé à un service spécifique en fonction d’un choix particulier dans le formulaire ;

  • le formulaire alimente votre CRM ou un autre système d’information de votre entreprise ;

  • l’utilisation d’un CAPTCHA ;

  • si vous avez une approche de contenus plus complexe, avec des centaines de contenus déjà mis à disposition sur votre site suite à la soumission d'un formulaire ;

  • etc. 

Quelles sont les étapes ?


1  Lire ce document : c'est un bon préalable pour savoir où trouver les identifiants nécessaires ; 

2. Créer le modèle de formulaire et l’ajouter à un contenu : cette étape est nécessaire d’un point de vue technique, mais vous permettra également de suivre toutes les statistiques de votre formulaire… comme s’il était réellement mis en ligne sur votre site à partir de Plezi. Il s'agit là de créer un formulaire reprenant exactement les champs de votre formulaire existant. Ce formulaire Plezi ne sera inséré nulle part, mais servira de "copie carbone" au formulaire existant. C'est ce formulaire "copie carbone" qui permettra à Plezi de récupérer les informations de contact générés suite à la soumission de du formulaire existant ;

Note aux développeurs en charge du set up technique qui suit : une connaissance de l'outil Plezi, et en particulier de la création des formulaires est nécessaire. Renseignez-vous auprès de la/les personnes(s) chez vous ayant suivi l'onboarding de l'outil Plezi et décidez ensemble la personne en charge de créer ce formulaire dans Plezi. Pour plus d'informations, veuillez consulter les articles de la Happy Academy sur la création d'un modèle de formulaire et sur l'ajout d'un formulaire sur un contenu

3. Configurer la requête chez vous 

Pour plus de détails techniques, rendez-vous sur la documentation API complète, préparée PAR nos développeurs, POUR les développeurs ;). 

Nous l'avons synthétisé ici : 

Descriptif technique de la requête à mettre en place

URL de la requête

Méthode de la requête

Utiliser la méthode GET

Entête de la requête

Vous devez pouvoir initier la connexion avec deux informations. A savoir :

  • Votre tenant ( via la clé : x-tenant-company )

  • Votre clé API ( via la clé : x-API-Key )

Ces informations sont disponibles dans Plezi dans : Configuration > Configuration de Plezi > Général. Dans l'URL, le tenant ID correspond à la suite de chiffres située après le dernier "/" : 

Si vous ne voyez pas l'API Key, contactez nos équipes CSM sur notre tchat.

Paramètres de la requête

Dans le cas où vous décideriez d’ajouter plus de champs dans vos formulaires, vous pouvez récupérer le nom technique du champ dans plezi en passant par configuration > Modèle de formulaires. Choisissez ensuite le formulaire qui vous intéresse, et cliquez sur le petit carré rose.

Choisissez ensuite le champ qui vous intéresse, et vous y trouverez le nom technique.

Pour les champs du type sélection multiple ou type liste déroulante, comme le champ “fonction”, il faudra penser à également récupérer les ID de chacune des valeurs de vos champs dans Plezi. 

Pour cela :

  • Rendez-vous dans Configuration > Qualification des contacts - Listes de valeurs ;

  • Choisissez votre champ dans le menu déroulant à gauche ;

  • Pour chacune des valeurs de votre champ, cliquez sur le petit carré rose et récupérez l’ID entre /setting_records/ et /edit (suite de chiffres).

Remarque : si votre liste comporte plus de 20 valeurs à récupérer, sollicitez-nous pour que nous puissions vous transmettre la liste de tous les ID des valeurs de votre champ. 

Identification du visiteur et de la visite associée

Il est nécessaire de récupérer les données dynamiquement à chaque appel du formulaire pour 

visit = qui ressemble à ce type de format => f4260c09-7f32-4c7f-b4fd-9f4fa5feb931

visitor ** = qui ressemble à ce type de format =>1497866343720459---554096f86261640006000000

Pour visitor, il faut pouvoir ne récupérer que la première partie avant le séparateur “---”.

Ce qui donne l’information suivante à récupérer : 1497866343720459

Ces données sont à récupérer à partir des cookies du visiteur, cookies générés par le script de tracking issu de l’application PLezi :

  • Aller sur votre site web & faites une inspection de la page (clique gauche ⇒ Inspect)

  • Aller sur “Application”

  • Dans la colonne “Name”, repérez “visit” et “visitor” et renseignez dynamiquement les valeurs de ces derniers

Dans la requête envoyée par votre formulaire vous devez donc avoir ces deux paramètres renseignés:

visit=f4260c09-7f32-4c7f-b4fd-9f4fa5feb931&visitor=1497866343720459

Identification de la source du visiteur

Vous pouvez récupérer et passer dans votre requête tous les paramètres supplémentaires issues de l’url source du visiteur, ce qui permettra de récupérer dans Plezi la source adéquate pour la contact. Ces paramètres sont les suivants :

  • utm / utm_medium / utm_source

  • gclid

  • referer

Exemple : formulaire de création de compte

Par exemple, lorsque vous avez un formulaire qui est à l'origine de la création d'un compte dans votre backoffice vous aurez besoin de conserver votre formulaire qui intégrera toute la logique métier propre à votre activité, mais vous aurez également besoin de faire remonter l'information dans Plezi afin de pouvoir cibler cette population. 

Pour cela, suivons les étapes suivantes :

  1. Créer un contenu de type offre intitulé "Création de compte" ;

  2. Créer un formulaire associé à ce contenu (en reprenant un modèle existant ou en créant un nouveau modèle, en créant les champs, etc.) et reproduisez le à l'identique (la fameuse "copie carbone") ;

  3. Créez la requête, en reprenant les informations nécessaires dans le script de mise en ligne du formulaire Plezi ; 

Le code de tracking indique les paramètres suivant : form_id et content_web_form_id. Ce sont ces deux paramètres qui permettront d'associer l'action au formulaire et donc de faire remonter les informations au niveau de l'historique du contact. Si des points sont associés au contenu alors ils seront comptabilisés au niveau du contact. 

<form id="foss-1234567890"></form><script src='https://app.plezi.co/scripts/ossleads_forms.js?tenant_id=1234567890&form_id=1234567890&form_version=3&content_web_form_id=1234567890'></script>

La requête via CURL serait alors de la forme ci dessous. 

4. Faites le test  : une fois la requête faite, il ne reste plus qu'à vérifier que tout fonctionne. Remplissez le formulaire de création de contact, et assurez-vous que :

  • le contact remonte bien dans Plezi, avec tous les champs renseignés, ainsi que le nombre points gagnés (si demandé lors de la création de votre contenu) ;

  • sa source est identifiée ;

  • le workflow configuré dans le formulaire "copie carbone" Plezi fonctionne : message de remerciement, envoi d'une alerte interne, envoi du message de remerciement. NB : vérifiez la configuration de formulaire déjà existant sur votre site. Si ce dernier a déjà un workflow (ex. envoi d'un email de remerciement avec login), attention à ne pas doubler ce workflow avec celui configuré dans Plezi. 

5. Informations importantes : Les statistiques des visites effectuées sur le formulaire présent sur votre site internet ne seront PAS comptabilisées sur le formulaire permettant la création du contact dans Plezi.

L'évènement de visite sur le formulaire Plezi est comptabilisé à partir du moment ou le formulaire est affiché, or dans cette situation le formulaire Plezi ne s'affiche jamais.

Par conséquent, les rapports calculés sur la base des visites sur les contenus ne pourront pas être générés (ex : rapport de conversion par contenu).

Avez-vous trouvé la réponse à votre question ?