Introduzione

Edigita, una piattaforma di distribuzione di ebook, in collaborazione con De Marque, mette a disposizione una vasta gamma di strumenti per la consultazione e la vendita di pubblicazioni online. Per utilizzare questi strumenti, è necessario collegare il tuo sito al nostro gateway. Questa guida ti spiega come farlo.

Al momento, il gateway permette l'utilizzo di tre componenti:

  1. Raccolta metadati di pubblicazioni (prezzo di vendita, autore, data di pubblicazione, ecc)
  2. Consulta estratti di pubblicazioni (sfoglialibro o PDF)
  3. Servizio consegna ebook che può essere collegato al tuo sito di commercio elettronico.

Abbiamo cercato di creare funzionalità semplici in modo da velocizzare e facilitare la connessione a Edigita. Una conoscenza di base del linguaggio HTML rimane comunque necessaria. Anche una buona conoscenza dei CSS può essere utile per sfruttare al meglio le diverse opzioni di layout offerte dal sistema Edigita. Infine, per il servizio consegna ebook, la presenza di un programmatore PHP/ASP o Ruby, a seconda del sistema, sarà necessaria per la connessione.

1 : Raccolta dei metadati

La banca dei metadati di Edigita ti dà accesso ad una multitudine d'informazioni su una pubblicazione specifica. Queste informazioni possono essere visualizzate nel tuo catalogo internet in tempo reale. Per recuperare i dati, procedi come descritto nei seguenti tre passi:

1.1 : Connessione alla casella degli strumenti

In un primo momento, il tuo sito dovrà connettersi a Edigita. E' sufficiente incollare il seguente codice alla fine di ogni pagina contenente una o più pubblicazioni. Assicurati di inserire questo codice prima del tag e di non incollarlo più volte nella stessa pagina. Questa raccomandazione vale anche se hai più pubblicazioni in una stessa pagina.

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

Una volta fatto, puoi sostituire i due parametri [mid] e [langue]. Di seguito, trovi il loro significato:

Parametro Obbligatorio Descrizione
mid
Si
Il numero della tua compagnia su Edigita. Questo numero ti è fornito al momento della registrazione.
lingua
No
Lingua di visualizzazione dei dati. E' possibile scegliere fra fr o en. Se il parametro viene omesso, sarà utilizzata la versione francese.

Ecco fatto! Il tuo sito web è ora collegato a Edigita.

1.2 : Identificazione pubblicazioni

Ora che le tue pagine sono collegate al gateway, un contenitore deve essere impostato per ricevere i dati mandati da Edigita. A tale scopo, la riga seguente deve essere copiata nel posto dove vuoi visualizzare i dati su una specifica pubblicazione.

<div id="edgt-wrap-[publication_id]" class="edgt-wrap">[contenuto]</div>

Ancora una volta, hai due parametri da sostituire, [publication_id] e [contenu].

Parametro Obbligatorio Descrizione
publication_id
Si
EAN o ISBN13 della pubblicazione. L'identificatore non deve contenere "-". I codici ISBN10 non sono accettati.
contenuto
No
Sei libero di inserire tutto ciò che vuoi all'interno di questo tag. E' possibile inserire tag elaborati dal gateway e recuperare metadati (vedi punto 1.3). Se alcuni dei tuoi dati, elementi grafici o altro non possono essere acquisiti su Edigita, li puoi inserire qui.

Attento a non inserire una pubblicazione in un'altra pubblicazione, come nel seguente esempio:

 * Da non fare 
<div id="edgt-wrap-9781234567890" class="edgt-wrap">
<div id="edgt-wrap-9782222222222" class="edgt-wrap"></div>
</div>

Nel caso Edigita non abbia questa pubblicazione in banca, il gateway farà scomparire tutti i tag correlati ad essa all'interno del "edgt-wrap". Nessuna modifica sarà effettuata sulle altre pubblicazioni.

1.3 : Recupero metadati

Siamo nella fase finale, il recupero dei metadati. Puoi scegliere nella lista dei metadati disponibili da Edigita (Allegato 1) quelli che vuoi sulla tua pagina. Li devi copiare all'interno dei tag descritti al punto 1.2 (in sostituzione del parametro "contenuto"). Il gateway riempirà automaticamente il contenuto dei tag con le informazioni contenute nel sistema o farà scomparire i tag se la pubblicazione non esiste.

Per questa fase, sei libero di scegliere i metadati che ti interessano. Li puoi mettere nell'ordine desiderato, fare delle liste, delle tabelle, ecc.

1.4 : Esempio d'utilizzo

<div id="edgt-wrap-9781234567890" class="edgt-wrap">
<div class="details">

<span class="edgt-issued-on">&nbsp;</span>
<span class="edgt-authors-name">&nbsp;</span>
</div>
<div class="achats">
Compra <span class="edgt-title">&nbsp;</span> in formato PDF
solo per <span class="edgt-pdf-cost">&nbsp;</span>

</div>
</div>

Rivediamo l'esempio, riga per riga.

  • Riga 1: il gateway controlla che la pubblicazione "9781234567890" esiste. Questa riga è il contenitore che contiene tutti gli elementi legati alla pubblicazione.
  • Riga 2: tag che non è processato dal gateway.
  • Riga 3: metadato. Il gateway sostituisce il suo contenuto con la data di pubblicazione.
  • Riga 4: metadato. Il gateway sostituisce il suo contenuto con il nome dell'autore (o i nomi degli autori).
  • Riga 6: tag che non è processato dal gateway.
  • Riga 7: testo che contiene un metadato. Il gateway sostituisce il contenuto dello span "edgt-title" con il titolo della pubblicazione.
  • Riga 8: testo che contiene un metadato. Il gateway sostituisce il contenuto dello span "edgt-pdf-cost" con il prezzo di vendita della versione pdf.

Nel caso Edigita non abbia la pubblicazione "9781234567890" in banca, le righe 3 e 4 e i tag "edgt-title" e "edgt-pdf-cost" saranno cancellati.

1.5 : Aggiornamento datiFacoltativo

Se al momento di chiamate AJAX, nuove pubblicazioni sono generate sulla tua pagina, è sempre possibile usare il metodo seguente per compilare i metadati relativi a queste nuove pubblicazioni.

<script type="text/javascript">alveos_bridge.update('[scope_id]');</script>
Parametro Obbligatorio Descrizione
scope_id
No
Per migliorare le prestazioni, è possibile limitare il campo di ricerca di pubblicazioni ad un elemento in particolare. Per farlo, devi sostituire "scope_id" con l'ID di un elemento nella pagina. Un valore vuoto avvierà una scansione completa della pagina.

2 : Consulta estratti di pubblicazioni

Per la maggioranza delle pubblicazioni, uno o più estratti in anteprima sono proposti al lettore cosi da permettere una valutazione del libro. L'utente può visualizzare questi estratti usando lo sfoglialibro (applicazione Flipbook) o un formato PDF. Puoi dare accesso, scegliendo uno dei 5 seguenti formati. Poi basta copiare il codice associato al formato scelto nel contenitore, come descritto nella sezione 1.2.

2.1 : Pulsante Testo/ CSSTipo: apre una nuova finestra con il sfoglialibro

Con questo formato si visualizza un semplice collegamento ipertestuale che puoi personalizzare con i CSS.

<div class="flipbook-text">[titolo]</div>
Parametro Obbligatorio Descrizione
titolo
Si
Testo del link. Esempio: Sfoglia questo libro

2.2 : CopertinaTipo: apre una nuova finestra con il Flipbbok

Con questo formato sarà visualizzata la copertina della pubblicazione. La copertina sarà sempre 65 pixel di larghezza.

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

2.3 : Mini sfoglialibroTipo: Sfoglialibro integrato direttamente nella pagina

Con questo formato, sarà visualizzata la versione miniatura e semplificata del sfoglialibro. E' consigliato non più di un sfoglialibro a pagina per mantenere alte le prestazioni.

<div class="flipbook-mini" style=" 
background-color:#[colore];width:[larghezza]px;"></div>
Parametro Obbligatorio Descrizione
colore
Si
Colore di sfondo del sfoglialibro in formato esadecimale. Esempio: FFFFFF = Bianco, 000000 = Nero
larghezza
Si
Larghezza in pixel del sfoglialibro. Il valore dovrebbe essere tra 100 e 350.

2.4 : Sfoglialibro originaleTipo: Sfoglialibro integrato direttamente nella pagina

Con questo formato, sarà visualizzata la versione originale del sfoglialibro. E' consigliato non più di un sfoglialibro a pagina per mantenere alte le prestazioni.

<div class="flipbook-full" style=" 
background-color:#[colore];width:[larghezza]px;"></div>
Parametro Obbligatorio Descrizione
colore
Si
Colore di sfondo del sfoglialibro in formato esadecimale. Esempio: FFFFFF = Bianco, 000000 = Nero
larghezza
Si
Larghezza in pixel del sfoglialibro. Il valore deve essere compreso tra 550 e 950.

2.5 : Estratto PDFTipo: scarica un file PDF

Con questo tag si visualizza un semplice collegamento ipertestuale che permette all'utente di scaricare il file contenente un estratto della pubblicazione. L'estratto è un PDF, personalizzato con il nome della tua compagnia, che contiene solo le pagine accessibili alla consultazione. E' possibile personalizzare il collegamento con i CSS.

<div class="edgt-pdf-excerpt">[titolo]</div>
Parametro Obbligatorio Descrizione
titolo
Si
Testo del link. Esempio: Scarica l'estratto PDF

3 : Visualizza l'elenco dei rivenditori di questa pubblicazione

Se non sei in grado di offrire la vendita online delle tue pubblicazioni, puoi dare ai tuoi clienti l'accesso ad un elenco dei rivenditori per ogni pubblicazione. L'elenco è presentato in una finestra popup. Per dare l'accesso a questo elenco, copia il seguente codice nel contenitore descritto nella sezione 1.2.

3.1 : Pulsante Testo/ CSSTipo: apre una nuova finestra con l'elenco dei rivenditori

Con questo formato si visualizza un semplice collegamento ipertestuale che puoi personalizzare con i CSS.

<div class="resellers">[titolo]</div>
Parametro Obbligatorio Descrizione
titolo
Si
Testo del link. Esempio: Visualizza rivenditori

4 : Servizio consegna ebook

Questa parte della documentazione è destinata ai riventitori che vogliono integrare la distribuzione di risorse online sulle loro piattaforme di e-commerce o sui loro portali. La consegna di ebook avviene in due fasi, il cui funzionamento e aspetti tecnici sono descritti di seguito.

  • l'autorizzazione di accesso di un utente ad una risorsa (da fare una sola volta per ogni caso).
  • la visualizzazione di questa risorsa da parte dell'utente (può essere ripetuta più volte se necessario).

Gli utenti attraverso il tuo sito web (libreria online, portale scolastico, biblioteca, ecc) vogliono poter acquistare e/o consultare pubblicazioni presenti sulla piattaforma, anche se protette. Il tuo sito web deve offrire questa possibilità all'utente, utilizzando alcuni servizi descritti di seguito.

4.1 : Note generali

Parametro Descrizione
Autenticazione L'autenticazione HTTP basic rende sicuri gli accessi ai web service (vedi http://fr.wikipedia.org/wiki/HTTP_Authentification#M.C3.A9thode_Basic). Sarà necessario il nome utente e password che ti sono stati forniti al momento dell'utilizzo dei servizi.
Web service RESTFul Le API dei servizi sono basate sui principi REST (vedi http://en.wikipedia.org/wiki/Representational_State_Transfer). Sempre più servizi, come Google e Amazon, seguono i dettami dell'architettura REST.
Metodo PUT Il metodo PUT è usato per alcune URL del documento. Per effettuare una richiesta PUT, è necessario utilizzare nel codice della pagina un cliente HTTP che supporta questo metodo. Un'altra opzione è quella di simulare un metodo PUT. Puoi farlo facendo una regolare richiesta POST ma specificando il parametro "?_method=PUT" nella querystring, alla fine della URL. Questa opzione funziona solo per le URL collegate al dominio syrano.demarque.com.
Case sensitive Tutte le URL e le loro parametri sono case sensitive.

4.1.1 : Parametri comuni ai servizi

L'utilizzo dei servizi descritti qua sotto implica la conoscenza di alcuni parametri che dovranno essere indicati in modo dinamico al momento della chiamata al web service. Segue la descrizione dei parametri.

Parametro Obbligatorio Descrizione
mid
Si
Identificatore univoco del negozio sulla piattaforma (è fornito al momento della registrazione).
uid
Si
Identificatore univoco dell'utente nel tuo sistema. Massimo 16 caratteri alfanumerici (sono consentiti "-" e "_").
did
Si
Identificatore univoco del distributore sulla piattaforma. Questo numero è fornito al momento della registrazione e viene utilizzato solo per i web service sul dominio "syrano.demarque.com".
tid
Si
Identificatore univoco di transazione. Generato dal tuo sito web. L'identificatore deve essere univoco dall'apertura alla chiusura della transazione. 16 caratteri alfanumerici (sono consentiti "-" e "_"). Eccezione: il carattere "!" è accettato come primo carattere, per indicare le transazioni di prova che non sono fatturabili. Vedi sotto "Verifica il funzionamento del sistema".
reference_type
Si
Tipo d'identificatore della risorsa. Esempio: "isbn", "ean", "custom".
reference_identifier
Si
Identificatore della risorsa richiesta. Ad esempio, per un {reference_type} che sarebbe "isbn", il {reference_identifier} potrebbe essere "9781234567890". Senza spazi o trattini.
token
Si
Il token ottenuto dalla chiamata al "Servizio di token digitale" (vedi sotto)

4.2 : Procedure

4.2.1 : Autorizza l'accesso di un utente ad una pubblicazione

Per consentire l'accesso di un utente ad una pubblicazione, il tuo sito web deve contattare il nostro sistema per registrare l'accesso. Una volta fatto, l'utente potrà accedere alla sua pubblicazione quando lo vorrà. Questa procedura prevede tre chiamate sicure ai nostri web service. Le sette fasi di questa procedura sono descritte di seguito.

Quando?

Quando il tuo sistema consente l'accesso di un utente ad una pubblicazione. Per esempio, dopo la vendita di un libro.

Come?

Prerequisiti:

  • Conosci il tuo nome utente e password per l'autorizzazione HTTP per i web service
  • Conosci il tuo {did}
  • Conosci il {uid} dell'utente in linea
  • Crea un {tid} univoco per ogni transazione
  • Conosci il {reference_type} della o delle pubblicazioni alle quali vuoi dare accesso.
  • Conosci il {reference_identifier} della o delle pubblicazioni alle quali vuoi dare accesso.

Fasi:

  • Utilizza il web service "Crea una nuova transazione"
  • Verifica che il codice di risposta del server sia 201 prima di continuare.
  • Utilizza il web service "Aggiungi operazioni ad una transazione"
  • Verifica che il codice di risposta del server sia 201 prima di continuare.
  • Utilizza il web service "Conferma e chiudi la transazione"
  • Verifica che il codice di risposta del server sia 200 e che il corpo del messaggio sia "committed=true" prima di continuare.
  • Salva nel tuo sistema le informazioni utilizzate per ogni transazione ({tid}, {uid}, {reference_identifier}) per riferimento futuro.

4.2.2 : Consulta la pubblicazione

Una volta ricevuta l'autorizzazione, l'utente vorrà vedere la sua pubblicazione. La visualizzazione può essere fatta direttamente sul tuo sito web o a partire da una mail di conferma, cliccando su un link. Di conseguenza, il tuo sito web deve eseguire determinate operazioni per garantire la consultazione.

Quando?

Quando l'utente ha cliccato sul link per consultare la sua pubblicazione

Come?

Prerequisiti:

  • Conosci il tuo nome utente e password per l'autorizzazione HTTP per i web service
  • Conosci il tuo {did}
  • Conosci il {reference_identifier} richiesto
  • Conosci il {uid} del utente che fa la richiesta
  • Conosci il {tid} associato alla transazione fatta precedentemente per autorizzare l'acceso dell'utente alla pubblicazione (questo parametro è necessario solo per la visualizzazione dei formati PDF e ePub).

Fasi:

  • Utilizza il "Servizio di token digitale"
  • Verifica che il codice di risposta del server sia 200 prima di continuare.
  • Conserva il token digitale contenuto nel corpo del messaggio per i passi successivi.
  • Crea l'URL come descritto alla sezione "Servizio di consultazione"
  • Reindirizza l'utente verso questa URL

4.2.3 : Verifica il funzionamento del sistema

In diversi momenti, è necessario eseguire test per assicurarsi del buon funzionamento dell'applicazione. Questi test non sono fatturati e possono essere fatti:

  • al momento della prima integrazione della piattaforma sul tuo sistema
  • quando delle modifiche sono fatte al tuo sistema o ai servizi descritti in questo documento
  • in qualsiasi momento per verificare il buon funzionamento

E' importante distinguere questi test in modo che non siano contabilizzati come delle vere transazioni.

Come?

Obbligatorio

Quando si esegue un test, il {tid} deve iniziare con un punto esclamativo ("!") in tutti i servizi descritti in seguito.

Facoltativo

Dei libri campioni sono messi a tua disposizione. Usali per i test in modo da avere libri leggeri e rapidamente accessibili. I libri campioni non possono essere venduti nel tuo negozio online (sono descritti come "view" nei metadati per ogni formato).

  • test-1: pdf :9990000000001 epub: 9991000000001
  • test-2 : pdf : 9990000000002 epub : 9991000000002
  • test-3 : pdf : 9990000000003 epub : 9991000000003

ATTENZIONE: Tutte le transazioni che non rispettano questi parametri saranno trattate come transazioni reali.

4.3 : Descrizione dei servizi

4.3.1 : Autorizza l'accesso di un utente ad una pubblicazione

Creazione di una nuova transazione

E' richiesta l'autenticazione HTTP basic

Inizializzazione della nuova transazione

PUT https://syrano.demarque.com/rest/distributors/[did]/users/[uid]/transactions/[tid]
  • Risposta corretta: header= 201
  • Risposta sbagliata: Qualsiasi altra risposta
Aggiungi operazioni alla transazione

E' richiesta l'autenticazione HTTP basic

Permette l'accesso ad una risorsa

PUT https://syrano.demarque.com/rest/distributors/[did]/users/[uid]/transactions/[tid]/
operations/grant-access/resources/[reference_type]/[reference_identifier]
  • Risposta corretta: header= 201
  • Risposta sbagliata: Qualsiasi altra risposta
Conferma e chiusura della transazione

E' richiesta l'autenticazione HTTP basic

Conferma delle varie operazioni che compongono la transazione. Una volta confermata la transazione non sarà più possibile modificarla. ATTENZIONE: Il corpo della richiesta deve contenere l'attributo committed=true.

PUT https://syrano.demarque.com/rest/distributors/[did]/users/[uid]/transactions/[tid]

Corpo del messaggio

Parametro Obbligatorio Descrizione
committed=true
Si
Permette di confermare e chiudere la transazione
  • Risposta corretta: header= 200 body= committed=true
  • Risposta sbagliata: Qualsiasi altra risposta

4.3.2 : Visualizza

Servizio di token digitale

E' richiesta l'autenticazione HTTP basic

Grazie a questo servizio, puoi recuperare il token ID che servirà a creare l'URL per accedere ad una risorsa di Edigita (Servizio di consultazione).

GET https://syrano.demarque.com/rest/distributors/[did]/token.txt
  • Risposta corretta: header= 200 body= {token di 32 caratteri}
  • Risposta sbagliata: header= 200 body= 0
Servizio di consultazione

Diversi formati e protezioni sono offerti, le richieste distinte per l'accesso sono:

PDF, visualizzazione in linea

Sfoglialibro permettendo la visualizzazione di tutte le pagine

https://edigita.cantook.net/p/[reference_identifier]?gate=syrano
&mid=[mid]&uid=[uid]&token=[token]
PDF, download, protezione da watermark

File da scaricare in formato PDF. Con questa tecnica, lo stesso piè di pagina con {nome_del_cliente} sarà aggiunto su tutte le pagine PDF.

https://edigita.cantook.net/p/[reference_identifier].pdf?
gate=syrano&mid=[mid]&uid=[uid]&tid=[tid]&token=[token]&uname=[Nome_del_cliente]
PDF, download, protezione da DRM ACS4
https://edigita.cantook.net/p/[reference_identifier].pdf?
gate=syrano&mid=[mid]&uid=[uid]&tid=[tid]&token=[token]
ePub

File da scaricare in formato ePub

https://edigita.cantook.net/p/[reference_identifier].epub?
gate=syrano&mid=[mid]&uid=[uid]&tid=[tid]&token=[token]

5 : Visualizzazione della lista completa delle pubblicazioni

Per migliorare le applicazioni (online o offline), puoi in qualsiasi momento recuperare l'insieme delle pubblicazioni disponibili sulla piattaforma Edigita. Trovi qui sotto una descrizione dei vari modi di connessione.

5.1 : Lista semplificata delle pubblicazioni (Formato XML)

La lista semplificata è aperta al pubblico e permette di recuperare dati di base su ogni libro disponibile. E' possibile accedere alla lista tramite l'indirizzo:

http://edigita.cantook.net/publications.xml?since=[date]
Parametro Obbligatorio Descrizione
date
No
Data limite. La lista contiene tutte le pubblicazioni che sono state inserite o modificate dopo tale data. La data deve essere espressa nel formato AAAAMMGGOOMMSS. Per esempio, per il 21 ottobre 2009 alle 13:15, la data verrà scritta come 20091021131500.

Puoi trovare una descrizione dei valori ritornati nell'allegato 2. Per informazioni più specifiche sulla struttura dei file XML scarica il DTD (http://edigita.cantook.net/api/publications_simplified.dtd).

5.2 : Lista completa delle pubblicazioni (Formato XML)

La lista completa contiene la maggioranza dei metadati supportati dalla piattaforma di Edigita. L'accesso alla lista è limitato, per accederci è necessario fornire il proprio nome utente e password.

Al momento 3 linguaggi (Ruby, PHP, ASP) possono essere utilizzati per la connessione. Altri linguaggi saranno aggiunti in futuro.

5.2.1 : Connessione con Ruby

Scarica la libreria bridge.rb (http://edigita.cantook.net/api/bridge-rb.zip).

require 'bridge'
bridge = Bridge.new('edigita.cantook.net', '[nome_utente]', '[password]')
puts bridge.get_xml_publications('[date]')

5.2.2 : Connessione con PHP

Scarica la libreria bridge.php (http://edigita.cantook.net/api/bridge-php.zip).

<?php include("bridge.php"); ?>
<?php
$bridge_connexion = new BridgeConnexion();
$bridge_connexion->set_connexion("edigita.cantook.net", "[nome_utente]",
"[password]");
echo $bridge_connexion->get_xml_publications("[date]");
?>

5.2.3 : Connessione con ASP

Scarica la libreria bridge.asp (http://edigita.cantook.net/api/bridge-asp.zip).

<!-- #include file="bridge.asp"-->
<%
dim bridge_connexion : set bridge_connexion = new BridgeConnexion
bridge_connexion.set_connexion "edigita.cantook.net", "[nome_utente]", "[password]"
response.write bridge_connexion.get_xml_publications("[date]")
%>

Nonostante le differenze di linguaggio, tutti i parametri hanno lo stesso significato.

Parametro Obbligatorio Descrizione
nome_utente
Si
Il tuo nome utente su Edigita
password
Si
La tua password
date
Si
Data limite. La lista contiene tutte le pubblicazioni che sono state inserite o modificate dopo tale data. La data deve essere espressa nel formato AAAAMMGGOOMMSS. Per esempio, per il 21 ottobre 2009 alle 13:15, la data verrà scritta come 20091021131500.

Puoi trovare una descrizione dei valori ritornati nell'allegato 2. Per informazioni più specifiche sulla struttura dei file XML scarica il DTD (http://edigita.cantook.net/api/publications_complete.dtd).

5.3 : Lista completa delle pubblicazioni (Formato ONIX)

Visualizzazione in formato ONIX della lista completa delle pubblicazioni e gran parte dei metadati disponibili.

http://edigita.cantook.net/publications.onix

5.4 : Filo RSS

Consultazione sommaria in formato RSS della lista completa delle pubblicazioni. Comprende titolo, editore, EAN cartaceo, PDF e ePub. E' possibile cliccare sui titoli per visualizzare la pubblicazione.

http://edigita.cantook.net/publications.rss

5.5 : Pubblicazione specifica (Formato XML)

Conferma la disponibilità di una pubblicazione specifica, visualizzazione sommaria in formato XML. Il codice EAN utilizzato deve essere quello della pubblicazione ricercata, senza spazi ne trattini. Sono visualizzate informazioni come il titolo, l'editore e i codici EAN delle versioni cartacea, PDF e ePub.

http://edigita.cantook.net/publications/9782081234048.xml

5.6 : Sfoglialibro (applicazione Flipbook)

Consultazione della pubblicazione nell'applicazione sfoglialibro, visualizzazione del sommario se disponibile e formulario d'integrazione del sfoglialibro su qualsiasi sito web. Il codice EAN utilizzato deve essere quello della pubblicazione consultata, senza spazi ne trattini:

http://edigita.cantook.net/p/9782081234048

Allegato 1

Per visualizzare i metadati, puoi utilizzare 2 elementi: i valori e i contenitori.

I valori sono dei metadati (titolo, prezzo, autore, genere, ecc), mentre i contenitori sono dei tag che permettono di visualizzare o nascondere elementi, a seconda della loro disponibilità. I contenitori sono molto utili, fanno in modo che quando il gateway non trova contenuti associati alla struttura (per esempio, quando una pubblicazione non esiste in formato ePub) il cliente non veda una scheda piena di campi vuoti.

Il primo esempio descrive l'utilizzo semplice di un valore.

<div id="edgt-wrap-9781234567890" class="edgt-wrap">
<span class="edgt-pdf-cost">&nbsp;</span>
</div>
  • Riga 1: il gateway controlla che la pubblicazione 9781234567890 esiste. Questa riga è il contenitore che contiene tutti gli elementi legati alla pubblicazione.
  • Riga 2: metadato. Il gateway sostituisce il suo contenuto con il prezzo di vendita della versione PDF.

Ecco un secondo esempio per illustrare l'utilizzo del contenitore.

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

</div>
</div>
  • Riga 1: Il gateway controlla che la pubblicazione 9781234567890 esiste.
  • Riga 2: Contenitore. Nel caso la pubblicazione non fosse disponibile in formato PDF, il contenitore e il suo contenuto saranno nascosti.
  • Riga 3: Testo che contiene un metadato. Il gateway sostituisce il contenuto dello span "edgt-pdf-cost" con il prezzo di vendita della versione pdf.

Questo esempio dimostra bene l'importanza dei contenitori. Nel caso la pubblicazione 9781234567890 non esista in versione PDF, il testo "Versione PDF:" sarà nascosto.

I contenitori

Nota: tutti i contenitori hanno il prefisso "edgt-wrap-" questo è stato omesso per semplificare la lettura.

Parametro Descrizione
pdf Il PDF esiste ed è disponibile per la vendita
pdf-no-acs4 Il PDF esiste, è disponibile per la vendita e non è esclusivamente protetto da DRM ACS4.
pdf-image-only Il PDF è stato creato solo a partire da immagini.
epub L'ePub esiste ed è disponibile per la vendita.
epub-no-acs4 L'ePub esiste, è disponibile per la vendita e non è esclusivamente protetto da DRM ACS4.
epub-image-only L'ePub è stato creato solo a partire da immagini.
authors C'è almeno un autore
not-found La pubblicazione non esiste su Edigita

I valori

Ad ogni valore è associato un contenitore dello stesso nome. Ad esempio, il valore "edgt-summary" ha un contenitore chiamato "edgt-wrap-summary". Nel caso il summary fosse vuoto, il contenitore "edgt-wrap-summary" sarà nascosto.

Nota: tutti i valori hanno il prefisso "edgt-" questo è stato omesso per semplificare la lettura.

Parametro Descrizione
title Titolo principale
summary Riassunto
tags Parole chiave associate al contenuto
authors-name Nome completo del o degli autori
language Lingua della pubblicazione
translated-from Lingua di origine
pdf-cost Prezzo di vendita del PDF
epub-cost Prezzo di vendita del ePub

Allegato 2

Valori ritornati dalla lista semplicata XML (4.1)

Parametro Descrizione
title Titolo della pubblicazione
publisher Casa editrice
authors Lista del o degli autori
format.nature Nome del formato disponibile. Valori possibili: paper, pdf, epub
format.key_type Tipo d'identificatore. Valori possibili: ean, isbn, custom
format.value Valore dell'identificatore. Esempio 9780123456789.

Valori ritornati dalla lista completa XML (4.2)

Parametro Descrizione
last_update Ultimo aggiornamento
last_state_change Data dell'ultimo cambiamento di stato (online/ offline)
publisher Casa editrice
title.main Titolo della pubblicazione
title.sortable Titolo per ordinare (l'articolo determinativo è posposto)
title.prefix Sopratitolo
title.prefix_no Numero parte del sopratitolo
title.subtitle Sottotitolo
summary Riassunto della pubblicazione
comments Commenti
presentation Presentazione complementare
tags Parole chiave separate da ";"
language Codice ISO 639-1 della lingua della pubblicazione (fr, en, zh).
translated_from Codice ISO 639-1 della lingua di origine (fr, en, zh).
original_text Imposta il valore a 1 se il testo è nella sua integralità
website Sito web correlato alla pubblicazione
age.min Età minima del lettore
age.max Età massima del lettore
nbr_pages Numero di pagine
prefix.roman Numero di pagine con numeri romani all'inizio della pubblicazione
prefix.blank Numero di pagine non numerate all'inizio della pubblicazione. Esempio: 2 se la prima e l'ultima di copertina non sono numerate.
contributor.first_name Nome del contributore
contributor.last_name Cognome del contributore
contributor.nature Tipo di contributo. Valori possibili: author, composer, editor, illustrator, narrator, photograph, postface_writer, preface_writer, translator
contributor.biography Biografia del contributore
contributor.website Sito web del contributore
collection.title Titolo della collana
collection.title_sort Titolo per ordinare la collana (l'articolo determinativo è posposto)
collection.nature Tipo di collana. Valori possibili: collana, serie, volume
collection.position Posizione nella collana. Esempio: 2 per indicare il secondo volume di 3 volumi.
media.title Titolo del multimedia
media.nature Tipo di elemento multimediale. Valori possibili: contributor_interview, back_cover, cover_other, front_cover, review, trailer
media.version.size Dimensioni del multimedia
media.version.path URL del multimedia
format.nature Nome del formato disponibile. Valori possibili: paper, pdf, epub
format.key_type Tipo d'identificatore. Valori possibili: ean, isbn, custom
format.value Valore dell'identificatore. Esempio 9780123456789.
format.protection Tipo di protezione del formato. Valori possibili: acs4, watermark, open
format.image_only Imposta il valore a 1 se il PDF o ePub è stato creato solo a partire da immagini.
format.issued_on Data di pubblicazione in formato AAAAMMGG (20090322)
format.excerpt Imposta il valore a 1 se il documento è solo un estratto dell'originale.
format.comments Commenti relativi a questo specifico formato
format.state Stato del formato. Valori possibili: view, sell
cost.region Prezzo di vendita valido soltanto per questa regione. Valori possibili: europe, quebec
cost.currency Codice ISO 4217 della valuta (eur, cad, usd)
cost.amount Costo approssimato al centesimo. Esempio: 1999 = 19,99.