API

This section is primarily for e-shops that do not use e-shop platforms.

The API allows you to deal with e-books and orders in two ways: the e-shop deals with individual formats, so it needs to know what formats the book supports; and the second approach is to forward the order information. After that, Miguel will sort out everything else.

1. Formats

If you want to offer the best user experience, the ideal solution is to create a user library. Although this option is more complicated than the second one, it is more comfortable for the customer and we recommend it.

Using the endpoint POST /v1/generate_{format}/{book_identifier}, a single file can be created from a single book and the result returns as a query response. Or using the endpoint POST /v1/generate_async_{format}/{book_identifier}, which generates the book asynchronously and delivers the resulting book to the e-shop using a callback and a download link. Both variants already work the same internally and it doesn't matter which one you use (previously there was a difference in stability under heavy workload).

2. Orders

Another way is to send your order information and product list to Miguel. Miguel then creates all available formats from what is uploaded and sends the user an email with links to download the e-books. The endpoint for this method is POST /v1/orders. The email template can be set up in the administration.