Aller au contenu principal
Version: 2.1.7

SDK Sline

Installation

Rajoutez la balise suivante à la fin de la section <head> de votre page:

<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/sline-io/web-sdk@2.1/sline-sdk.min.js"></script>

Initialisation

A la fin de votre <body>, ajoutez la ligne suivante:

<script type="text/javascript">
Sline.Initialize({
retailer: retailerId,
production: false,
checkoutButton: {
id: 'rent-btn',
prefix: 'Louer à partir de ',
suffix: '/mois',
events: {
customOnClickEvent: true
}
},
durationSelector: {
id: 'period-selector'
}
});
</script>

Configuration

Options principales

ParamètreTypeDescriptionObligatoire
retailerStringIdentifiant du marchandOui
productionBooleanMettre à true si vous êtes en production, sinon à falseOui
checkoutButtonObjectVoir les options du checkoutButton plus basOui
durationSelectorObjectVoir les options du durationSelector plus basNon

Configuration du CheckoutButton

ParamètreTypeDescriptionObligatoire
idStringIdentifiant du boutonOui
prefixStringTexte qui apparaîtra avant le prix dans le boutonNon
suffixStringTexte qui apparaîtra après le prix dans le boutonNon
eventsObjectVoir la configuration des évènements du checkoutButtonNon

Configuration du CheckoutButton.Events

ParamètreTypeDescriptionObligatoire
customOnClickEventBooleanMettre à true si vous écoutez des évènements sur le click du bouton de checkoutNon

Configuration du DurationSelector

ParamètreTypeDescriptionObligatoire
idStringIdentifiant du selecteur de duréeNon

Variables accessibles

Cart

Contient la liste des produits et les quantités associées

Sline.cart: {product, quantity}[]

Durations

Contient la liste des différentes durées de locations disponibles (en mois). La valeur -1 représente un location sans engagement

Sline.durations: number[]

Prices

Contient la liste des produits et les prix associés en fonction de la durée de location

Sline.prices: Object

Voici un exemple de prix:

{
produit1: {
durée1: {
firstInstalmentPrice: {amount: 20000, currency: 'EUR'}
otherInstalmentPrice: {amount: 5000, currency: 'EUR'}
},
durée2: {
firstInstalmentPrice: {amount: 25000, currency: 'EUR'}
otherInstalmentPrice: {amount: 7000, currency: 'EUR'}
}
}
produit2: {
durée1: {
firstInstalmentPrice: {amount: 20000, currency: 'EUR'}
otherInstalmentPrice: {amount: 5000, currency: 'EUR'}
},
durée2: {
firstInstalmentPrice: {amount: 25000, currency: 'EUR'}
otherInstalmentPrice: {amount: 7000, currency: 'EUR'}
}
}
}

Méthodes

Voici les différentes méthodes disponibles via le SDK:

Initialize

Initialize doit être la première méthode que vous appelez pour configurer le SDK

Sline.Initialize(options)

ResetCart

ResetCart permet de vider complètement le panier actuel

Sline.ResetCart()

AddCart

Ajoute un produit dans le panier. Si le produit est déjà présent, la quantité passée en paramètre remplacera l'ancienne valeur

Sline.AddCart(item, quantity)
ParamètreTypeDescriptionObligatoire
itemstringIdentifiant du produitOui
quantityNumberNombre d'exemplaires du produit à ajouterOui

UpdateCart

Ajoute un produit dans le panier. Si le produit est déjà présent, la quantité passée en paramètre remplacera l'ancienne valeur

Sline.UpdateCart(item, quantity)
ParamètreTypeDescriptionObligatoire
itemstringIdentifiant du produitOui
quantityNumberNombre d'exemplaires du produit à ajouterOui

GetPriceForProductWithDuration

Retourne le prix (formatté avec la devise) pour un produit en fonction de la durée de location et de la quantité

Sline.GetPriceForProductWithDuration(item, quantity);
ParamètreTypeDescriptionObligatoire
elementIdStringID du bouton déclencheurOui
titleStringTexte qui sera injecté dans le bouton, en préfixe de "X€/mois".
Valeur par défaut: "Louer à partir de "
Non

Example

Produit
Prix de vente
Mensualité
Quantité
Total
1 159.00 €
229.00 €
Louer