API - Widget : initialisation

Contexte

Le widget peut s’initialiser de deux manières, selon que vous êtes dans une Single-Page Application ou dans une page standard avec du javascript basique.

Les deux installations sont détaillées directement dans le backoffice

Dans les deux, cas, l’initialisation (ou démarrage) requiert des paramètres sous la forme d’un objet en javascript.

Exemple :

{
  business_id: 1,
  segment_ref: "seg-eur",
  customer_ref: "cust-42",
  customer_name: "John Doe",
  customer_email: "john@doe.com",
  customer_lang: "en",
}

Comportement du Widget

• Si l’utilisateur n’existe pas, il sera ajouté dans votre Business ProAbono dans le Segment spécifié.
• Si l’utilisateur existe déjà, alors son nom (customer_name:) et sa langue (customer_lang) seront mis à jour, le cas échéant.

À noter : l’adresse e-mail du client ne sera jamais mise à jour par le widget, car le client peut choisir une adresse e-mail différente pour recevoir ses factures dans le portail client.

Paramètres

Paramètre	Description	Requis ?
business_id	L’identifiant unique de votre Business. Vous pouvez le retrouver dans la section intégration de votre backoffice ProAbono.	Oui
segment_ref	La référence du Segment concerné. Vous pouvez le retrouver dans la section intégration de votre backoffice ProAbono.	Oui
customer_ref	La référence de l’utilisateur identifié. Cette référence technique est unique et a vocation à être le même identifiant technique que celui de votre système d’information.	Oui
customer_name	Le nom de l’utilisateur identifié. Le nom du client est un nom à usage interne. Ce n’est pas le nom utilisé dans l’adresse de facturation du client.	Non
customer_email	L’adresse e-mail de l’utilisateur identifié. Cette adresse e-mail est celle utilisée pour envoyer les factures au client. Elle peut être différente de l’adresse e-mail de connexion de votre utilisateur (en effet, l’utilisateur peut la modifier en autonomie depuis le portail client).	Non
customer_lang	La langue de l’utilisateur identifié. Cette langue sera celle utilisée pour les pages hébergées (présentation des offres, parcours de souscription, portail client, …).	Non
offer_ref	La référence de l’offre sélectionnée. Si vous précisez une référence d’offre, le comportement du widget sera quelque peu différent. Celui-ci s’ouvrira : - Directement sur le parcours de souscription pour cette offre en particulier si ’utilisateur n’est pas encore abonné - Sur le portail client si l’utilisateur est déjà un abonné	Non
visible	Par défaut, le widget est visible. Vous pouvez utiliser le paramètre « visible » pour créer votre propre bouton ou vos propres workflows (voir plus d’informations).	Non