Passer au contenu principal

Entrées de configuration et fonctionnalités de checkout

Les entrées de configuration et les fonctionnalités de checkout sont des paramètres qui définissent le comportement du checkout Ventrata et ce qu’il affiche.

Les entrées de configuration et les fonctionnalités de checkout vous permettent de contrôler le fonctionnement du checkout Ventrata et ce qu'il affiche aux clients. Les deux sont définies dans l'attribut data-config de votre script ou bouton de checkout, mais elles sont ajoutées à des endroits différents :

  • Les entrées de configuration se placent directement dans data-config, à côté de votre apiKey.

  • Les fonctionnalités de checkout se placent dans un objet "features" au sein de data-config.


Ajouter des entrées et des fonctionnalités

Ajoutez les entrées et les fonctionnalités à l'attribut data-config de votre script ou bouton selon le format ci-dessous.

Remplacez input et featureName par les noms des entrées et des fonctionnalités prises en charge, puis spécifiez leurs valeurs. Séparez les différentes entrées par une virgule ,.

<script
src="https://cdn.checkout.ventrata.com/v3/production/ventrata-checkout.min.js"
type="module"
data-config='{
"apiKey": "<YOUR_API_TOKEN>",
"input1": "value",
"input2": "value",
"features": {
"featureName": value,
"featureName1": value
}
}'>
</script>

📒 REMARQUE

Les valeurs des entrées de configuration sont transmises sous forme de chaînes entre guillemets, par exemple "lang": "en".

Les valeurs des fonctionnalités sont pour la plupart true / false sans guillemets, par exemple "bottomBar": false. Consultez la colonne Valeurs disponibles pour chaque fonctionnalité.

📗 ASTUCE
Utilisez le Checkout Configurator pour créer et tester votre configuration avant de l'ajouter à votre site web. Chaque paramètre que vous ajoutez apparaît dans la balise de script générée, que vous pouvez copier et coller dans votre page. Laissez le configurateur en mode TEST pendant vos essais.


Entrées de configuration

Ajoutez-les directement à l'attribut data-config.

Configuration

Entrée

Par défaut

Description

"apiKey"

Obligatoire - doit être défini au moins une fois par importation de script

Votre apiKey se trouve dans votre tableau de bord Ventrata.

"env"

Non défini

"live" OU "test". Si laissé vide, le checkout utilise par défaut test.


Langue et devise

Entrée

Par défaut

Description

"lang"

Non défini

Optionnel, en minuscules, par exemple, en, cs.

"currency"

Non défini

Optionnel, en majuscules, par exemple, USD, EUR, CZK

📒 REMARQUE

Si "lang" et "currency" sont tous deux spécifiés dans le data-config, l'icône du globe utilisée pour sélectionner la langue et la devise lors du checkout est masquée, car ces paramètres sont prédéfinis. Ceci est généralement utilisé avec la fonctionnalité de multi-réservation.


Mode d'affichage et panier

Entrée

Par défaut

Description

"embedded"

false

Permet l'utilisation du mode intégré (embedded).

La page nécessite la présence d'un élément HTML avec l'attribut ventrata-embedded-widget.

Pour personnaliser le mode intégré, consultez les fonctionnalités viewModeMap et embeddedTitle.

"multibooking"

false

Permet l'utilisation d'un panier (plusieurs réservations dans la même commande).

Déclenche la barre inférieure, qui informe les utilisateurs du contenu actuel de la commande. Pour la masquer, consultez la fonctionnalité bottomBar.


Produit, commandes et pages

Entrée

Par défaut

Description

"productID"

Non défini

ID du produit.

Si non défini, la liste des produits est affichée.

"optionID"

Non défini

ID de l'option.

Si défini, l'option est présélectionnée.

"bookingID"

Non défini

ID de la réservation (utilisé uniquement pour multibooking)

Doit être associé à orderID.

"orderID"

Non défini

ID de la commande.

Obligatoire chaque fois que vous ouvrez une commande prédéfinie, par exemple avec bookingID (multi-réservation) ou avec page, voir Comment déclencher le checkout sur une page spécifique. bookingID est obligatoire en complément lorsque vous ciblez une réservation spécifique au sein d'une commande multi-réservation.

"recoveryToken"

Non défini

Jeton renvoyé lors de la création d'une commande, en même temps que son orderID. Obligatoire avec orderID lorsque vous ouvrez une commande dans une session de navigateur différente de celle qui l'a créée, par exemple une commande créée par votre propre back-end via l'API, ou une commande que vous rouvrez dans un nouvel onglet ou après un rechargement de page.

Non requis pour une commande créée par le Checkout Widget lui-même dans la session en cours du client, car il dispose déjà de cette information en interne.

"page"

Non défini

Valeur chaîne.

Déclenche le checkout sur une page spécifique du processus de checkout, telle que Tickets (Billets) ou Checkout. À utiliser uniquement en combinaison avec orderID.

Valeurs prises en charge :

"upgrade"/ "cross-sell" / "pickups" / "dropoffs" / "questions" / "order-questions" / "cart-summary" / ”checkout” / "package-availability"

Exemple : {"page": "checkout"}

📒 REMARQUE

Si la commande a été créée en dehors de la session de navigateur qui s'apprête à l'ouvrir, transmettez également recoveryToken. orderID seul ne suffit pas à prouver que votre session est autorisée à l'ouvrir.

‼️ IMPORTANT

Traitez recoveryToken comme des identifiants de connexion (credentials) : toute personne en possession de ce jeton peut ouvrir cette commande et agir sur celle-ci. Transmettez-le via HTTPS et évitez de le consigner dans des journaux (logs).


Présélection de la date et de l'heure

Entrée

Par défaut

Description

"dateToPreselect"

Non défini

Déclenche le checkout avec une date de visite spécifique. Utilisez le format ISO 8601 (AAAA-MM-JJ). À utiliser en combinaison avec productID.

"timeslotToPreselect"

Non défini

Déclenche le checkout avec une heure de visite spécifique. À utiliser en combinaison avec productID.

📗 ASTUCE

Pour présélectionner automatiquement la date disponible la plus proche à la place, consultez la fonctionnalité preselectFirstAvailableDateModalCalendar.


Marketing et promotions

Entrée

Par défaut

Description

"checkMarketingConsent"

Non défini

Si défini sur true, le consentement marketing sera présélectionné pour les utilisateurs dans la section Contact Details (Coordonnées) de la page Checkout.

"referrer"

Non défini

Valeur chaîne, par exemple, hilton.com.

"promoCode"

Non défini

Valeur chaîne, un code promotionnel existant. Applique le code automatiquement.

Pour permettre aux clients de saisir eux-mêmes un code, consultez la fonctionnalité promoAndGiftCardInput.


Fonctionnalités de checkout

Ajoutez ces fonctionnalités dans l'objet "features" de l'attribut data-config.

📒 REMARQUE

L'état par défaut de la plupart des fonctionnalités est déjà implémenté. Vous n'avez besoin d'ajouter une fonctionnalité au data-config que si vous souhaitez modifier sa valeur par défaut ou utiliser une fonctionnalité marquée Non défini.

Sélection du produit et de l'unité

Fonctionnalité

Par défaut

Valeurs disponibles

Description

preselectFirstUnit

Non défini

true / false ou nombre

Sélectionne automatiquement la première unité du produit avec un nombre par défaut de 1 (true) ou le nombre spécifié (nombre).

enableMoreDetailsToggle

Non défini

true / false

Ajoute un lien More Details (Plus de détails) pour développer les informations sur le produit, telles que l'aperçu, les points forts et la FAQ.

showSkipOffersButton

false

true / false

Permet aux clients d'ignorer les offres de mise à niveau et de combinaison.


Dates, horaires et disponibilité

Fonctionnalité

Par défaut

Valeurs disponibles

Description

calendarFirst

Non défini

"enabled": true / false

Permet aux clients de sélectionner la date de la visite avant la sélection du produit.

preselectFirstAvailableDateModalCalendar

false

true / false

Sélectionne automatiquement la date disponible la plus proche.

restrictedTicketType

Non défini

fixed / flexible

Contrôle le type de date de billet affiché aux clients.

timePickerType

Non défini

"select"

Transforme l'interface de sélection de l'heure de boutons individuels en un menu déroulant.

Cette fonctionnalité est une condition préalable à la fonctionnalité showTourGroupsHeadlines.

showTourGroupsHeadlines

false

true / false

Organise les créneaux horaires en groupes de visites distincts, chacun avec son propre titre.

Pour utiliser cette fonctionnalité, incluez d'abord "timePickerType": "select".

showRemainingSeats

false

true / false

Affiche le nombre de places restantes pour la visite.


Promotions et cartes cadeaux

Fonctionnalité

Par défaut

Valeurs disponibles

Description

promoAndGiftCardInput

true

true / false

Affiche un champ pour saisir un code promo ou un code de carte cadeau.

openGiftFlow

false

true / false

Permet l'achat de cartes cadeaux via le web checkout.

disableGiftAmountInput

false

true / false

Désactive la possibilité d'ajuster le prix unitaire de la carte cadeau.


Listes d'attente et devis

Fonctionnalité

Par défaut

Valeurs disponibles

Description

waitlistsAllowed

false

true / false

Active la fonctionnalité Waitlists (Listes d'attente), qui permet aux clients d'exprimer leur intérêt pour la réservation d'une visite à des dates actuellement complètes.

quotesAllowed

false

true / false

Active la fonctionnalité Quotes (Devis), qui permet aux clients de différer le paiement et de consulter une réservation sans engagement.


Mise en page et affichage

Fonctionnalité

Par défaut

Valeurs disponibles

Description

bottomBar

true

true / false

Affiche une barre en bas de l'écran lorsque plusieurs réservations sont effectuées dans une même commande (voir l'entrée multibooking).

viewModeMap

Non défini

"cross-sell": "popup" /
​"upgrade": "popup" /
​"questions": "popup" /
​"pickups": "popup"

Fait passer la page spécifiée du mode intégré au mode pop-up (voir l'entrée embedded).

embeddedTitle

Non défini

"buy-tickets"

Remplace le nom du produit dans le titre du widget par l'appel à l'action universel Buy Tickets (Acheter des billets) en mode intégré.

Avez-vous trouvé la réponse à votre question ?