Introduction

Que vous soyez libraire, revendeur ou éditeur, la plateforme Cantook met à votre disposition plusieurs outils pour l'intégration de contenus sur votre site Web qui permettent la consultation de publications en ligne, dont : 

  1. Des liens de feuilletage;
  2. Un bouton de téléchargement d'extrait de publication;
  3. Une liste des revendeurs d'un titre donné.

Pour être en mesure d'utiliser ces outils, vous devez avoir accès au code source de vos pages afin d'y inclure des balises spécifiques. Ce guide vous expliquera en détail les étapes à suivre pour connecter votre site Internet avec la plateforme Cantook afin d'intégrer ces contenus. Ces fonctionnalités ont été créées avec un grand souci de simplicité afin que la connexion avec la plateforme puisse se faire rapidement. Il faut par contre prendre note qu'une connaissance de base en HTML est requise. Une maîtrise des CSS s'avère aussi un atout afin d'exploiter au maximum les possibilités de mise en page des données fournies.

Pour plus des informations concernant l’API de synchronisation d'un catalogue de publications, nous vous invitons à consulter plutôt la page Guide : Les services web.

1 : Connexion à la plateforme

Pour débuter, votre site devra d'abord se connecter à la plateforme. Pour ce faire, il vous suffit de coller le code suivant à la fin de chacune des pages contenant une ou des publications. Assurez-vous de placer ce code juste avant la balise </body> et de ne jamais le coller plus d'une fois sur une même page, et ce, même si vous avez plus d'une publication sur celle-ci.

<script type="text/javascript"
src="http://[plateforme]/api/bridge.js?v=2&mid=[mid]&l=[langue]">
</script>

Une fois fait, vous devrez remplacer les deux paramètres [mid] et [langue]. Voici leur signification :

Clé Obligatoire Description

plateforme

Oui L'entrepôt que vous utilisez pour accéder à votre compte. Par exemple : www.entrepotnumerique.com, www.cantook.net, www.edenlivres.fr, edigita.cantook.net ou transcontinental.cantook.net.
mid Oui Votre numéro de compagnie dans l'entrepôt numérique. Ce numéro vous est remis lors de votre inscription.
langue Non Langue d'affichage des données. Vous avez le choix entre fr (français) ou en (anglais). Si le paramètre est omis, la version française sera utilisée.


Voilà! Votre site Internet est maintenant connecté à la plateforme.

1.1 : Identifier les publications

Maintenant que vos pages sont connectées à la passerelle, il faut mettre en place un contenant qui recevra les données envoyées par la plateforme. Pour ce faire, copiez la ligne suivante, à l'endroit où vous désirez voir apparaître les données sur une publication particulière.

<div id="enqc-wrap-[publication_id]" class="enqc-wrap">[contenu]</div>

Encore une fois, vous avez deux paramètres à remplacer, soit [publication_id] et [contenu].

Clé Obligatoire Description

publication_id

Oui EAN ou ISBN13 de la publication. L'identifiant ne doit pas contenir de "-". Les ISBN10 ne sont pas acceptés.
contenu Non Vous avez la liberté d'insérer tout ce que vous voulez à l'intérieur de cette balise. Vous pouvez donc insérer des balises traitées par la passerelle et récupérer des métadonnées (voir point 1.2). Si vous avez des données, éléments graphiques ou autres que vous ne puisez pas chez l'entrepôt numérique, vous pouvez aussi les insérer ici.


Prenez bien garde de ne jamais insérer une publication dans une autre publication. Comme dans l'exemple suivant :

 * Ne pas faire 
<div id="enqc-wrap-9781234567890" class="enqc-wrap">
<div id="enqc-wrap-9782222222222" class="enqc-wrap"></div>
</div>

Dans le cas où l'entrepôt numérique n'aurait pas cette publication en banque, la passerelle fera disparaitre toutes les balises à l'intérieur du "enqc-wrap" qui sont reliées à celle-ci. Elle n'effectuera aucun changement sur les autres.


1.2 : Récupérer les métadonnées pertinentes

Nous voici à l'étape finale, la récupération des métadonnées. Vous devrez choisir, parmi la liste des métadonnées disponibles dans la plateforme (Annexe 1), celles que vous souhaitez voir apparaître sur votre page. Ensuite, copiez les à l'intérieur des balises décrites à l'étape 1.1 (en remplacement du paramètre "contenu"). La passerelle remplira automatiquement le contenu des balises avec les informations contenues dans le système ou les fera disparaitre si la publication est inexistante.

Pour cette étape, vous avez la liberté de choisir les métadonnées qui vous intéressent. Vous pouvez les placer dans l'ordre que vous le désirez, faire des listes, des tableaux, il n'y a aucune limite.

Exemple d'utilisation :

<div id="enqc-wrap-9781234567890" class="enqc-wrap">
  <div class="details">
    <span class="enqc-issued-on">&nbsp;</span>
    <span class="enqc-authors-name">&nbsp;</span>
  </div>
  <div class="achats">
    Procurez-vous <span class="enqc-title">&nbsp;</span> en format PDF
    pour seulement <span class="enqc-pdf-cost">&nbsp;</span>
  </div>
</div>

Reprenons l'exemple ligne par ligne :

  • Ligne 1 : La passerelle vérifiera que la publication "9781234567890" existe. Cette ligne est le contenant qui contiendra tout ce qui est relié à cette publication.
  • Ligne 2 : Balise qui n'est pas traitée par la passerelle.
  • Ligne 3 : Métadonnée. La passerelle remplacera son contenu avec la date de parution.
  • Ligne 4 : Métadonnée. La passerelle remplacera son contenu avec le/les nom(s) d'auteur(es).
  • Ligne 6 : Balise qui n'est pas traitée par la passerelle.
  • Ligne 7 : Texte contenant une métadonnée. La passerelle remplacera le contenu du span "enqc-title" par le titre de la publication.
  • Ligne 8 : Texte contenant une métadonnée. La passerelle remplacera le contenu du span "enqc-pdf-cost" par le prix de vente de la version pdf.
  • Si l'entrepôt numérique ne contient pas la publication "9781234567890", les lignes 3 et 4 seront détruites ainsi que les balises "enqc-title" et "enqc-pdf-cost"

1.3 : Rafraîchir les données

Optionnel

Dans le cas où, lors d'appels AJAX, de nouvelles publications seraient générées sur votre page, vous pourrez, en tout temps, appeler la méthode suivante afin de remplir les métadonnées pour ces nouvelles publications.

<script type="text/javascript">alveos_bridge.update('[scope_id]');</script>


Clé Obligatoire Description

scope_id

Non Pour bonifier la performance, vous pouvez restreindre le champs de recherche des publications à un élément particulier. Pour ce faire vous n'avez qu'à remplacer «scope_id» par l'id d'un élément dans la page. Une valeur vide engendrera un scan complet de la page.


2 : Consulter des extraits de publication

Pour la majorité des publications, un ou des extraits seront disponibles au grand public afin d'avoir un aperçu concret du contenu de celles-ci. Ces extraits seront présentés sous la forme d'une application de feuilletage ou d'un fichier PDF. Vous pouvez donner accès à votre clientèle en choisissant un des 5 formats ci-dessous. Copiez ensuite le code associé à votre choix dans le contenant décrit dans la section 1.1.

2.1 : Bouton Texte/CSSType : Ouvre une nouvelle fenêtre contenant le feuilleteur

Ce format vous affichera un simple lien hypertexte que vous pourrez personnaliser avec les CSS.

<div class="flipbook-text">[titre]</div>
Clé Obligatoire Description
titre
Oui
Texte du lien. Exemple : Feuilletez cet ouvrage

2.2 : CouvertureType : Ouvre une nouvelle fenêtre contenant le feuilleteur

Ce format affichera la couverture de la publication. La couverture aura toujours 65 pixels de large.

<div class="flipbook-cover"></div>

2.3 : Feuilleteur miniature
Type : Feuilleteur inséré directement dans la page

Ce format affichera une version miniature et simplifiée du feuilleteur. Pour une question de performance, il est recommandé de n'afficher qu'un feuilleteur par page.

<div class="flipbook-mini" style=" 
background-color:#[couleur];width:[largeur]px;"></div>
Clé Obligatoire Description
couleur
Oui
Couleur de fond du feuilleteur en format hexadécimal. Exemple : FFFFFF = Blanc, 000000 = Noir
largeur
Oui
Largeur du feuilleteur en pixels. La valeur devra être comprise entre 100 et 350.

2.4 : Feuilleteur complet
Type : Feuilleteur inséré directement dans la page

Ce format affichera la version complète du feuilleteur. Pour une question de performance, il est recommandé de n'afficher qu'un feuilleteur par page.

<div class="flipbook-full" style=" 
background-color:#[couleur];width:[largeur]px;"></div>
Clé Obligatoire Description
couleur
Oui
Couleur de fond du feuilleteur en format hexadécimal. Exemple : FFFFFF = Blanc, 000000 = Noir
largeur
Oui
Largeur du feuilleteur en pixels. La valeur devra être comprise entre 550 et 950.

2.5 : Extrait PDF
Type : Télécharger un fichier PDF

Cette balise vous affichera un simple hyperlien qui permettra à l'utilisateur de télécharger un fichier qui contiendra un extrait de la publication. L'extrait est un fichier PDF, personnalisé au nom de votre organisation, qui contient seulement les pages qui sont ouvertes au feuilletage. Vous pourrez personnaliser le lien avec les CSS.

<div class="enqc-pdf-excerpt">[titre]</div>
Clé Obligatoire Description
titre
Oui
Texte du lien. Exemple : Télécharger l'extrait PDF

2.6 : Afficher la liste des revendeurs de la publication (dans une nouvelle fenêtre)

Si vous n'êtes pas en mesure de vendre vous même vos publications en ligne, vous pouvez donner accès à vos clients à la liste des revendeurs de chaque publication. Cette liste est présentés dans un popup. Pour donner accès à cette liste, copiez le code suivant dans le contenant décrit dans la section 1.2.

 

Ce format vous affichera un simple lien hypertexte que vous pourrez personnaliser avec les CSS.

<div class="resellers">[titre]</div>
Clé Obligatoire Description
titre
Oui
Texte du lien. Exemple : Afficher les revendeurs

Annexe 1

Pour afficher les métadonnées, vous pourrez utiliser 2 éléments : les valeurs et les contenants.

Les valeurs sont les métadonnées en elles-mêmes (titre, prix, auteurs, genre, etc.) tandis que les contenants sont des balises vous permettant d'afficher ou de masquer du contenu selon sa disponibilité. Les contenants seront très pratiques si la passerelle ne trouve pas de contenu associé à votre structure (par exemple aucun ePub pour une publication), le client ne verra pas une fiche remplie d'espaces vides.

Le premier exemple décrit l'utilisation au plus simple d'une valeur.

<div id="enqc-wrap-9781234567890" class="enqc-wrap">
<span class="enqc-pdf-cost">&nbsp;</span>
</div>
  • Ligne 1 : La passerelle vérifiera que la publication 9781234567890 existe. Cette ligne est le contenant qui contiendra tout ce qui est relié à cette publication.
  • Ligne 2 : métadonnée. La passerelle remplacera son contenu avec le prix de vente de la version pdf.

Voici un deuxième exemple décrivant l'utilisation d'un contenant.

<div id="enqc-wrap-9781234567890" class="enqc-wrap">
<div class="enqc-wrap-pdf">
Version PDF : <span class="enqc-pdf-cost">&nbsp;</span>

</div>
</div>
  • Ligne 1 : La passerelle vérifiera que la publication 9781234567890 existe.
  • Ligne 2 : Contenant. Dans le cas où la publication n'aurait pas de fichier pdf disponible, le contenant ainsi que tout ce qu'il contient sera masqué.
  • Ligne 3 : Texte contenant une métadonnée. La passerelle remplacera le contenu du span «enqc-pdf-cost» par le prix de vente de la version pdf.

Cet exemple démontre bien l'importance des contenants, car dans le cas où le pdf n'existe pas pour la publication 9781234567890, le texte «Version pdf :» ne sera pas visible pour l'utilisateur.

Les contenants

À noter que tous les contenants ont le préfixe «enqc-wrap-» mais afin d'alléger le document, il a été retiré.

Clé Description
pdf Le pdf existe et est disponible à la vente.
pdf-no-acs4 Le pdf existe, est disponible à la vente et n'est pas exclusivement protégé par le DRM ACS4.
pdf-image-only Le pdf a été créé strictement à partir d'images.
epub Le ePub existe et est disponible à la vente.
epub-no-acs4 Le ePub existe, est disponible à la vente et n'est pas exclusivement protégé par le DRM ACS4.
epub-image-only Le ePub a été créé strictement à partir d'images.
authors Il y a au moins un auteur.
not-found La publication n'existe pas sur l'entrepôt numérique

Les valeurs

Pour chacune des valeurs, un contenant du même nom est associé. Par exemple, la valeur «enqc-summary» a un contenant «enqc-wrap-summary» associé. Dans le cas où le résumé(summary) est vide, le contenant «enqc-wrap-summary» sera masqué.

À noter que toutes les valeurs ont le préfixe «enqc-», mais afin d'alléger le document, il a été retiré.

Clé Description
title Titre principal
summary Résumé
tags Mots clés associés au contenu
authors-name Nom complet du ou des auteur(es)
language Langue de la publication
translated-from Langue d'origine
pdf-cost Prix de vente du pdf
epub-cost Prix de vente du ePub