Zone Développeur

Les Pages Hébergées sont un ensemble de pages interconnectées qui peuvent fonctionner comme une application autonome, mais dans certains cas, vous souhaitez ouvrir les pages hébergées sur une page spécifique ou démarrer un parcours client spécifique.

Voici quelques exemples :

• Après une inscription, vous devez démarrer le parcours de souscription à une offre d’abonnement donnée.
• Vous avez besoin que votre client mette à niveau l’un de ses abonnements vers un abonnement personnalisé.
• Vous devez envoyer à vos prospects un lien pour s’abonner à une offre privée.

Notez que la plupart des actions sont déjà disponibles et optimisées dans les pages hébergées du portail client, vous n’avez donc pas besoin de gérer tous les cas. Utilisez ceci uniquement si vous avez réellement besoin de parcours client dédiés dans votre application web.

Comment cela fonctionne

Les pages sont ouvertes côté client. Pour éviter d’exposer des informations sensibles, les paramètres d’ouverture sont chiffrés. Nous appelons ces paramètres chiffrés une requête.

Les requêtes sont générées dans le tableau Links par l’API Live lors de la création ou de la récupération de certains objets.

Exemple : GET /v1/Customer

{
  "Id": 1066136,
  "ReferenceCustomer": "cust-19847",
  ...
  "Links": [
    {
      "rel": "hosted-home",
      "href": "https://my-service.com/billing"
    },
    {
      "rel": "hosted-collection-offers",
      "query": "bvio5ZTZJOBmj2AvkFGZfrsD60tPJWoICRuc9nCUhMRpRqI0JU8Y0jLsRTEGncmoRshJx3GzVp8NRUuKnDsauqCU5DkAkeJmGAqI"
    },
    {
      "rel": "hosted-register",
      "query": "vkFGZfrsD60tPJWoICRuc9nCUhMRpRqI0JU8Y0jLsRTEGncmoRshJx3GzVp8NRUuEXfI9UF6VZ3w-lbfeC84f2DpMVPIuZnKOl6KA"
    }
  ]
}

Requêtes possibles

Objet	Rel	Page ouverte	Cas d’usage
Customer	hosted-collection-offers	Ouvre le parcours de catalogue, permettant au client de s’abonner.	Vous venez de créer un client, et vous l’envoyez vers le parcours de souscription. Vous voulez qu’un client s’abonne à un abonnement supplémentaire.
Customer	hosted-register	Ouvre un parcours permettant au client de renseigner ses informations de contact et son moyen de paiement.	Vous avez besoin que toutes les informations de contact et de paiement soient enregistrées et vérifiées pour facturer le client ultérieurement.
Customer	hosted-collection-upgrade	Ouvre le parcours de catalogue, permettant au client de changer son offre actuelle.	Le client souhaite mettre à niveau un abonnement donné.
Customer	hosted-subscribe	Ouvre le parcours de souscription sur l’offre spécifiée.	Vous venez de créer un client et souhaitez qu’il s’abonne à une offre spécifique.
Subscription	hosted-related-subscription	Ouvre le portail client sur l’abonnement donné.	Le client possède plusieurs abonnements, dont un nécessitant une attention immédiate.
Subscription	hosted-subscribe	Ouvre le parcours pour souscrire à l’abonnement brouillon donné.	Vous souhaitez que le client souscrive à un abonnement personnalisé que vous avez créé.
Subscription	hosted-register	Ouvre un parcours permettant au client de renseigner ses informations de contact et son moyen de paiement. Uniquement si l’abonnement a un démarrage différé.	Vous avez besoin que toutes les informations soient enregistrées et vérifiées pour facturer le client au début de l’abonnement.
Subscription	hosted-upgrade (1)	Ouvre le parcours de catalogue permettant au client de changer son offre actuelle. Uniquement si l’abonnement est actif.	Vous devez faire changer d’offre au client pour un abonnement donné.
Subscription	hosted-upgrade (2)	Vous avez fourni une offre. Ouvre le parcours de changement d’offre, permettant de remplacer l’offre actuelle par celle fournie.	Vous devez faire changer l’offre de l’abonnement donné vers l’offre spécifiée.
Subscription	hosted-upgrade (3)	Vous avez fourni un abonnement précédent. Ouvre le parcours de changement d’offre permettant de remplacer l’offre actuelle par celle correspondant à l’abonnement fourni.	Vous devez faire passer l’abonnement actuel vers un abonnement personnalisé que vous venez de créer.
Subscription	hosted-restart	Ouvre un parcours permettant au client de relancer un abonnement suspendu.	L’abonnement a été interrompu et vous souhaitez que le client le reprenne.
Invoice	hosted-charge	Ouvre un parcours permettant au client de payer une facture due.	Vous avez besoin que le client règle une facture donnée.
Offer	hosted-subscribe (1)	Ouvre un parcours permettant à un utilisateur anonyme de s’abonner. La souscription anonyme (non recommandée) doit être activée.	Vous souhaitez qu’un utilisateur non identifié puisse s’abonner.
Offer	hosted-subscribe (2)	Vous avez fourni un client. Ouvre le parcours pour souscrire à l’offre donnée.	Vous souhaitez qu’un client s’abonne à une offre donnée.
Offer	hosted-upgrade	Vous avez fourni un abonnement. Ouvre le parcours permettant de changer l’abonnement donné vers l’offre spécifiée.	Vous souhaitez que le client change son abonnement vers une offre donnée.

Méthodes

Il existe 2 méthodes pour envoyer un client vers une page spécifique.

Ces méthodes ne sont pas exclusives : une intégration avancée peut utiliser les deux pour couvrir un large éventail de cas.

Méthode 1) Utiliser la page d’installation

Cette solution est la plus simple, mais elle fonctionne uniquement :

• si votre client est authentifié
• si vous avez configuré une URL d’installation (vérifier ici)

Le plus grand avantage de cette solution est que vous pouvez générer des liens sécurisés à envoyer par email au client lorsque vous avez un besoin très spécifique qui n’est pas couvert par les emails client déjà envoyés par ProAbono.

Étape 1 – Récupérer l’objet

Utilisez l’API Live pour créer ou récupérer l’objet concerné.

N’oubliez pas les paramètres supplémentaires éventuellement requis par la requête.

Exemple : GET /v1/Customer

{
  "Id": 1066136,
  "ReferenceCustomer": "cust-19847",
  ...
  "Links": [
    {
      "rel": "hosted-home",
      "href": "https://my-service.com/billing"
    },
    {
      "rel": "hosted-subscribe",
      "query": "bvio5ZTZJOBmj2AvkFGZfrsD60tPJWoICRuc9nCUhMRpRqI0JU8Y0jLsRTEGncmoRshJx3GzVp8NRUuKnDsauqCU5DkAkeJmGAqI"
    }
    ...
  ]
}

Étape 2 – Construire le lien

Le lien rel=hosted-home contient l’URL d’installation.

Ajoutez un paramètre pa_query à ce lien en utilisant la requête souhaitée.

Exemple :

https://my-service.com/billing?pa_query=bvio5ZTZJOBmj2AvkFGZfrsD60tPJWoICRuc9nCUhMRpRqI0JU8Y0jLsRTEGncmoRshJx3GzVp8NRUuKnDsauqCU5DkAkeJmGAqI

C’est tout. Ce lien ouvrira la page hébergée requise. Vous pouvez rediriger votre client vers cette page ou l’envoyer dans un e-mail.

Méthode 2) Page hébergée dynamique

Avec cette méthode, vous pouvez ouvrir la page hébergée souhaitée sur n’importe quelle page de votre application web.

Étape 1 – Récupérer l’objet

C’est exactement la même étape que pour la méthode 1.

Étape 2 – Ouvrir le portail avec la requête

La méthode est très similaire à l’installation in-site.

Dans le head de la page, ajoutez la librairie ProAbono.

<script type="text/javascript"> src="https://portal.proabono.com/Get/portal.js"></script>

À l’endroit où vous souhaitez ouvrir la page, ajoutez une <div>

<div> id="proabono_portal"></div>

N’importe où dans la page, ouvrez les pages hébergées :

<script type="text/javascript">
  ProAbonoPortal.open({
    business_id: XX,
    segment_ref: 'XXX',
    customer_ref: 'XXX',
    query: 'OBmj2AvkFGZfrsD60tPJWoICRuc9nCUhMRpRqI0JU8Y',
    hash: '29d8b6e5edab22dccac0d60bd3377a2349331e314e752d6bf0731e7c3c22bc29'
  });
</script>

Consultez l’installation in-site pour plus d’informations sur cette méthode.