Application Programming Interface (v.1)
- URL
- https://
dotepub.com /v1/post - Supported request method
- POST.
- Response formats
- EPUB, MOBI, XML (on error).
- Authentication Required
- False.
- Rate Limit
- 30 requests per hour from the same host IP. You are strongly encouraged to cache the generated e-book.
- Parameters
html (required)
Format: Any well-formed UTF-8 XHTML fragment.
Description: It will be the content of the e-book. It must be a text of less than 300 Kb. Some typical accepted tags are:
div
,p
,em
,strong
,blockquote
,ul
,ol
,li
... dotEPUB will not check the validity of the XHTML.title (required)
Format: UTF-8 text.
Description: This text will be used as the title of the e-book.
url (required)
Format: An http URI.
Description: It is the webpage address of the original content. It should point to the same domain and directories where the POST was originated.
lang
Valid values: en (default), es, ca.
Description: It is the language of the texts provided by dotEPUB. Currently, only English, Spanish and Catalan are supported.
author
Format: UTF-8 text.
Description: It is an optional author name to be shown in the cover of the e-book and in the metadata.
copy
Format: UTF-8 text.
Description: It is an optional copyright notice to be shown in the cover of the e-book.
format
Valid values: epub (default), mobi
Description: It is the format of the resulting e-book. By default (format unspecified or wrong value), an EPUB e-book will be produced. Use mobi to request a MOBI e-book.
- Response
- On success, an e-book will be sent. Depending on the specified format, the e-book will be an EPUB file (for EPUB-compatible e-readers like the Sony Reader, the Nook, the Kobo eReader or Apple’ iBooks) or a MOBI file (for Amazon Kindle). On error, an XML document will be returned with the following structure:
<Errors>
<Error>
<Code>WMethod</Code>
<Message xml:lang="en">
Wrong method: Only POST is accepted.
</Message>
</Error>
</Errors> - Error codes:
- WMethod: Wrong method: Only POST is accepted.
- WURL: Wrong webpage address.
- CBig: Content too big.
- Missing: Required information ({parameter name}) was not passed or couldn't be retrieved.
- Unknown: Unknown error.
Disclaimer
This software is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.