Skip to content

Inscription en ligne ​

La documentation suivante décrit la mise en place, via API, d'une inscription en ligne, notamment celle d'un client déjà prospect dans un club.

Cas d'un client déjà prospect dans un club ​

Il est impossible de créer un nouveau contact alors que celui-ci est déjà connu d'un club.
Cependant, certains services extérieurs ont besoin de créer un nouveau contact alors que celui-ci existe déjà.
Nous avons ajouté deux points d'API pour pallier ce problème.

Glossaire des notions clés ​

Avant d'aller plus loin, soyons certains que nous parlons des mêmes notions.

Le contact prospect ​

Il s’agit du client existant.
Son statut doit être temp, on le nommera contact source dans ce document.

Le contact temporaire ​

Il s’agit du client que l'on veut inscrire.
Son statut doit être prospect, on le nommera contact target dans ce document.

Le club ​

Il s’agit du club où les informations du contact target seront déplacées.

La vente : sale ​

Une sale correspond à un panier. Elle permet de regrouper une liste d’articles qui seront ensuite vendus au contact.


Macro process et prérequis ​

Comme indiqué précédemment, vous devez connaître les informations suivantes :

  • le contact source
  • le contact target
  • le club
  • la vente (sale)

Le processus du transfert des informations contact se fait en deux appels :

  1. Un premier permettant de migrer les données du contact source vers le contact target :
    Migration des informations
  2. Un deuxième permettant de modifier la vente afin de mettre les informations du contact lié à jour :
    Mise à jour des informations dans la vente

Migration des informations ​

Ce point d'API sert pour la migration des informations du contact source vers contact target.

Rappel :

  • Le contact source doit avoir le statut prospect
  • Le contact target doit avoir le statut temp
  • Le club du contact source doit être différent du contact target

Important: pour cet appel, il faut être connecté en tant que contact source

PUT /{clientToken}/contacts/{contactSourceId}/migrate ​

paramètredescriptionexemple
targetContactIdIdentifiant du contact sous forme d'IRI/{clientToken}/clubs/1
targetClubIdIdentifiant du club sous forme d'IRI/{clientToken}/clubs/1

Exemple ​

Migration du Contact 1 (prospect) vers le Contact 2 (temporaire) / Club 1

Query

PUT /{clientToken}/contacts/1/migrate

Body

json5
{
    "targetContactId": "/{clientToken}/contacts/2",
    "targetClubId": "/{clientToken}/clubs/1"
}

Réponse 204 Migration processed


Mise à jour des informations dans la vente ​

Ce point d'API sert à mettre à jour les informations du contact dans la vente.

Les informations mises à jour sont :

  • L'identifiant du contact : contactId
  • Le numéro du contact : contactNumber
  • le nom du contact : contactFamilyName
  • le prénom du contact : contactGivenName

PUT /{clientToken}/sale/{saleId}/update_contact ​

Exemple ​

Mise à jour des informations de la vente 33

Query

PUT /{clientToken}/sale/33/update_contact

Réponse 204 Process finished