Cet article suppose que vous avez déjà installé les pages hébergées via l’installation In-site.
Vous trouverez ci-dessous tous les paramètres disponibles que vous pouvez utiliser lors de l’ouverture des pages hébergées.
ProAbonoPortal.open({
business_id: 42,
segment_ref: 'eur',
customer_ref: 'cust_42',
customer_lang: 'fr',
customer_name: 'Doe inc',
customer_meta: { key1: 'value1', key2: 'value2' },
offer_ref: 'offer_1',
query: 'OBmj2AvkFGZfrsD60tPJWoICRuc9nCUhMRpRqI0JU8Y',
hash: '29d8b6e5edab22dccac0d60bd3377a2349331e314e752d6bf0731e7c3c22bc29'
});
business_id
Ce paramètre est obligatoire.
C’est l’identifiant de votre environnement, que vous pouvez trouver dans la section Intégration du backoffice ProAbono.
Notez que vous disposez d’un environnement de sandbox et d’un environnement de production ; vous aurez donc deux business_id différents.
segment_ref
Ce paramètre est obligatoire.
Chaque entreprise peut être divisée en plusieurs segments lorsque votre produit est distribué via plusieurs canaux ou lorsque vous avez différents types de clients avec des plans distincts.
Vous pouvez trouver cette référence dans la section Intégration du backoffice ProAbono.
customer_ref
Ce paramètre est optionnel mais fortement recommandé.
C’est l’identifiant partagé du client entre votre application web et ProAbono. Il doit être dérivé des identifiants de vos utilisateurs afin de garantir qu’un utilisateur correspond à un seul client.
Si un Client avec cette référence existe, les pages hébergées s’ouvriront en étant authentifiées en tant que ce client.
Si aucun Client n’existe avec cette référence, un nouveau Client sera créé.
Ouvrir les pages hébergées sans customer_ref ouvrira le portail en tant qu’utilisateur anonyme, ce qui n’est pas recommandé, car cela signifie :
- Que le client ne sera pas lié à un utilisateur dans votre application
- Si ce client souscrit, vous devrez effectuer une étape supplémentaire pour l’associer à un utilisateur dans votre application
- Si le client ferme la page en cours de souscription, vous aurez des difficultés à suivre son activité
customer_lang
Ce paramètre est optionnel et recommandé.
C’est la langue du client au format ISO 639. Définir cette langue l’enregistrera dans l’objet Client, en la remplaçant si le Client existe déjà.
Il est recommandé d’aligner la langue de votre page avec la langue des pages hébergées.
customer_name
Ce paramètre est optionnel.
C’est le nom interne du client, que vous retrouverez dans le backoffice ProAbono. Le définir l’enregistrera dans l’objet Client et le remplacera s’il existe déjà.
customer_meta
Ce paramètre est optionnel.
C’est une table clé-valeur que vous pouvez utiliser librement pour stocker des métadonnées. Elle est limitée à 4 clés et 450 caractères.
Notez que définir ce paramètre l’enregistrera dans l’objet Client et le remplacera s’il existe déjà.
offer_ref
Ce paramètre est optionnel.
Utilisez ce paramètre lorsque vous souhaitez que le client (ou l’utilisateur anonyme si aucun customer_ref n’est fourni) souscrive à une offre donnée sans afficher le catalogue.
C’est très pratique si l’offre est une offre privée, non visible dans votre catalogue public.
query
Ce paramètre est optionnel.
Il est utilisé lorsque vous devez ouvrir le portail sur une page spécifique. Le contenu du paramètre est chiffré pour éviter toute opération malveillante ou exposition de données sensibles.
Le paramètre query est généré par l’API Live lors de la création ou de la récupération d’un Client, d’un Abonnement, d’une Facture ou d’une Offre.
Voir ce tutoriel (TODO)
hash
Ce paramètre est obligatoire en production et optionnel en sandbox.
Des utilisateurs malveillants pourraient modifier le paramètre customer_ref avant l’ouverture, dans le but d’accéder aux informations personnelles d’un autre de vos clients. Cela s’appelle un vol d’identité.
Pour prévenir ces attaques, vous devez ajouter un hash de sécurité à l’appel d’ouverture. La méthode de calcul du hash est décrite dans la section Intégration du backoffice ProAbono.