Intégration API

La plate-forme Comelin est principalement controllé par 4 fichiers.

  • La page maître (Master.MP) qui inclut l'en-tête et le bas de page
  • La page d'accueil (default.aspx)
  • La page de produit (product.aspx)
  • La page de catégories et recherche (listing.aspx)

Les pages existes dans le répertoire /fr/ et dans le répertoire /en/ si le client à une site web bilingue.

VueJs

Comelin utilise principalement la technique de VueJs pour générer le code HTML à partir des données en format JSON.
Si vous n'êtes pas familier avec VueJs c'est une excellente plateforme à apprendre!

La page maître

Les objets suivants sont disponibles:

session

L'objet session vous permet de déterminer si l'utilisateur est connecter.
  • IsLogged[bool]: si l'utilisateur est connecté
  • Name[string]: nom de l'utilisateur.
  • Email[string]: adresse courriel de l'utilisateur.

Par exemple écrire le code suivant écrirait le nom de l'utilisateur s'il était connecté:
<span v-if="session.IsLogged">{{session.Name}}</span>

cart

  • NbItems[chiffre]: nombre d'article dans le panier.
  • ItemsTotal[chiffre]: montant total des articles dans le panier.
Propriété utilisé pour la notification d'ajout au panier:
  • LastProductAddedTitle[string]: titre du dernier produit ajouté au panier.
  • LastProductAddedImage[string]: url de l'image du dernier produit ajouté au panier.
  • LastProductAddedPrice[string]: prix du dernier produit ajouté au panier.

categories

Liste des catégories (pour faire la navigation). Les catégories peuvent contenir des sous-catégories.

  • Title[string]: Titre de la catégorie.
  • Url[string]: Url pour voir les produits de la catégorie.
  • UrlImage[string]: Url principale représentant la catégorie.
  • SubCategories[categories]: un array de sous-catégories... s'il y en a.

Par défaut Comelin donne 2 niveaux de catégories (les catégories primaire et secondaire, mais il est possible d'en avoir plusieurs niveaux en spécifiant la propriété level dans la fonction JavaScript comelin.load(...)

Ex: comelin.load( { categories: {level : 3} } );

Page des produits

Cette page affiche l'information d'un produit avec la matrice de produit.

  • Id[integer]: Chiffre unique à l'interne du produit.
  • Title[string]: Titre du produit (incluant grandeur, couleur, ...).
  • TitleWeb[string]: Titre du produit dans un format déterminé par le client (configurable).
  • Code[string]: Code du produit.
  • CodeSupplier[string]: Code fournisseur du produit. (non visible par défaut)
  • Code[string]: Code du produit.
  • Description[string]: Description HTML du produit.
  • UrlImage[string]: Url de l'image principale du produit.
  • Photos[string[]]: Liste des Urls pour les images du produit.
  • Price[chiffre]: Prix de vente (excluant les rabais).
  • Category[string]: Titre de la catégorie immédiate du produit.
  • UrlCategory[string]: L'URL de la catégorie immédiate du produit.
  • Brand[string]: Titre de la marque du produit.
  • UrlBrand[string]: L'URL de la marque du produit.
  • IsNew[bool]: Si le produit est considéré comme une nouveauté.
  • DateAvailableAt[date]: Date que le produit sera disponible (pré-commande).
Rabais
  • PriceDiscount[chiffre]: Prix en rabais. Si le produit n'est pas en rabais, cette valeur n'est pas présente.
  • PromoShort[string]: Courte description de la raison du rabais.
  • PromoLong[string]: Description complète de la raison du rabais.
Inventaire
  • Qty[integer]: Quantité en inventaire.
  • QtyFastShipping[integer]: Quantité en inventaire pour expédition rapide (s'applique seulement s'il y a plus d'un magasin).
  • QtyWithDelay[integer]: Quantité en inventaire qui demande un transfert (délai) avant l'expédition.
  • Url[string]: Url du produit.
  • IsOutOfStock[bool]: Le produit est un rupture d'inventaire.
  • CanBeAddedToCart[bool]: Le produit peut-être ajouté au panier.
  • Discontinued[bool]: Le produit est discontinué et ne sera plus jamais disponible.
  • Notify[bool]: Si le client a été ajouté à la liste de notification lorsque le produit sera de retour en inventaire.
Matrice (avec des grandeurs, couleurs...)
  • IsCombine[bool]: Si le produit représente plusieurs produits combinés ensemble (matrice).
  • TitleNoExtra[string]: Titre du produit (excluant la grandeur, couleur...).
  • UrlMatrix[string]: Url du produit sans les champs personnalisés

La page de produit à aussi un champs suggestions qui est une liste de produits en suggestions (vous aimeriez peut-être...)

Page de catégories et recherche

Les informations ne sont pas tous [encore] disponible, certaines informations comme les filtres de recherche sont générés au niveau du serveur. Si vous avez besoin de les générer contacter Comelin pour créer un API.

  • Title[string]: Titre de la catégorie.
  • Products[Produit[]]: Une série de produits qui sont dans la catégorie.
  • Breadcrumb[Link[]]: Une série de liens qui représente le fil d'Arinanne.
  • Title[string]: Titre du lien.
  • Url[string]: Url du lien.
N'oubliez pas de faire une copie du fichier avant de le téléverser en ligne!

Comelin est une jeune entreprise québécoise qui aide les petites entreprises à mieux gérer leur inventaire et offrir une boutique en ligne sans difficulté.