API - Références Techniques
À quoi cela sert-il ?
Section titled “À quoi cela sert-il ?”La référence technique est une chaine de caractère UTF-8 qui vous pouvez fournir pour identifier de manière unique les ressources ProAbono dans vos appels API.
Nous vous recommandons de personnaliser ces références techniques pour que votre application puisse facilement identifier les ressources ciblées lorsque que celle-ci communique avec ProAbono.
Format :
Section titled “Format :”- 50 caractères maximum.
- Caractères exclus : < > ; “ = ? &
Toutes les références techniques
Section titled “Toutes les références techniques”La Référence Segment (ReferenceSegment)
Section titled “La Référence Segment (ReferenceSegment)”Identifie un Segment.
Cette référence est unique par Business, modifiable uniquement par API.
Utilisation type :
- Création client
- Installation du Widget
Conséquence d’une modification :
- Peut casser vos parcours d’enrôlement de client.
- Consultez le support avant toutes modifications.
Référence Client (ReferenceCustomer)
Section titled “Référence Client (ReferenceCustomer)”Identifie un Client.
Cette référence est unique par Segment, modifiable par API ou depuis le backoffice.
Utilisation type :
- Création d’un abonnement
- Installation du Widget
- Diverses opérations sur le client
- Récupérer les droits et usages de votre client à tout moment.
Conséquence d’une modification :
- Peut bloquer l’accès de votre application à votre client
- Peut donner accès aux données d’un autre utilisateur.
Référence Offre (ReferenceOffer)
Section titled “Référence Offre (ReferenceOffer)”Identifie une Offre
Cette référence est unique par Segment, modifiable par API ou depuis le backoffice.
Utilisation type :
- Démarrer un parcours de souscription d’abonnement
- Créer un abonnement sur mesure.
Conséquence d’une modification :
- Casser les parcours de souscription
Référence Caractéristique (ReferenceFeature)
Section titled “Référence Caractéristique (ReferenceFeature)”Identifie une Caractéristique
Cette référence est unique par Business, modifiable par API ou depuis le Backoffice.
Utilisation type :
- Permet de vérifier à tout moment qui à le droit à quoi dans votre application
- Personnaliser des abonnements au démarrage
Conséquence d’une modification :
- Restreint l’accès à l’une de vos fonctionnalités pour l’ensemble de vos utilisateurs.
Référence Réduction (ReferenceDiscount)
Section titled “Référence Réduction (ReferenceDiscount)”Identifie une Réduction
Cette référence est unique par Segment, modifiable par API ou depuis le Backoffice.
Utilisation type :
- Permet de gérer des réductions cross-segment
Conséquence d’une modification :
- N’applique plus la réduction lors d’un processus associé (souscription / modification d’abonnement ou création d’offre)