API

Tato část je primárně pro e-shopy, které nepoužívají e-shopové platformy.

API umožňuje řešit e-knihy a objednávky dvěma způsoby: e-shop řeší jednotlivé formáty, takže musí vědět jaké formáty kniha podporuje; a druhý přístup je předání informací o objednávce. Následně Miguel vyřeší vše ostatní.

1. Formáty

Pokud chcete uživateli nabídnout co nejlepší UX, ideálním řešením je vytvoření uživatelské knihovničky. Přestože je tato varianta složitější než druhá možnost, je pro zákazníka komfortnější a doporučujeme ji.

Pomocí endpointu POST /v1/generate_{format}/{book_identifier} lze vytvořit jeden soubor z jedné knihy a výsledek se vrací jako odpověď dotazu. Nebo pomocí endpointu POST /v1/generate_async_{format}/{book_identifier}, kterým se generuje kniha asynchronně a výsledná kniha se doručí e-shopu pomocí callbacku a odkazu ke stažení. Obě varianty již fungují uvnitř stejně a je jedno které použijete (dříve tam byl rozdíl ve stabilitě při velké zátěži).

2. Objednávky

Další způsob je poslání informací o objednávce a seznamu produktů do Miguela. Následně Miguel vytvoří všechny dostupné formáty z toho co je nahrané a pošle uživateli e-mail s odkazy pro stažení e-knih. Pro tento způsob je endpoint POST /v1/orders. Šablona pro e-mail lze nastavit v administraci.