Interfície de programació d’aplicacions (v.1)
- URL
- https://
dotepub.com /v1/post - Mètodes de petició acceptats
- POST.
- Formats de resposta
- EPUB, MOBI, XML (en cas d’error).
- Autenticació requerida
- Fals.
- Taxa límit
- 30 peticions per hora des de la mateixa adreça IP de host. Sisplau, procura mantenir una caché de l’e-book generat.
- Paràmetres
html (requerit)
Format: Qualsevol fragment XHTML ben format codificat en UTF-8.
Descripció: Serà el contingut de l’e-book. Ha de ser un text de menys de 300 Kb. Algunes etiquetes típiques acceptades són:
div
,p
,em
,strong
,blockquote
,ul
,ol
,li
... dotEPUB no comprovarà la validesa de l’XHTML.title (requerit)
Format: Text UTF-8.
Descripció: Aquest text serà utilitzat com a títol de l’e-book.
url (requerit)
Format: Un URI de tipus http.
Descripció: És l’adreça de la pàgina web d’on s’ha extret el contingut. Ha d’apuntar al mateix domini i directoris en els quals es va originar el POST.
lang
Valors vàlids: ca, en (valor per defecte), es.
Descripció: És l’idioma dels textos proveïts per dotEPUB. Actualment, només estan contemplats el català, l’anglès i el castellà.
author
Format: Text UTF-8.
Descripció: És el nom opcional de l’autor de l’e-book, el qual es mostrarà a la coberta i serà inclòs a les metadades del llibre.
copy
Format: Text UTF-8.
Descripció: És un avís de copyright opcional que es mostrarà a la coberta de l’e-book.
format
Valors vàlids: epub (valor per defecte), mobi
Descripció: És el format de l’e-book resultant. Per defecte (format no especificat o valor incorrecte), es produirà un e-book EPUB. Utilitza mobi per sol·licitar un e-book en format MOBI.
- Resposta
- En cas d’èxit, s’enviarà un e-book. Depenent del format especificat, l’e-book serà un arxiu EPUB (per a e-readers compatibles amb EPUB com el Sony Reader, el Nook, el Kobo eReader o iBooks d’Apple) o un arxiu MOBI (per a Amazon Kindle). En cas d’error, es retornarà un document XML amb la següent estructura:
<Errors>
<Error>
<Code>WMethod</Code>
<Message xml:lang="ca">
Mètode incorrecte: només POST és acceptat.
</Message>
</Error>
</Errors> - Codis d’error:
- WMethod: Mètode incorrecte: només POST és acceptat.
- WURL: Adreça de pàgina web incorrecta.
- CBig: Contingut massa gran.
- Missing: Una informació requerida ({nom del paràmetre}) no es va proporcionar o no va poder ser recuperada.
- Unknown: Error desconegut.
Renúncia
Aquest programari es distribueix «TAL QUAL», SENSE GARANTIES O CONDICIONS DE CAP TIPUS, ja siguin expresses o implícites.