info:
description: "## Popis BookUP API\n API slouží pro distribuci digitálního obsahu,\
\ jako jsou e-knihy, nebo audioknihy, umožnuje získání a aktualizaci metadat zboží,\
\ cen, obálek a audio náslechů. Zpřístupňuje zboží ke stažení pro koncové uživatele.\
\ Rozsah dostupného katalogu je závislý na smlouvě o distribuci.\n\nTypy a formáty\
\ poskytované na API\n\n - Audioknihy ve formátu mp3\n - E-knihy ve formátu epub\
\ nebo pdf\n\nTypický průchod na API\n\n 1. Autentizace na API\n 2. Prvotní načtení\
\ kompletního katalogu\n 3. Aktualizace katalogu\n 4. Průběžné reportování prodejů\n\
\ 5. Získání obsahu ke stažení\n\n\n\n## API dokumentace\n\nZde uvádíme obecné\
\ shrnutí a předpoklady pro práci s API. Popis vstupních parametrů, obsah odpovědí\
\ a seznam výjimek/chybových kódů je pak rozepsán u nápovědy jednotlivých metod.\n\
\n### Autentizace\n\n - Je postavena na technologii JWT tokenu.\n - Token je potřeba\
\ generovat pro každé volání všech metod na API.\n - Pro generování tokenu distributor\
\ obdrží potřebné parametry \"jwt_secret\" a \"dist_id\" a které jsou rozdílné\
\ pro testovací a provozní prostředí.\n - Obecný popis technologie naleznete https://jwt.io/.\n\
\ - Ukázkový příklad generování JWT tokenu pro Postman naleznete níže v sekci\
\ příklady.\n\n### Základní rozdělení API\n\nMetody API jsou rozděleny do základních\
\ skupin dle typu obsahu (z důvodu rozdílného datového výstup), nebo účelu použití.\n\
\nSkupiny API metod audiobooks a ebooks fungují v principu stejně, liší se pouze\
\ v názvech v některých metadatech a v detailech stažení některých typů souborů.\n\
\n - Audiobooks slouží k přístupu k datům audioknih.\n\t - `catalogue_export_get_file`\n\
\t - `catalogue_updates`\n\t - `catalogue_updates_ids`\n\t - `catalogue_list`\n\
\ - `download`\n\t - `download_package`\n - `stream_track`\n\n - Ebooks\
\ slouží k přístupu k datům e-knih.\n \t - `catalogue_export_get_file`\n\t - `catalogue_updates`\n\
\t - `catalogue_updates_ids`\n\t - `catalogue_list`\n\t - `download`\n\t - `download_addon`\n\
\n - Reporting slouží k reportování nákupu, či storna objednávky položek a je\
\ společný pro oba typy obsahu.\n\t - `report_payment`\n\t - `report_payment_cancel`\n\
\ - Systémové metody.\n - `ping` může sloužit pro monitoring ze strany partnera.\
\ Pokud by partner použil pro monitoring nevhodné metody, jako získání katalogu,\
\ je zde riziko zablokování přístup na API z důvodu nepřiměřené zátěže.\n \
\ - `categories` vrací seznam všech aktivních kategorií.\n\n## Princip práce s\
\ katalogem\nSystém generuje minimálně jednou každý den export celého katalogu.\
\ Následně existují 2 možnosti jak katalog aktualizovat. Na diagramech jsou zobrazeny\
\ oba postupy průchodu pro získání a aktualizaci katalogu.\n\nAktulálně doporučovaným\
\ přístupem je načtení seznamu změněných ID položek a jejich následné zpracování\
\ pomocí category_list. Tato metoda poskytuje efektivnější přístup ke zpracování\
\ změnových položek a v případě větších změn katalogu, si distributor může tyto\
\ změny zpracovávat po dávkách.\n\n### aktualizace katalogu pomocí seznamu id\
\ (doporučovaný způsob)\n\n```mermaid\nsequenceDiagram\n Partner->>+Bookup:\
\ catalogue_export_get_file\n Bookup->>Partner: URL a čas generování\n note\
\ over Partner: Import dat\n Partner->>Bookup: catalogue_updates()\n Bookup->>Partner:\
\ Id změněných položek\n Partner->>Bookup: catalogue_list()\n Bookup->>Partner:\
\ Metadata požadovaných položek\n note over Partner: Import dat\n```\n### aktualizace\
\ katalogu pomocí přírůstkové metody\n\n```mermaid\nsequenceDiagram\n Partner->>+Bookup:\
\ catalogue_export_get_file\n Bookup->>Partner: URL a čas generování\n note\
\ over Partner: Import dat\n Partner->>Bookup: catalogue_updates()\n Bookup->>Partner:\
\ Metadata požadovaných položek\n note over Partner: Import dat\n```\n\n###\
\ Stažení celého katalogu\n\nVýchozí metoda pro první načtení kompletního katalogu\
\ je `catalogue_export_get_file`. Výstupem je url na JSON soubor s kompletním\
\ katalogem a informací, kdy byl tento soubor naposledy vygenerován a tedy k jakému\
\ datum jsou informace v něm aktuální (generuje se typicky 1x denně mezi 1:00-3:00).\n\
\nPo prvotním importu katalogu je možné používat metody `catalogue_updates_ids`,\
\ `catalogue_list` a `catalogue_updates` pro načtení pouze změněných položek.\
\ Nicméně doporučujeme zkontrolovat pomocí metody `catalogue_export_get_file`\
\ kompletní katalog, alespoň jednou za 14 dní, aby se odstranily případné chyby\
\ způsobené časovými překryvy, případně nějakými většími změnami v katalogu.\n\
\nPři implementaci je potřeba počítat s tím, že s ohledem na typ a množství dostupného\
\ zboží, může mít výsledný JSON soubor velikost v řádech desítek MB.\n\n### Stažení\
\ změn katalogu\n\nZjištění změn v katalogu.\n\nAPI poskytuje dva způsoby, jak\
\ získat informace o aktualizovaném zboží. Aktuálně doporučovaný způsob vrací\
\ datově úsporný seznam ID zboží, který lze pak použít pro získání metadat v metodě\
\ catalogue_list a takovýto seznam lze dle potřeby rozdělit do dávek . Původní\
\ způsob poskytuje plná metadata všech změněnch položek, a v případě vetšího množství\
\ změn, mohou být výstupní data obsáhlá.\n\n\n- aktulální doporučovaný způsob:\n\
\ - `catalogue_updates_ids`\n \t- Vrací seznam ID položek, kterým se v požadovaném\
\ časovém období změnila metadata.\n \t- Maximální doba za kterou lze zpětně\
\ získat informace pomocí této metody je 48h, v opačném případě je potřeba kvůli\
\ změnám načíst kompletní katalog.\n\n - `catalogue_list`\n \t- Následně\
\ je potřeba k seznamu ID položek do načíst konkrétní metadata pomocí volání této\
\ metody.\n \t- Metodu je potřeba volat v dávkách s maximálním počtem 100 ID\
\ najednou.\n \t- U audioknih jsou metadata výrazně větší než u e-knih, proto\
\ je ke zvážení volat dávky s menším počtem ID.\n \t- Tato metoda vrací kompletní\
\ metadata položek .\n \t- V metodě `catalogue_list` je možné použít jakýkoli\
\ seznam ID. (Příkladem využití muže být např. administrace partnera, kde v detailu\
\ zboží lze mít tlačítko na aktualizaci metadat, pak by se tato metoda volala\
\ právě s jedním ID daného zboží).\n\n- původní způsob\n - `catalogue_updates`\n\
\ \t- Vrací metadata položek, kterým se v požadovném časovém období změnila\
\ metadata nebo binární soubory.\n \t- Maximální doba za kterou lze zpětně\
\ získat informace pomocí této metody je 48h, v opačném případě je potřeba kvůli\
\ změnám načíst kompletní katalog.\n \t- U audioknih jsou metadata výrazně\
\ větší než u e-knih.\n \t- Tato metoda vrací kompletní metadata položek.\n\
\n### Stažení souborů k položkám katalogu\nStahování probíhá pomocí metody `download`,\
\ `stream_track`, `download_package` či `download_addon`, které vrací url pro\
\ stažení požadovaného souboru. Většina souborů je k dispozici ihned ke stažení.\
\ Vydané linky mají omezenou platnost a nejsou určeny k ukládání na straně partnera.\
\ Soubory také obsahují DRM, proto je potřeba při žádosti o ně předat relevantní\
\ data.\n\nOdložené stahování:\n\n - Platí jak pro eknihy tak audioknihy pro metody\
\ `download` a `download_package`. (Tzn netýká se streamingu ani addons)\n - Je\
\ potřeba počítat s čekáním na stažení souborů. Soubory jsou připravovány na\
\ straně serveru a může chvíli trvat, než jsou k dispozici ke stažení. To je indikováno\
\ HTTP hlavičkou Retry-After. Typická doba čekání je 5s, ale je závislá na velikosti\
\ souboru. Na API existují soubory větší než jednotky MB jejichž příprava trvá\
\ déle.\n - Výsledná velikost staženého souboru se drobně liší oproti prezentovaným\
\ velikostem souborů v metadatach na API u položek. Rozdíl velikosti je způsoben\
\ přidáním DRM.\n\n\nSpecifika audioknih:\n\n - Pro streaming obsahu slouží link\
\ vygenerovaný pomocí `stream_track`. Link pro jednotlivý track vygenerovaný přes\
\ `download` není určen ke streamingu a v případě využití tímto způsobem se partner\
\ vystavuje riziku nefunkčnosti, či odstavení API.\n - Pokud požadovaný download\
\ obsahuje pouze jeden soubor (přímo track, nebo package s jedním souborem) vrací\
\ se přímo tento soubor bez obalového ZIP kontejneru \n - Aktuálně nevytváříme\
\ v metodách `download` a `download_package` soubory větší než 2GB. Doporučujeme\
\ aby partner respektoval *download_preference* atribut, který indikuje doporučené\
\ rozdělení downloadu.\n - Od r. 2024 mohou mít audioknihy také přiděleno ISBN.\
\ Proto je tento atribut volitelný. Ne všechny starší audioknihy budou mít zpětně\
\ doplněné ISBN. Předpokládáme, že proces doplnění může trvat i několik let,\
\ či dokonce nebude dokončen nikdy.\n\nSpecifika e-knih:\n\n - mobi soubory se\
\ vytvářejí konverzí z formátu epub a jejich příprava proto trvá déle než ostatních\
\ formátů. \n\nDoplňkové soubory (addons)\n\n- Některé zboží může obsahovat doplňkové\
\ soubory, aktuálně se to zatím týká e-knih. Jde typicky o soubory zdarma jako\
\ například testy k učebnicím, nebo audiosoubory.\npro stažení doplňkových souborů\
\ slouží metoda download_addon, doplňkové soubory mohou mít libovolný mime-type\
\ i velikost.\n\n### Omezení počtu žádostí o linky na API\n\nVolání metod `ebooks/download`,\
\ `ebooks/download_addon`, `audiobooks/download` a `audiobooks/download_package`\
\ podléhá omezení počtu žádostí.\n\nHodnoty limitu jsou řízeny interně na straně\
\ serveru a jedná se o globální nastavení pro celé API. Pro unikátní kombinaci\
\ parametrů **user_id, item_id a order_id** je možné odeslat **maximálně 10 požadavků**\
\ v časovém okně **60 sekund**. Při překročení tohoto limitu vrátí API chybovou\
\ odpověď (HTTP status:429 status v json datech odpovědi:429).\n\n### Životní\
\ cyklus linku pro streaming\n\nProces streamingu placeného obsahu využívá odkazy\
\ s dynamickou platností, která je řízena dvěma parametry:\n - Počáteční expirace\
\ (expiration): Určuje, jak dlouho je nově vygenerovaný link platný, než ho uživatel\
\ poprvé použije. (Aktuálně: 24 hodin)\n - Prodloužená expirace (expiration_prolong):\
\ Jakmile uživatel zahájí streaming, původní expirace se nahradí tímto kratším\
\ časovým limitem pro všechny následující požadavky na data. (Aktuálně: 1 hodina)\n\
\nPokud link není využit v rámci těchto dvou po sobě jdoucích časových limitů,\
\ stává se neplatným. Pro pokračování v poslechu je pak vždy nutné prostřednictvím\
\ API vygenerovat nový link.\n\n### Zpracování katalogu pro prezentaci a prodej\n\
\ Jedním z nejdůležitějších aspektů zpracování katalogu a zařazení do nabídky\
\ je vyhodnocení dostupnosti/platnosti licence, cenotvorba, zařazení do stromu\
\ kategorii. Zde jsou popsány obecně, ve větším detailu včetně popisu jednotlivých\
\ hodnot v popisu každé metody.\n\n#### Prodejnost zboží\n\n Je řešena kombinací\
\ hodnot stavu zboží a dostupnosti v čase od a do.\n\n - Zboží k prodeji musí\
\ mít platnou licenci viz \"tabulka dostupnosti\" a jeho stav musí umožnovat prodej\
\ viz \"tabulka stavů\"\n - Zboží k zobrazení v katalogu musí mít platnou licenci\
\ viz \"tabulka dostupnosti\" a jeho stav musí umožnovat zobrazení viz \"tabulka\
\ stavů\".\n\n\nTabulka stavů\n\n| stav | zobrazení | prodej | poznámka|\n|--|--|--|--|\n\
| waiting for acceptance | ne | ne | |\n| active | ano | ano | |\n| cretated\
\ | ne | ne | |\n| canceled | ne | ne | |\n| preparing | ano | ne | |\n\
| presale | ne | ne | aktuálně není definované chování stavu, zatím považováno\
\ za neprodejné, bude definováno v budoucnosti |\n| hidden | ne | ano | |\n\
| sold out | ano | ne | pro digitální zboží nemá význam |\n\n\nTabulka dostupnosti\n\
\n| available_from| available_to | cílový stav| poznámka |\n|--|--|--|--|\n| null|\
\ null | beze změny| |\n| null| v minulosti| neplatná licence| |\n| null| v budoucnosti|\
\ beze změny| |\n| v minulosti| null | beze změny| |\n| v minulosti| v minulosti|\
\ neplatná licence| |\n| v minulosti| v budoucnosti| beze změny| |\n| v budoucnosti|\
\ null | neplatná licence, s výjimkou zobrazení pro stav preparing| |\n| v budoucnosti|\
\ v minulosti| neplatná licence| logicky nedává smysl, kombinace je chybný stav\
\ |\n| v budoucnosti| v budoucnosti| neplatná licence, s výjimkou zobrazení pro\
\ stav preparing| |\n\n\n\n#### Cenotvorba\nCeny se zobrazují v několika variantách\
\ v datech v objektu prices.\n\n - Aktuální cena\n\t - Jedná se o cenu platnou\
\ v okamžik vygenerování metadat zboží, včetně aplikované slevy, pokud existuje\
\ aktivní slevová kampaň.\n\t - Pokud existuje více aktivních kampaní, je aplikována\
\ kampaň s nejvýhodnější cenou.\n - Základní cena\n\t - Může obsahovat několik\
\ cen platných v různých časových úsecích a to i do budoucna.\n - Kampaně\n\t\
\ - Zboží může obsahovat jednu, či více kampaní/slev, které jsou definovány názvem,\
\ platností od, platností do a mechanikou výpočtu ceny ze základní ceny.\n\t -\
\ Zboží muže obsahovat i kampaně definované v budoucnu.\n\nMěna cen - CZK.\n\n\
DPH je nedílnou součástí ceny v daném časovém období.\n\n#### Strom kategorii\n\
\n - Seznam všech kategorií je dostupný v metodě `generic/categories`.\n - Kategorie\
\ v metadatech obsahují svého rodiče.\n - Kategorie první úrovně je obecná kategorie\
\ BookUP v metadatech má jako rodičovskou kategorii \"null\". Pro prezentaci na\
\ webu, by měly sloužit pouze její podkategorie.\n - Strom má aktuálně hloubku\
\ čtyř úrovní, včetně základní kategorie BookUP.\n - Pokud se chystáme kategorii\
\ odstranit je nejdříve označena za deprecated. Taková kategorie se neobjeví ve\
\ výpisu `generic/categories`, ale po přechodnou dobu mohou bude vracena z api\
\ u položek tak, aby bylo možné změnu v kategoriích zohlednit.\n - Nové kategorie\
\ na api mohou přibývat.\n - O změnách v kategoriiích se snažíme partnery individuálně\
\ informovat a děje se to vyjímečně.\n\n#### Párování druhů audioknih a eknih\n\
\nPro párování zboží audiokiha-ekniha lze využít atribut `print_isbns`, který\
\ obsahuje všechna isbn tištěných knih, které korespondují s touto elektronickou\
\ verzí. Obsah tohoto atributu je v současné době omezen vzhledem k dotupným podkladům\
\ od vydavatů, ale bude se v budoucnosti doplňovat. Pokud prodejce prodává i tištěné\
\ varianty knih, může je pomocí tohoto atributu párovat také.\n\n## Reporting\n\
Distributor reportuje prodeje prostřednictvím metody `report_payment` . Uvádí\
\ datum a čas vzniku platby, kdy k tomuto okamžiku je pak prováděna kontrola prodejní\
\ ceny pro vyúčtování. Reportovat prodeje lze nejpozději do 24h po zaplacení,\
\ v opačném případě API vyhlásí chybu. Metoda volitelně přijímá i informaci o\
\ doplňkovém kanále prodeje, kde je možno rozlišit nákupy z aplikace a z webu,\
\ či cokoliv jiného, Tato hodnota se pak v textové formě může objevit ve výůčtování\
\ partnerovi, bez vlivu na výpočet.\n\nMetoda `report_payment` vrací id objednávky\
\ ze seznamu BookUP, partner by se měl toto ID ukládat pro případné párování objednávek\
\ v jeho systému, případně pro případ reklamace.\n\nMetoda `report_payment` umožňuje\
\ vyreportovat testovací objednávku, která bude vyřazena z vyúčtování, Testovací\
\ objednávka musí být označena správným parametrem, viz detailní nápověda metody.\n\
\nReportovanou objednávku je možné zrušit pomocí volání `report_payment_cancel`.\
\ Kdy je vhodné uvádět důvod reklamace z dostupného seznamu popsaného v detailu\
\ této metody, maximálně 24h zpětně.\n\n## Příklady\n#### Autentizace - ukázková\
\ základní implementace JWT pro Postman\n``` javascript\nvar dist_id = pm.environment.get('dist_id')\
\ || ''\nvar secret = pm.environment.get('jwt_secret') || ''\n\nvar pathParts\
\ = pm.request.url.path\n\nvar method = pathParts.join('/')\n\nvar timestamp =\
\ Date.now()/1000;\n\nvar payload = {\n \"exp\": timestamp,\n \"method\"\
: method,\n \"dist_id\": parseInt(dist_id)\n}\n\nvar header = {\n \"alg\"\
: \"HS512\",\n \"typ\": \"JWT\"\n}\nvar result = CryptoJS.enc.Base64.stringify(\n\
\ CryptoJS.enc.Utf8.parse(\n JSON.stringify(header)\n )\n)\nresult\
\ += \".\";\nresult += CryptoJS.enc.Base64.stringify(\n CryptoJS.enc.Utf8.parse(\n\
\ JSON.stringify(payload)\n )\n).replace(/=/g, \"\")\nverify=CryptoJS.HmacSHA512(result\
\ , secret).toString(CryptoJS.enc.Base64).replace(/\\+/g,'-').replace(/\\//g,'_').replace(/\\\
=+$/m,'');\nresult += \".\";\nresult += verify\n\npm.collectionVariables.set('jwt_token',\
\ result)\n```\n\n\n## Možná budoucí rozšíření\n\n - Rozdělení jména autorů na\
\ jméno a příjmení.\n - Přidání metod pro listování číselníků autorů, vydavatelů,\
\ překladatelů a podobně.\n"
license:
name: MIT
title: Bookup api
version: 1.11.2
openapi: 3.0.0
paths:
/audiobooks/catalogue_export_get_file:
post:
description: 'Výchozí metoda pro první načtení kompletního katalogu. Výstupem
je url na JSON soubor s kompletním katalogem a informací, kdy byl tento soubor
naposledy vygenerován a tedy k jakému datum jsou informace v něm aktuální
(generuje se typicky 1x denně mezi 1:00-3:00).
Po prvotním importu katalogu je možné používat metodu `catalogue_updates`
pro načtení pouze změněných položek. Nicméně doporučujeme zkontrolovat pomocí
metody `catalogue_export_get_file` kompletní katalog, alespoň jednou za 14
dní, aby se odstranily případné chyby způsobené časovými překryvy, případně
nějakými většími změnami v katalogu.
Při implementaci je potřeba počítat s tím, že s ohledem na typ a množství
dostupného zboží, může mít výsledný JSON soubor velikost v řádech desítek
MB.
'
requestBody:
content:
application/json:
schema:
properties:
token:
description: Token podle https://jwt.io, HS512, dist_id a secret
obdržíte v rámci zapojení API
type: string
type: object
responses:
'200':
content:
application/json:
schema:
properties:
audiobooks/catalogue_export_get_file:
properties:
last_changed:
description: Čas poslední změny
type: string
url:
description: Url pro stažení katalogu
type: string
required:
- url
type: object
status:
example: 200
type: number
status_message:
example: OK
type: string
type: object
description: OK
'403':
content:
application/json:
examples:
status_0:
summary: Not Authorized
value:
status: 403
status_message: Not Authorized
schema:
oneOf:
- properties:
status:
description: Internal number code
example: 403
type: number
status_message:
description: Error description
example: Not Authorized
type: string
required:
- status
- status_message
type: object
description: Error
'404':
content:
application/json:
examples:
status_0:
summary: Soubor s daty nebyl nalezen
value:
status: 401
status_message: Soubor s daty nebyl nalezen
schema:
oneOf:
- properties:
status:
description: Internal number code
example: 401
type: number
status_message:
description: Error description
example: Soubor s daty nebyl nalezen
type: string
required:
- status
- status_message
type: object
description: Error
summary: Výchozí metoda pro načtení kompletního katalogu.
/audiobooks/catalogue_list:
post:
description: 'Tato metoda vrací kompletní metadata položek.
Metodu je potřeba volat v dávkách s maximálním počtem 100 ID najednou.'
requestBody:
content:
application/json:
schema:
properties:
ids:
description: Seznam ID položek
items:
description: Id položky
minimum: 1
type: integer
type: array
token:
description: Token podle https://jwt.io, HS512, dist_id a secret
obdržíte v rámci zapojení API
type: string
required:
- ids
type: object
responses:
'200':
content:
application/json:
schema:
properties:
audiobooks/catalogue_list:
items:
description: Audiokniha
properties:
authors:
description: Autoři knihy
items:
description: Autor
properties:
id:
description: Id položky
type: integer
name:
description: Jméno
type: string
required:
- id
- name
type: object
type: array
available_from:
description: Dostupné od - řídí prodejnost položky
type: string
available_to:
description: Dostupné do - řídí prodejnost položky
type: string
categories:
description: Kategorie
items:
description: Kategorie
properties:
deprecated:
description: Zastaralá kategorie
type: boolean
id:
description: Id kategorie
type: integer
identification:
description: Název kategorie pro automatické importy
- jedná se o seo název. U deprecated kategoriií
může chybět.
type: string
name:
description: Název kategorie
type: string
parent_category_id:
description: Id nadřazené kategorie
type: integer
required:
- id
- name
- deprecated
type: object
type: array
changed_at:
description: Čas poslední změny
type: string
copyright:
description: Popis autorských práv
type: string
country_of_origin:
description: Země původu
enum:
- cs
- worldwide
nullable: true
type: string
cover:
description: Cover
properties:
file_id:
description: Id souboru
type: integer
location:
description: Veřejná url stažení obrázku
type: string
size:
description: Velikost souboru v bytech
type: integer
required:
- file_id
- location
type: object
created_at:
description: Čas vytvoření
type: string
credits_payment_enabled:
description: Povoleno k prodeji za kredity
type: boolean
description:
description: Popis položky
type: string
download_preference:
description: Doporučený způsob stažení vzhledem k velikosti
dat atp.
collection - lze stáhnout vše najednou
volume - nelze stáhnout jako celek, ale pouze po volume
track - nelze stáhnout jako celek ani volume, ale pouze
po track
enum:
- collection
- volume
- track
type: string
duration:
description: Délka v sekundách
type: integer
ean:
description: Ean
type: string
edition_nr:
description: Pořadové číslo vydání
type: integer
editions:
description: Seznam edicí ve kterých se vyskytuje
items:
properties:
id:
description: Id edice
type: integer
title:
description: Název edice
type: string
required:
- id
- title
type: object
type: array
id:
description: Id položky
type: integer
isbn:
description: Isbn
type: string
narrators:
description: Čte
items:
description: Autor
properties:
id:
description: Id položky
type: integer
name:
description: Jméno
type: string
required:
- id
- name
type: object
type: array
original_title:
description: Původní název položky
type: string
pages:
description: Počet stran tištěné publikace - orientační
type: integer
preview:
description: Preview
properties:
file_id:
description: Id souboru
type: integer
location:
description: Veřejná url pro streaming nebo stažení
type: string
size:
description: Velikost souboru v bytech
type: integer
required:
- file_id
- location
type: object
prices:
properties:
CZK:
description: Struktura pro cenu položky
properties:
actual_price:
description: Aktuální cena včetně případné aktuálně
platné kampaně.
properties:
price:
description: Cena
0=Zdarma
null nebo
-1=neprodejné
type: number
vat_rate:
description: Sazba dph
type: integer
required:
- vat_rate
type: object
base_prices:
items:
description: Base prices of the item
properties:
price:
description: Cena v měně
type: number
valid_from:
description: Platnost od
type: string
valid_to:
description: Platnost do
type: string
vat_rate:
description: Sazba dph
type: integer
required:
- vat_rate
type: object
type: array
campaigns:
items:
properties:
campaign_id:
description: Unikátní id kampaně
type: integer
campaign_type:
description: Typ úpravy ceny, dle typu je
vyplněn jeden z price_ parametrů
enum:
- ratio
- fix
- sub
type: string
name:
description: Název kampaně
type: string
price_fix:
description: Pevná cena
např. base_price=100,
price_fix = 66 => výsledná cena 66
type: number
price_ratio:
description: Snížení v poměru, výsledná cena
se zaokrouhluje na celé koruny nahoru
např. base_price=100, price_sub = 20 =>
výsledná cena 80
type: number
price_sub:
description: Snížení základní ceny
např.
base_price=100, price_ratio = 0.7 => výsledná
cena 70
type: number
valid_from:
description: Platnost od
type: string
valid_to:
description: Platnost do
type: string
required:
- name
- campaign_id
- campaign_type
type: object
type: array
currency:
description: Měna
enum:
- CZK
type: string
required:
- currency
- base_prices
- campaigns
type: object
type: object
print_isbns:
description: Seznam ISBN tištěných vydání
items:
description: Isbn tištěného vydání
type: string
type: array
print_price:
description: Cena tištěného vydání
type: number
publishers:
description: Vydavatelé
items:
description: Autor
properties:
id:
description: Id položky
type: integer
name:
description: Jméno
type: string
required:
- id
- name
type: object
type: array
reading_lang:
description: Jazyk, iso aplha2 kód
type: string
release_date:
description: Datum vydání - informativní hodnota
type: string
series:
description: Seznam sérií ve kterých se vyskytuje
items:
properties:
id:
description: Id série
type: integer
part:
description: Pořadí v sérii
type: integer
title:
description: Název série
type: string
required:
- id
- title
type: object
type: array
size:
description: Orientační velikost souboru je uvedena v bytech
a odpovídá součtu velikostí všech zdrojových souborů kapitol.
Při stažení audioknihy prostřednictvím metody download
se výsledná velikost může lišit v důsledku úpravy ID3
tagů, přidání DRM a případného zabalení do ZIP archivu.
type: integer
state:
description: Stav položky:
waiting_for_acceptance -
neprodejná, nezobrazujeme
active - prodejná, zobrazovat
created - neprodejná, nezobrazujeme
canceled
- neprodejná, nezobrazujeme, ale lze stahovat a zobrazovat v
knihovně
preparing - neprodejná, lze zobrazit v
katalogu
presale - prodejná, zobrazovat, lze stahovat
az po přepnutí do active
hidden - prodejná, nezobrazujeme
sold_out - neprodejná, zobrazujeme jako vyprodáno
enum:
- waiting_for_acceptance
- active
- created
- canceled
- preparing
- presale
- hidden
- sold_out
type: string
subscription_enabled:
description: Povoleno k prodeji v rámci subskripčních balíčků
type: boolean
title:
description: Název položky
type: string
translators:
description: Překladatelé
items:
description: Autor
properties:
id:
description: Id položky
type: integer
name:
description: Jméno
type: string
required:
- id
- name
type: object
type: array
volumes:
description: Volumy
items:
description: Disk
properties:
description:
description: Popis položky
type: string
duration:
description: Délka v sekundách
type: integer
id:
description: Id položky
type: integer
size:
description: Orientační velikost souboru je uvedena
v bytech a odpovídá součtu velikostí všech zdrojových
souborů kapitol. Při stažení audioknihy prostřednictvím
metody download se výsledná velikost může lišit
v důsledku úpravy ID3 tagů, přidání DRM a případného
zabalení do ZIP archivu.
type: integer
state:
description: Stav položky:
waiting_for_acceptance
- neprodejná, nezobrazujeme
active - prodejná,
zobrazovat
created - neprodejná, nezobrazujeme
canceled - neprodejná, nezobrazujeme, ale
lze stahovat a zobrazovat v knihovně
preparing
- neprodejná, lze zobrazit v katalogu
presale
- prodejná, zobrazovat, lze stahovat az po přepnutí
do active
hidden - prodejná, nezobrazujeme
sold_out - neprodejná, zobrazujeme jako vyprodáno
enum:
- waiting_for_acceptance
- active
- created
- canceled
- preparing
- presale
- hidden
- sold_out
type: string
title:
description: Název položky
type: string
tracks:
description: Skladby
items:
description: Track
properties:
authors:
description: Autoři knihy
items:
description: Autor
properties:
id:
description: Id položky
type: integer
name:
description: Jméno
type: string
required:
- id
- name
type: object
type: array
description:
description: Popis položky
type: string
duration:
description: Délka v sekundách
type: integer
id:
description: Id položky
type: integer
narrators:
description: Čte
items:
description: Autor
properties:
id:
description: Id položky
type: integer
name:
description: Jméno
type: string
required:
- id
- name
type: object
type: array
publishers:
description: Vydavatelé
items:
description: Autor
properties:
id:
description: Id položky
type: integer
name:
description: Jméno
type: string
required:
- id
- name
type: object
type: array
size:
description: Orientační velikost souboru je
uvedena v bytech. Při stažení audioknihy v
metodách typu download je velikost souboru
ovlivněna úpravou 3Dtagu a vložením DRM.
type: integer
state:
description: Stav položky:
waiting_for_acceptance
- neprodejná, nezobrazujeme
active -
prodejná, zobrazovat
created - neprodejná,
nezobrazujeme
canceled - neprodejná,
nezobrazujeme, ale lze stahovat a zobrazovat v
knihovně
preparing - neprodejná, lze
zobrazit v katalogu
presale - prodejná,
zobrazovat, lze stahovat az po přepnutí do
active
hidden - prodejná, nezobrazujeme
sold_out - neprodejná, zobrazujeme jako
vyprodáno
enum:
- waiting_for_acceptance
- active
- created
- canceled
- preparing
- presale
- hidden
- sold_out
type: string
title:
description: Název položky
type: string
track_number:
description: Pořadové číslo skladby v disku
type: integer
volume_number:
description: Pořadové číslo disku
type: integer
required:
- id
- title
- state
- volume_number
- track_number
type: object
type: array
volume_number:
description: Pořadové číslo disku
type: integer
required:
- id
- title
- state
- volume_number
- tracks
type: object
type: array
required:
- reading_lang
- download_preference
- volumes
- narrators
- id
- title
- state
- created_at
- changed_at
- publishers
- authors
- translators
- categories
type: object
type: array
status:
example: 200
type: number
status_message:
example: OK
type: string
type: object
description: OK
'403':
content:
application/json:
examples:
status_0:
summary: Vstupní parametry nejsou validní
value:
status: 400
status_message: Vstupní parametry nejsou validní
status_1:
summary: Not Authorized
value:
status: 403
status_message: Not Authorized
schema:
oneOf:
- properties:
status:
description: Internal number code
example: 400
type: number
status_message:
description: Error description
example: Vstupní parametry nejsou validní
type: string
required:
- status
- status_message
type: object
- properties:
status:
description: Internal number code
example: 403
type: number
status_message:
description: Error description
example: Not Authorized
type: string
required:
- status
- status_message
type: object
description: Error
summary: Tato metoda vrací kompletní metadata položek.
/audiobooks/catalogue_updates:
post:
description: 'Tato metoda vrací kompletní metadata položek změněných od předaného
data a času.
Medata jsou zde výrazně větší než u e-knih.
Stahování či streamování binárních souborů následně probíhá pomocí metod `download`,
`download_package`, `stream_track`.
Maximální doba za kterou lze zpětně získat informace pomocí této metody je
48h, v opačném případě je potřeba kvůli změnám načíst kompletní katalog.
Položka je označena za změněnou i v připadě, že došlo k aktualizaci interních
dat, které nejsou na API dostupné. Může se pak z pohledu API jevit jako beze
změny.'
requestBody:
content:
application/json:
schema:
properties:
filters:
properties:
from_time:
description: Datum od - nesmí být starší 48h
type: string
required:
- from_time
type: object
token:
description: Token podle https://jwt.io, HS512, dist_id a secret
obdržíte v rámci zapojení API
type: string
required:
- filters
type: object
responses:
'200':
content:
application/json:
schema:
properties:
audiobooks/catalogue_updates:
items:
description: Audiokniha
properties:
authors:
description: Autoři knihy
items:
description: Autor
properties:
id:
description: Id položky
type: integer
name:
description: Jméno
type: string
required:
- id
- name
type: object
type: array
available_from:
description: Dostupné od - řídí prodejnost položky
type: string
available_to:
description: Dostupné do - řídí prodejnost položky
type: string
categories:
description: Kategorie
items:
description: Kategorie
properties:
deprecated:
description: Zastaralá kategorie
type: boolean
id:
description: Id kategorie
type: integer
identification:
description: Název kategorie pro automatické importy
- jedná se o seo název. U deprecated kategoriií
může chybět.
type: string
name:
description: Název kategorie
type: string
parent_category_id:
description: Id nadřazené kategorie
type: integer
required:
- id
- name
- deprecated
type: object
type: array
changed_at:
description: Čas poslední změny
type: string
copyright:
description: Popis autorských práv
type: string
country_of_origin:
description: Země původu
enum:
- cs
- worldwide
nullable: true
type: string
cover:
description: Cover
properties:
file_id:
description: Id souboru
type: integer
location:
description: Veřejná url stažení obrázku
type: string
size:
description: Velikost souboru v bytech
type: integer
required:
- file_id
- location
type: object
created_at:
description: Čas vytvoření
type: string
credits_payment_enabled:
description: Povoleno k prodeji za kredity
type: boolean
description:
description: Popis položky
type: string
download_preference:
description: Doporučený způsob stažení vzhledem k velikosti
dat atp.
collection - lze stáhnout vše najednou
volume - nelze stáhnout jako celek, ale pouze po volume
track - nelze stáhnout jako celek ani volume, ale pouze
po track
enum:
- collection
- volume
- track
type: string
duration:
description: Délka v sekundách
type: integer
ean:
description: Ean
type: string
edition_nr:
description: Pořadové číslo vydání
type: integer
editions:
description: Seznam edicí ve kterých se vyskytuje
items:
properties:
id:
description: Id edice
type: integer
title:
description: Název edice
type: string
required:
- id
- title
type: object
type: array
id:
description: Id položky
type: integer
isbn:
description: Isbn
type: string
narrators:
description: Čte
items:
description: Autor
properties:
id:
description: Id položky
type: integer
name:
description: Jméno
type: string
required:
- id
- name
type: object
type: array
original_title:
description: Původní název položky
type: string
pages:
description: Počet stran tištěné publikace - orientační
type: integer
preview:
description: Preview
properties:
file_id:
description: Id souboru
type: integer
location:
description: Veřejná url pro streaming nebo stažení
type: string
size:
description: Velikost souboru v bytech
type: integer
required:
- file_id
- location
type: object
prices:
properties:
CZK:
description: Struktura pro cenu položky
properties:
actual_price:
description: Aktuální cena včetně případné aktuálně
platné kampaně.
properties:
price:
description: Cena
0=Zdarma
null nebo
-1=neprodejné
type: number
vat_rate:
description: Sazba dph
type: integer
required:
- vat_rate
type: object
base_prices:
items:
description: Base prices of the item
properties:
price:
description: Cena v měně
type: number
valid_from:
description: Platnost od
type: string
valid_to:
description: Platnost do
type: string
vat_rate:
description: Sazba dph
type: integer
required:
- vat_rate
type: object
type: array
campaigns:
items:
properties:
campaign_id:
description: Unikátní id kampaně
type: integer
campaign_type:
description: Typ úpravy ceny, dle typu je
vyplněn jeden z price_ parametrů
enum:
- ratio
- fix
- sub
type: string
name:
description: Název kampaně
type: string
price_fix:
description: Pevná cena
např. base_price=100,
price_fix = 66 => výsledná cena 66
type: number
price_ratio:
description: Snížení v poměru, výsledná cena
se zaokrouhluje na celé koruny nahoru
např. base_price=100, price_sub = 20 =>
výsledná cena 80
type: number
price_sub:
description: Snížení základní ceny
např.
base_price=100, price_ratio = 0.7 => výsledná
cena 70
type: number
valid_from:
description: Platnost od
type: string
valid_to:
description: Platnost do
type: string
required:
- name
- campaign_id
- campaign_type
type: object
type: array
currency:
description: Měna
enum:
- CZK
type: string
required:
- currency
- base_prices
- campaigns
type: object
type: object
print_isbns:
description: Seznam ISBN tištěných vydání
items:
description: Isbn tištěného vydání
type: string
type: array
print_price:
description: Cena tištěného vydání
type: number
publishers:
description: Vydavatelé
items:
description: Autor
properties:
id:
description: Id položky
type: integer
name:
description: Jméno
type: string
required:
- id
- name
type: object
type: array
reading_lang:
description: Jazyk, iso aplha2 kód
type: string
release_date:
description: Datum vydání - informativní hodnota
type: string
series:
description: Seznam sérií ve kterých se vyskytuje
items:
properties:
id:
description: Id série
type: integer
part:
description: Pořadí v sérii
type: integer
title:
description: Název série
type: string
required:
- id
- title
type: object
type: array
size:
description: Orientační velikost souboru je uvedena v bytech
a odpovídá součtu velikostí všech zdrojových souborů kapitol.
Při stažení audioknihy prostřednictvím metody download
se výsledná velikost může lišit v důsledku úpravy ID3
tagů, přidání DRM a případného zabalení do ZIP archivu.
type: integer
state:
description: Stav položky:
waiting_for_acceptance -
neprodejná, nezobrazujeme
active - prodejná, zobrazovat
created - neprodejná, nezobrazujeme
canceled
- neprodejná, nezobrazujeme, ale lze stahovat a zobrazovat v
knihovně
preparing - neprodejná, lze zobrazit v
katalogu
presale - prodejná, zobrazovat, lze stahovat
az po přepnutí do active
hidden - prodejná, nezobrazujeme
sold_out - neprodejná, zobrazujeme jako vyprodáno
enum:
- waiting_for_acceptance
- active
- created
- canceled
- preparing
- presale
- hidden
- sold_out
type: string
subscription_enabled:
description: Povoleno k prodeji v rámci subskripčních balíčků
type: boolean
title:
description: Název položky
type: string
translators:
description: Překladatelé
items:
description: Autor
properties:
id:
description: Id položky
type: integer
name:
description: Jméno
type: string
required:
- id
- name
type: object
type: array
volumes:
description: Volumy
items:
description: Disk
properties:
description:
description: Popis položky
type: string
duration:
description: Délka v sekundách
type: integer
id:
description: Id položky
type: integer
size:
description: Orientační velikost souboru je uvedena
v bytech a odpovídá součtu velikostí všech zdrojových
souborů kapitol. Při stažení audioknihy prostřednictvím
metody download se výsledná velikost může lišit
v důsledku úpravy ID3 tagů, přidání DRM a případného
zabalení do ZIP archivu.
type: integer
state:
description: Stav položky:
waiting_for_acceptance
- neprodejná, nezobrazujeme
active - prodejná,
zobrazovat
created - neprodejná, nezobrazujeme
canceled - neprodejná, nezobrazujeme, ale
lze stahovat a zobrazovat v knihovně
preparing
- neprodejná, lze zobrazit v katalogu
presale
- prodejná, zobrazovat, lze stahovat az po přepnutí
do active
hidden - prodejná, nezobrazujeme
sold_out - neprodejná, zobrazujeme jako vyprodáno
enum:
- waiting_for_acceptance
- active
- created
- canceled
- preparing
- presale
- hidden
- sold_out
type: string
title:
description: Název položky
type: string
tracks:
description: Skladby
items:
description: Track
properties:
authors:
description: Autoři knihy
items:
description: Autor
properties:
id:
description: Id položky
type: integer
name:
description: Jméno
type: string
required:
- id
- name
type: object
type: array
description:
description: Popis položky
type: string
duration:
description: Délka v sekundách
type: integer
id:
description: Id položky
type: integer
narrators:
description: Čte
items:
description: Autor
properties:
id:
description: Id položky
type: integer
name:
description: Jméno
type: string
required:
- id
- name
type: object
type: array
publishers:
description: Vydavatelé
items:
description: Autor
properties:
id:
description: Id položky
type: integer
name:
description: Jméno
type: string
required:
- id
- name
type: object
type: array
size:
description: Orientační velikost souboru je
uvedena v bytech. Při stažení audioknihy v
metodách typu download je velikost souboru
ovlivněna úpravou 3Dtagu a vložením DRM.
type: integer
state:
description: Stav položky:
waiting_for_acceptance
- neprodejná, nezobrazujeme
active -
prodejná, zobrazovat
created - neprodejná,
nezobrazujeme
canceled - neprodejná,
nezobrazujeme, ale lze stahovat a zobrazovat v
knihovně
preparing - neprodejná, lze
zobrazit v katalogu
presale - prodejná,
zobrazovat, lze stahovat az po přepnutí do
active
hidden - prodejná, nezobrazujeme
sold_out - neprodejná, zobrazujeme jako
vyprodáno
enum:
- waiting_for_acceptance
- active
- created
- canceled
- preparing
- presale
- hidden
- sold_out
type: string
title:
description: Název položky
type: string
track_number:
description: Pořadové číslo skladby v disku
type: integer
volume_number:
description: Pořadové číslo disku
type: integer
required:
- id
- title
- state
- volume_number
- track_number
type: object
type: array
volume_number:
description: Pořadové číslo disku
type: integer
required:
- id
- title
- state
- volume_number
- tracks
type: object
type: array
required:
- reading_lang
- download_preference
- volumes
- narrators
- id
- title
- state
- created_at
- changed_at
- publishers
- authors
- translators
- categories
type: object
type: array
status:
example: 200
type: number
status_message:
example: OK
type: string
type: object
description: OK
'403':
content:
application/json:
examples:
status_0:
summary: Vstupní parametry nejsou validní
value:
status: 400
status_message: Vstupní parametry nejsou validní
status_1:
summary: Not Authorized
value:
status: 403
status_message: Not Authorized
schema:
oneOf:
- properties:
status:
description: Internal number code
example: 400
type: number
status_message:
description: Error description
example: Vstupní parametry nejsou validní
type: string
required:
- status
- status_message
type: object
- properties:
status:
description: Internal number code
example: 403
type: number
status_message:
description: Error description
example: Not Authorized
type: string
required:
- status
- status_message
type: object
description: Error
summary: Tato metoda vrací kompletní metadata položek změněných od předaného
data a času.
/audiobooks/catalogue_updates_ids:
post:
description: 'Tato metoda vrací kompletní metadata položek změněných od předaného
data a času.
Maximální doba za kterou lze zpětně získat informace pomocí této metody je
48h, v opačném případě je potřeba kvůli změnám načíst kompletní katalog.
Položka je označena za změněnou i v připadě, že došlo k aktualizaci interních
dat, které nejsou na API dostupné. Může se pak z pohledu API jevit jako beze
změny.'
requestBody:
content:
application/json:
schema:
properties:
filters:
properties:
from_time:
description: Datum od - nesmí být starší 48h
type: string
required:
- from_time
type: object
token:
description: Token podle https://jwt.io, HS512, dist_id a secret
obdržíte v rámci zapojení API
type: string
required:
- filters
type: object
responses:
'200':
content:
application/json:
schema:
properties:
audiobooks/catalogue_updates_ids:
description: Seznam ID položek
items:
description: Id položky
type: integer
type: array
status:
example: 200
type: number
status_message:
example: OK
type: string
type: object
description: OK
'403':
content:
application/json:
examples:
status_0:
summary: Vstupní parametry nejsou validní
value:
status: 400
status_message: Vstupní parametry nejsou validní
status_1:
summary: Not Authorized
value:
status: 403
status_message: Not Authorized
schema:
oneOf:
- properties:
status:
description: Internal number code
example: 400
type: number
status_message:
description: Error description
example: Vstupní parametry nejsou validní
type: string
required:
- status
- status_message
type: object
- properties:
status:
description: Internal number code
example: 403
type: number
status_message:
description: Error description
example: Not Authorized
type: string
required:
- status
- status_message
type: object
description: Error
summary: Tato metoda vrací kompletní metadata položek změněných od předaného
data a času.
/audiobooks/download:
post:
description: 'Vrací url pro stažení audioknihy, volume nebo tracku. Audiokniha
nebo volume je v ZIP, track přímo. Track nepoužívat pro přímé přehrávání,
na to je streaming. Při opětovném volání je vrácen poslední platný nevyčerpaný
link pro požadovaný formát. V případě, že je formát již vyčerpán nebo není
nalezen platný, je vygenerován nový link.
Je potřeba počítat s čekáním na stažení souborů. Soubory jsou připravovány
na straně serveru a to může chvíli trvat, než jsou k dispozici ke stažení.
To je indikováno HTTP hlavičkou [Retry-After](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After).
Typická doba čekání je 5s, ale je závislá na velikosti souboru. Na API existují
soubory větší než jednotky MB, jejichž příprava trvá déle.
Pro další detaily prosím čtěte sekci **Stažení souborů k položkám katalogu**
v __popisu rozhraní__.'
requestBody:
content:
application/json:
schema:
properties:
item_id:
description: Id tracku, volume nebo audioknihy
type: integer
order_id:
description: Id objednávky - pro DRM
type: string
token:
description: Token podle https://jwt.io, HS512, dist_id a secret
obdržíte v rámci zapojení API
type: string
user_id:
description: Id uživatele - pro DRM
type: string
required:
- item_id
- user_id
- order_id
type: object
responses:
'200':
content:
application/json:
schema:
properties:
audiobooks/download:
description: Url pro stažení
type: string
status:
example: 200
type: number
status_message:
example: OK
type: string
type: object
description: OK
'403':
content:
application/json:
examples:
status_0:
summary: Chyba při downloadu nebo jeho přípravy
value:
status: 407
status_message: Chyba při downloadu nebo jeho přípravy
status_1:
summary: Not Authorized
value:
status: 403
status_message: Not Authorized
schema:
oneOf:
- properties:
status:
description: Internal number code
example: 407
type: number
status_message:
description: Error description
example: Chyba při downloadu nebo jeho přípravy
type: string
required:
- status
- status_message
type: object
- properties:
status:
description: Internal number code
example: 403
type: number
status_message:
description: Error description
example: Not Authorized
type: string
required:
- status
- status_message
type: object
description: Error
summary: Vrací url pro stažení požadovaného souboru.
/audiobooks/download_package:
post:
description: "Vytvoří archiv obsahující požadované položky.\n\nPokud je v archivu\
\ pouze jeden soubor, je vrácen přímo tento soubor bez obalového ZIP kontejneru.\
\ \n\nJe potřeba počítat s čekáním na stažení souborů. Soubory jsou připravovány\
\ na straně serveru a to může chvíli trvat, než jsou k dispozici ke stažení.\
\ To je indikováno HTTP hlavičkou [Retry-After](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After).\
\ Typická doba čekání je 5s, ale je závislá na velikosti souboru. Na API existují\
\ soubory větší než jednotky MB, jejichž příprava trvá déle.\n\nPro další\
\ detaily prosím čtěte sekci **Stažení souborů k položkám katalogu** v __popisu\
\ rozhraní__."
requestBody:
content:
application/json:
schema:
properties:
archive_name:
default: archive.zip
description: Požadovaný název archivu.
type: string
items_ids:
description: Id položek
items:
description: Id tracku, volume nebo audioknihy
type: integer
type: array
order_id:
description: Id objednávky - pro DRM
type: string
token:
description: Token podle https://jwt.io, HS512, dist_id a secret
obdržíte v rámci zapojení API
type: string
user_id:
description: Id uživatele - pro DRM
type: string
required:
- items_ids
- user_id
- order_id
type: object
responses:
'200':
content:
application/json:
schema:
properties:
audiobooks/download_package:
properties:
expiration:
description: Expirace odkazu
type: string
url:
description: Url pro stažení
type: string
required:
- url
- expiration
type: object
status:
example: 200
type: number
status_message:
example: OK
type: string
type: object
description: OK
'403':
content:
application/json:
examples:
status_0:
summary: Chyba při downloadu nebo jeho přípravy
value:
status: 407
status_message: Chyba při downloadu nebo jeho přípravy
status_1:
summary: Not Authorized
value:
status: 403
status_message: Not Authorized
schema:
oneOf:
- properties:
status:
description: Internal number code
example: 407
type: number
status_message:
description: Error description
example: Chyba při downloadu nebo jeho přípravy
type: string
required:
- status
- status_message
type: object
- properties:
status:
description: Internal number code
example: 403
type: number
status_message:
description: Error description
example: Not Authorized
type: string
required:
- status
- status_message
type: object
description: Error
summary: Vytvoří archiv obsahující požadované položky.
/audiobooks/stream_track:
post:
description: 'Vrací url pro streamování požadovaného souboru.
Pro další detaily prosím čtěte sekci **Stažení souborů k položkám katalogu**
v __popisu rozhraní__.'
requestBody:
content:
application/json:
schema:
properties:
item_id:
description: Id tracku
type: integer
token:
description: Token podle https://jwt.io, HS512, dist_id a secret
obdržíte v rámci zapojení API
type: string
required:
- item_id
type: object
responses:
'200':
content:
application/json:
schema:
properties:
audiobooks/stream_track:
properties:
expiration:
description: Expirace odkazu
type: string
url:
description: Url pro streaming
type: string
required:
- url
- expiration
type: object
status:
example: 200
type: number
status_message:
example: OK
type: string
type: object
description: OK
'403':
content:
application/json:
examples:
status_0:
summary: Chyba streamingu
value:
status: 406
status_message: Chyba streamingu
status_1:
summary: Not Authorized
value:
status: 403
status_message: Not Authorized
schema:
oneOf:
- properties:
status:
description: Internal number code
example: 406
type: number
status_message:
description: Error description
example: Chyba streamingu
type: string
required:
- status
- status_message
type: object
- properties:
status:
description: Internal number code
example: 403
type: number
status_message:
description: Error description
example: Not Authorized
type: string
required:
- status
- status_message
type: object
description: Error
summary: Vrací url pro streamování požadovaného souboru.
/ebooks/catalogue_export_get_file:
post:
description: 'Výchozí metoda pro první načtení kompletního katalogu. Výstupem
je url na JSON soubor s kompletním katalogem a informací, kdy byl tento soubor
naposledy vygenerován a tedy k jakému datum jsou informace v něm aktuální
(generuje se typicky 1x denně mezi 1:00-3:00).
Po prvotním importu katalogu je možné používat metodu `catalogue_updates`
pro načtení pouze změněných položek. Nicméně doporučujeme zkontrolovat pomocí
metody `catalogue_export_get_file` kompletní katalog, alespoň jednou za 14
dní, aby se odstranily případné chyby způsobené časovými překryvy, případně
nějakými většími změnami v katalogu.
Při implementaci je potřeba počítat s tím, že s ohledem na typ a množství
dostupného zboží, může mít výsledný JSON soubor velikost v řádech desítek
MB.
'
requestBody:
content:
application/json:
schema:
properties:
partner_id:
description: Id partnera
type: integer
required:
- partner_id
type: object
responses:
'200':
content:
application/json:
schema:
properties:
ebooks/catalogue_export_get_file:
properties:
last_changed:
description: Čas poslední změny
type: string
url:
description: Url pro stažení katalogu
type: string
required:
- url
type: object
status:
example: 200
type: number
status_message:
example: OK
type: string
type: object
description: OK
'403':
content:
application/json:
examples:
status_0:
summary: Not Authorized
value:
status: 403
status_message: Not Authorized
schema:
oneOf:
- properties:
status:
description: Internal number code
example: 403
type: number
status_message:
description: Error description
example: Not Authorized
type: string
required:
- status
- status_message
type: object
description: Error
'404':
content:
application/json:
examples:
status_0:
summary: Soubor s daty nebyl nalezen
value:
status: 401
status_message: Soubor s daty nebyl nalezen
schema:
oneOf:
- properties:
status:
description: Internal number code
example: 401
type: number
status_message:
description: Error description
example: Soubor s daty nebyl nalezen
type: string
required:
- status
- status_message
type: object
description: Error
summary: Výchozí metoda pro načtení kompletního katalogu.
/ebooks/catalogue_list:
post:
description: 'Tato metoda vrací kompletní metadata položek.
Metodu je potřeba volat v dávkách s maximálním počtem 100 ID najednou.'
requestBody:
content:
application/json:
schema:
properties:
ids:
items:
minimum: 1
type: integer
type: array
token:
description: Token podle https://jwt.io, HS512, dist_id a secret
obdržíte v rámci zapojení API
type: string
required:
- ids
type: object
responses:
'200':
content:
application/json:
schema:
properties:
ebooks/catalogue_list:
items:
description: Ekniha
properties:
addons:
description: Doprovodné soubory
items:
properties:
description:
description: Doplňující popisek
type: string
file_size:
description: Velikost v bytech.
type: integer
id:
description: Id souboru
type: integer
mime:
description: Mimetype souboru
type: string
order:
description: Pořadí souboru
type: integer
title:
description: Název
type: string
required:
- id
- order
- title
type: object
type: array
authors:
description: Autoři knihy
items:
description: Autor
properties:
id:
description: Id položky
type: integer
name:
description: Jméno
type: string
required:
- id
- name
type: object
type: array
available_from:
description: Dostupné od - řídí prodejnost položky
type: string
available_to:
description: Dostupné do - řídí prodejnost položky
type: string
categories:
description: Kategorie
items:
description: Kategorie
properties:
deprecated:
description: Zastaralá kategorie
type: boolean
id:
description: Id kategorie
type: integer
identification:
description: Název kategorie pro automatické importy
- jedná se o seo název. U deprecated kategoriií
může chybět.
type: string
name:
description: Název kategorie
type: string
parent_category_id:
description: Id nadřazené kategorie
type: integer
required:
- id
- name
- deprecated
type: object
type: array
changed_at:
description: Čas poslední změny
type: string
copyright:
description: Popis autorských práv
type: string
country_of_origin:
description: Země původu
enum:
- cs
- worldwide
nullable: true
type: string
cover:
description: Cover
properties:
file_id:
description: Id souboru
type: integer
location:
description: Veřejná url stažení obrázku
type: string
size:
description: Velikost souboru v bytech
type: integer
required:
- file_id
- location
type: object
created_at:
description: Čas vytvoření
type: string
credits_payment_enabled:
description: Povoleno k prodeji za kredity
type: boolean
description:
description: Popis položky
type: string
edition_nr:
description: Pořadové číslo vydání
type: integer
editions:
description: Seznam edicí ve kterých se vyskytuje
items:
properties:
id:
description: Id edice
type: integer
title:
description: Název edice
type: string
required:
- id
- title
type: object
type: array
formats:
description: Dostupné formáty pro objednání
properties:
epub:
description: 'EPUB formát '
properties:
download:
properties:
file_size:
description: Přibližná velikost v bytes, nelze
stanovit přesně vzhledem k DRM
type: integer
type: object
ean:
description: Ean
type: string
ident:
description: Formát eknihy
enum:
- epub
- mobi
- pdf_reader
- pdf_a5
- pdf_a4
type: string
isbn:
description: Isbn
type: string
preview:
description: Url na ukázku
properties:
file_id:
description: Id souboru
type: integer
location:
description: Url ukázky
type: string
required:
- file_id
- location
type: object
required:
- ident
- preview
- download
type: object
mobi:
description: Mobi formát
properties:
download:
properties:
file_size:
description: Přibližná velikost v bytes, nelze
stanovit přesně vzhledem k DRM
type: integer
type: object
ean:
description: Ean
type: string
ident:
description: Formát eknihy
enum:
- epub
- mobi
- pdf_reader
- pdf_a5
- pdf_a4
type: string
isbn:
description: Isbn
type: string
preview:
description: Url na ukázku
properties:
file_id:
description: Id souboru
type: integer
location:
description: Url ukázky
type: string
required:
- file_id
- location
type: object
required:
- ident
- preview
- download
type: object
pdf_a4:
description: PDF ve formátu A4
properties:
download:
properties:
file_size:
description: Přibližná velikost v bytes, nelze
stanovit přesně vzhledem k DRM
type: integer
type: object
ean:
description: Ean
type: string
ident:
description: Formát eknihy
enum:
- epub
- mobi
- pdf_reader
- pdf_a5
- pdf_a4
type: string
isbn:
description: Isbn
type: string
preview:
description: Url na ukázku
properties:
file_id:
description: Id souboru
type: integer
location:
description: Url ukázky
type: string
required:
- file_id
- location
type: object
required:
- ident
- preview
- download
type: object
pdf_a5:
description: PDF ve formátu A5
properties:
download:
properties:
file_size:
description: Přibližná velikost v bytes, nelze
stanovit přesně vzhledem k DRM
type: integer
type: object
ean:
description: Ean
type: string
ident:
description: Formát eknihy
enum:
- epub
- mobi
- pdf_reader
- pdf_a5
- pdf_a4
type: string
isbn:
description: Isbn
type: string
preview:
description: Url na ukázku
properties:
file_id:
description: Id souboru
type: integer
location:
description: Url ukázky
type: string
required:
- file_id
- location
type: object
required:
- ident
- preview
- download
type: object
pdf_reader:
description: PDF pro čtečky
properties:
download:
properties:
file_size:
description: Přibližná velikost v bytes, nelze
stanovit přesně vzhledem k DRM
type: integer
type: object
ean:
description: Ean
type: string
ident:
description: Formát eknihy
enum:
- epub
- mobi
- pdf_reader
- pdf_a5
- pdf_a4
type: string
isbn:
description: Isbn
type: string
preview:
description: Url na ukázku
properties:
file_id:
description: Id souboru
type: integer
location:
description: Url ukázky
type: string
required:
- file_id
- location
type: object
required:
- ident
- preview
- download
type: object
type: object
id:
description: Id položky
type: integer
illustrators:
description: Ilustrátoři
items:
description: Autor
properties:
id:
description: Id položky
type: integer
name:
description: Jméno
type: string
required:
- id
- name
type: object
type: array
main_lang:
description: Hlavní jazyk, iso aplha2 kód
type: string
original_title:
description: Původní název položky
type: string
pages:
description: Počet stran tištěné publikace - orientační
type: integer
prices:
properties:
CZK:
description: Struktura pro cenu položky
properties:
actual_price:
description: Aktuální cena včetně případné aktuálně
platné kampaně.
properties:
price:
description: Cena
0=Zdarma
null nebo
-1=neprodejné
type: number
vat_rate:
description: Sazba dph
type: integer
required:
- vat_rate
type: object
base_prices:
items:
description: Base prices of the item
properties:
price:
description: Cena v měně
type: number
valid_from:
description: Platnost od
type: string
valid_to:
description: Platnost do
type: string
vat_rate:
description: Sazba dph
type: integer
required:
- vat_rate
type: object
type: array
campaigns:
items:
properties:
campaign_id:
description: Unikátní id kampaně
type: integer
campaign_type:
description: Typ úpravy ceny, dle typu je
vyplněn jeden z price_ parametrů
enum:
- ratio
- fix
- sub
type: string
name:
description: Název kampaně
type: string
price_fix:
description: Pevná cena
např. base_price=100,
price_fix = 66 => výsledná cena 66
type: number
price_ratio:
description: Snížení v poměru, výsledná cena
se zaokrouhluje na celé koruny nahoru
např. base_price=100, price_sub = 20 =>
výsledná cena 80
type: number
price_sub:
description: Snížení základní ceny
např.
base_price=100, price_ratio = 0.7 => výsledná
cena 70
type: number
valid_from:
description: Platnost od
type: string
valid_to:
description: Platnost do
type: string
required:
- name
- campaign_id
- campaign_type
type: object
type: array
currency:
description: Měna
enum:
- CZK
type: string
required:
- currency
- base_prices
- campaigns
type: object
type: object
print_isbns:
description: Seznam ISBN tištěných vydání
items:
description: Isbn tištěného vydání
type: string
type: array
print_price:
description: Cena tištěného vydání
type: number
publishers:
description: Vydavatelé
items:
description: Autor
properties:
id:
description: Id položky
type: integer
name:
description: Jméno
type: string
required:
- id
- name
type: object
type: array
release_date:
description: Datum vydání - informativní hodnota
type: string
series:
description: Seznam sérií ve kterých se vyskytuje
items:
properties:
id:
description: Id série
type: integer
part:
description: Pořadí v sérii
type: integer
title:
description: Název série
type: string
required:
- id
- title
type: object
type: array
state:
description: Stav položky:
waiting_for_acceptance -
neprodejná, nezobrazujeme
active - prodejná, zobrazovat
created - neprodejná, nezobrazujeme
canceled
- neprodejná, nezobrazujeme, ale lze stahovat a zobrazovat v
knihovně
preparing - neprodejná, lze zobrazit v
katalogu
presale - prodejná, zobrazovat, lze stahovat
az po přepnutí do active
hidden - prodejná, nezobrazujeme
sold_out - neprodejná, zobrazujeme jako vyprodáno
enum:
- waiting_for_acceptance
- active
- created
- canceled
- preparing
- presale
- hidden
- sold_out
type: string
subscription_enabled:
description: Povoleno k prodeji v rámci subskripčních balíčků
type: boolean
title:
description: Název položky
type: string
translators:
description: Překladatelé
items:
description: Autor
properties:
id:
description: Id položky
type: integer
name:
description: Jméno
type: string
required:
- id
- name
type: object
type: array
required:
- main_lang
- illustrators
- id
- title
- state
- created_at
- changed_at
- publishers
- authors
- translators
- categories
type: object
type: array
status:
example: 200
type: number
status_message:
example: OK
type: string
type: object
description: OK
'403':
content:
application/json:
examples:
status_0:
summary: Vstupní parametry nejsou validní
value:
status: 400
status_message: Vstupní parametry nejsou validní
status_1:
summary: Not Authorized
value:
status: 403
status_message: Not Authorized
schema:
oneOf:
- properties:
status:
description: Internal number code
example: 400
type: number
status_message:
description: Error description
example: Vstupní parametry nejsou validní
type: string
required:
- status
- status_message
type: object
- properties:
status:
description: Internal number code
example: 403
type: number
status_message:
description: Error description
example: Not Authorized
type: string
required:
- status
- status_message
type: object
description: Error
summary: Tato metoda vrací kompletní metadata položek.
/ebooks/catalogue_updates:
post:
description: "Tato metoda vrací kompletní metadata položek změněných od předaného\
\ data a času.\n\nStahování binárních souborů následně probíhá pomocí metod\
\ `download` a `download_addon`. \n\nMaximální doba za kterou lze zpětně získat\
\ informace pomocí této metody je 48h, v opačném případě je potřeba kvůli\
\ změnám načíst kompletní katalog.\n\nPoložka je označena za změněnou i v\
\ připadě, že došlo k aktualizaci interních dat, které nejsou na API dostupné.\
\ Může se pak z pohledu API jevit jako beze změny."
requestBody:
content:
application/json:
schema:
properties:
filters:
properties:
from_time:
description: Datum od - nesmí být starší 48h
type: string
required:
- from_time
type: object
token:
description: Token podle https://jwt.io, HS512, dist_id a secret
obdržíte v rámci zapojení API
type: string
required:
- filters
type: object
responses:
'200':
content:
application/json:
schema:
properties:
ebooks/catalogue_updates:
items:
description: Ekniha
properties:
addons:
description: Doprovodné soubory
items:
properties:
description:
description: Doplňující popisek
type: string
file_size:
description: Velikost v bytech.
type: integer
id:
description: Id souboru
type: integer
mime:
description: Mimetype souboru
type: string
order:
description: Pořadí souboru
type: integer
title:
description: Název
type: string
required:
- id
- order
- title
type: object
type: array
authors:
description: Autoři knihy
items:
description: Autor
properties:
id:
description: Id položky
type: integer
name:
description: Jméno
type: string
required:
- id
- name
type: object
type: array
available_from:
description: Dostupné od - řídí prodejnost položky
type: string
available_to:
description: Dostupné do - řídí prodejnost položky
type: string
categories:
description: Kategorie
items:
description: Kategorie
properties:
deprecated:
description: Zastaralá kategorie
type: boolean
id:
description: Id kategorie
type: integer
identification:
description: Název kategorie pro automatické importy
- jedná se o seo název. U deprecated kategoriií
může chybět.
type: string
name:
description: Název kategorie
type: string
parent_category_id:
description: Id nadřazené kategorie
type: integer
required:
- id
- name
- deprecated
type: object
type: array
changed_at:
description: Čas poslední změny
type: string
copyright:
description: Popis autorských práv
type: string
country_of_origin:
description: Země původu
enum:
- cs
- worldwide
nullable: true
type: string
cover:
description: Cover
properties:
file_id:
description: Id souboru
type: integer
location:
description: Veřejná url stažení obrázku
type: string
size:
description: Velikost souboru v bytech
type: integer
required:
- file_id
- location
type: object
created_at:
description: Čas vytvoření
type: string
credits_payment_enabled:
description: Povoleno k prodeji za kredity
type: boolean
description:
description: Popis položky
type: string
edition_nr:
description: Pořadové číslo vydání
type: integer
editions:
description: Seznam edicí ve kterých se vyskytuje
items:
properties:
id:
description: Id edice
type: integer
title:
description: Název edice
type: string
required:
- id
- title
type: object
type: array
formats:
description: Dostupné formáty pro objednání
properties:
epub:
description: 'EPUB formát '
properties:
download:
properties:
file_size:
description: Přibližná velikost v bytes, nelze
stanovit přesně vzhledem k DRM
type: integer
type: object
ean:
description: Ean
type: string
ident:
description: Formát eknihy
enum:
- epub
- mobi
- pdf_reader
- pdf_a5
- pdf_a4
type: string
isbn:
description: Isbn
type: string
preview:
description: Url na ukázku
properties:
file_id:
description: Id souboru
type: integer
location:
description: Url ukázky
type: string
required:
- file_id
- location
type: object
required:
- ident
- preview
- download
type: object
mobi:
description: Mobi formát
properties:
download:
properties:
file_size:
description: Přibližná velikost v bytes, nelze
stanovit přesně vzhledem k DRM
type: integer
type: object
ean:
description: Ean
type: string
ident:
description: Formát eknihy
enum:
- epub
- mobi
- pdf_reader
- pdf_a5
- pdf_a4
type: string
isbn:
description: Isbn
type: string
preview:
description: Url na ukázku
properties:
file_id:
description: Id souboru
type: integer
location:
description: Url ukázky
type: string
required:
- file_id
- location
type: object
required:
- ident
- preview
- download
type: object
pdf_a4:
description: PDF ve formátu A4
properties:
download:
properties:
file_size:
description: Přibližná velikost v bytes, nelze
stanovit přesně vzhledem k DRM
type: integer
type: object
ean:
description: Ean
type: string
ident:
description: Formát eknihy
enum:
- epub
- mobi
- pdf_reader
- pdf_a5
- pdf_a4
type: string
isbn:
description: Isbn
type: string
preview:
description: Url na ukázku
properties:
file_id:
description: Id souboru
type: integer
location:
description: Url ukázky
type: string
required:
- file_id
- location
type: object
required:
- ident
- preview
- download
type: object
pdf_a5:
description: PDF ve formátu A5
properties:
download:
properties:
file_size:
description: Přibližná velikost v bytes, nelze
stanovit přesně vzhledem k DRM
type: integer
type: object
ean:
description: Ean
type: string
ident:
description: Formát eknihy
enum:
- epub
- mobi
- pdf_reader
- pdf_a5
- pdf_a4
type: string
isbn:
description: Isbn
type: string
preview:
description: Url na ukázku
properties:
file_id:
description: Id souboru
type: integer
location:
description: Url ukázky
type: string
required:
- file_id
- location
type: object
required:
- ident
- preview
- download
type: object
pdf_reader:
description: PDF pro čtečky
properties:
download:
properties:
file_size:
description: Přibližná velikost v bytes, nelze
stanovit přesně vzhledem k DRM
type: integer
type: object
ean:
description: Ean
type: string
ident:
description: Formát eknihy
enum:
- epub
- mobi
- pdf_reader
- pdf_a5
- pdf_a4
type: string
isbn:
description: Isbn
type: string
preview:
description: Url na ukázku
properties:
file_id:
description: Id souboru
type: integer
location:
description: Url ukázky
type: string
required:
- file_id
- location
type: object
required:
- ident
- preview
- download
type: object
type: object
id:
description: Id položky
type: integer
illustrators:
description: Ilustrátoři
items:
description: Autor
properties:
id:
description: Id položky
type: integer
name:
description: Jméno
type: string
required:
- id
- name
type: object
type: array
main_lang:
description: Hlavní jazyk, iso aplha2 kód
type: string
original_title:
description: Původní název položky
type: string
pages:
description: Počet stran tištěné publikace - orientační
type: integer
prices:
properties:
CZK:
description: Struktura pro cenu položky
properties:
actual_price:
description: Aktuální cena včetně případné aktuálně
platné kampaně.
properties:
price:
description: Cena
0=Zdarma
null nebo
-1=neprodejné
type: number
vat_rate:
description: Sazba dph
type: integer
required:
- vat_rate
type: object
base_prices:
items:
description: Base prices of the item
properties:
price:
description: Cena v měně
type: number
valid_from:
description: Platnost od
type: string
valid_to:
description: Platnost do
type: string
vat_rate:
description: Sazba dph
type: integer
required:
- vat_rate
type: object
type: array
campaigns:
items:
properties:
campaign_id:
description: Unikátní id kampaně
type: integer
campaign_type:
description: Typ úpravy ceny, dle typu je
vyplněn jeden z price_ parametrů
enum:
- ratio
- fix
- sub
type: string
name:
description: Název kampaně
type: string
price_fix:
description: Pevná cena
např. base_price=100,
price_fix = 66 => výsledná cena 66
type: number
price_ratio:
description: Snížení v poměru, výsledná cena
se zaokrouhluje na celé koruny nahoru
např. base_price=100, price_sub = 20 =>
výsledná cena 80
type: number
price_sub:
description: Snížení základní ceny
např.
base_price=100, price_ratio = 0.7 => výsledná
cena 70
type: number
valid_from:
description: Platnost od
type: string
valid_to:
description: Platnost do
type: string
required:
- name
- campaign_id
- campaign_type
type: object
type: array
currency:
description: Měna
enum:
- CZK
type: string
required:
- currency
- base_prices
- campaigns
type: object
type: object
print_isbns:
description: Seznam ISBN tištěných vydání
items:
description: Isbn tištěného vydání
type: string
type: array
print_price:
description: Cena tištěného vydání
type: number
publishers:
description: Vydavatelé
items:
description: Autor
properties:
id:
description: Id položky
type: integer
name:
description: Jméno
type: string
required:
- id
- name
type: object
type: array
release_date:
description: Datum vydání - informativní hodnota
type: string
series:
description: Seznam sérií ve kterých se vyskytuje
items:
properties:
id:
description: Id série
type: integer
part:
description: Pořadí v sérii
type: integer
title:
description: Název série
type: string
required:
- id
- title
type: object
type: array
state:
description: Stav položky:
waiting_for_acceptance -
neprodejná, nezobrazujeme
active - prodejná, zobrazovat
created - neprodejná, nezobrazujeme
canceled
- neprodejná, nezobrazujeme, ale lze stahovat a zobrazovat v
knihovně
preparing - neprodejná, lze zobrazit v
katalogu
presale - prodejná, zobrazovat, lze stahovat
az po přepnutí do active
hidden - prodejná, nezobrazujeme
sold_out - neprodejná, zobrazujeme jako vyprodáno
enum:
- waiting_for_acceptance
- active
- created
- canceled
- preparing
- presale
- hidden
- sold_out
type: string
subscription_enabled:
description: Povoleno k prodeji v rámci subskripčních balíčků
type: boolean
title:
description: Název položky
type: string
translators:
description: Překladatelé
items:
description: Autor
properties:
id:
description: Id položky
type: integer
name:
description: Jméno
type: string
required:
- id
- name
type: object
type: array
required:
- main_lang
- illustrators
- id
- title
- state
- created_at
- changed_at
- publishers
- authors
- translators
- categories
type: object
type: array
status:
example: 200
type: number
status_message:
example: OK
type: string
type: object
description: OK
'403':
content:
application/json:
examples:
status_0:
summary: Vstupní parametry nejsou validní
value:
status: 400
status_message: Vstupní parametry nejsou validní
status_1:
summary: Not Authorized
value:
status: 403
status_message: Not Authorized
schema:
oneOf:
- properties:
status:
description: Internal number code
example: 400
type: number
status_message:
description: Error description
example: Vstupní parametry nejsou validní
type: string
required:
- status
- status_message
type: object
- properties:
status:
description: Internal number code
example: 403
type: number
status_message:
description: Error description
example: Not Authorized
type: string
required:
- status
- status_message
type: object
description: Error
summary: Tato metoda vrací kompletní metadata položek změněných od předaného
data a času.
/ebooks/catalogue_updates_ids:
post:
description: 'Tato metoda vrací kompletní metadata položek změněných od předaného
data a času.
Maximální doba za kterou lze zpětně získat informace pomocí této metody je
48h, v opačném případě je potřeba kvůli změnám načíst kompletní katalog.
Položka je označena za změněnou i v připadě, že došlo k aktualizaci interních
dat, které nejsou na API dostupné. Může se pak z pohledu API jevit jako beze
změny.'
requestBody:
content:
application/json:
schema:
properties:
filters:
properties:
from_time:
description: Datum od - nesmí být starší 48h
type: string
required:
- from_time
type: object
token:
description: Token podle https://jwt.io, HS512, dist_id a secret
obdržíte v rámci zapojení API
type: string
required:
- filters
type: object
responses:
'200':
content:
application/json:
schema:
properties:
ebooks/catalogue_updates_ids:
description: Seznam ID položek
items:
description: Id položky
type: integer
type: array
status:
example: 200
type: number
status_message:
example: OK
type: string
type: object
description: OK
'403':
content:
application/json:
examples:
status_0:
summary: Vstupní parametry nejsou validní
value:
status: 400
status_message: Vstupní parametry nejsou validní
status_1:
summary: Not Authorized
value:
status: 403
status_message: Not Authorized
schema:
oneOf:
- properties:
status:
description: Internal number code
example: 400
type: number
status_message:
description: Error description
example: Vstupní parametry nejsou validní
type: string
required:
- status
- status_message
type: object
- properties:
status:
description: Internal number code
example: 403
type: number
status_message:
description: Error description
example: Not Authorized
type: string
required:
- status
- status_message
type: object
description: Error
summary: Tato metoda vrací kompletní metadata položek změněných od předaného
data a času.
/ebooks/download:
post:
description: "Vrací url pro stažení požadovaného souboru. \n\nJe potřeba počítat\
\ s čekáním na stažení souborů epub, mobi a pdf. Soubory jsou připravovány\
\ na straně serveru a může chvíli trvat, než jsou k dispozici ke stažení.\
\ To je indikováno HTTP hlavičkou [Retry-After](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After).\
\ Typická doba čekání je 5s, ale je závislá na velikosti souboru. Na API existují\
\ soubory větší než jednotky MB, jejichž příprava trvá déle. Při opětovném\
\ volání je vrácen poslední platný nevyčerpaný link pro požadovaný formát.\
\ V případě, že je formát již vyčerpán nebo není nalezen platný, je vygenerován\
\ nový link.\n\nPro další detaily prosím čtěte sekci **Stažení souborů k položkám\
\ katalogu** v __popisu rozhraní__."
requestBody:
content:
application/json:
schema:
properties:
format:
description: Formát eknihy
enum:
- epub
- mobi
- pdf_reader
- pdf_a5
- pdf_a4
type: string
item_id:
description: Id eknihy
type: integer
order_id:
description: Id objednávky - pro DRM
type: string
token:
description: Token podle https://jwt.io, HS512, dist_id a secret
obdržíte v rámci zapojení API
type: string
user_id:
description: Id uživatele - pro DRM
type: string
required:
- item_id
- user_id
- order_id
- format
type: object
responses:
'200':
content:
application/json:
schema:
properties:
ebooks/download:
description: Url pro stažení
type: string
status:
example: 200
type: number
status_message:
example: OK
type: string
type: object
description: OK
'403':
content:
application/json:
examples:
status_0:
summary: Chyba při downloadu nebo jeho přípravy
value:
status: 407
status_message: Chyba při downloadu nebo jeho přípravy
status_1:
summary: Not Authorized
value:
status: 403
status_message: Not Authorized
schema:
oneOf:
- properties:
status:
description: Internal number code
example: 407
type: number
status_message:
description: Error description
example: Chyba při downloadu nebo jeho přípravy
type: string
required:
- status
- status_message
type: object
- properties:
status:
description: Internal number code
example: 403
type: number
status_message:
description: Error description
example: Not Authorized
type: string
required:
- status
- status_message
type: object
description: Error
'404':
content:
application/json:
examples:
status_0:
summary: Not found
value:
status: 404
status_message: Not found
schema:
oneOf:
- properties:
status:
description: Internal number code
example: 404
type: number
status_message:
description: Error description
example: Not found
type: string
required:
- status
- status_message
type: object
description: Error
'429':
content:
application/json:
examples:
status_0:
summary: Příliš mnoho pořadavků v krátkém časovém úseku
value:
status: 429
status_message: Příliš mnoho pořadavků v krátkém časovém úseku
schema:
oneOf:
- properties:
status:
description: Internal number code
example: 429
type: number
status_message:
description: Error description
example: Příliš mnoho pořadavků v krátkém časovém úseku
type: string
required:
- status
- status_message
type: object
description: Error
summary: Vrací url pro stažení požadovaného souboru.
/ebooks/download_addon:
post:
description: 'Vrací url pro stažení přílohy. Při opětovném volání je vrácen
poslední platný nevyčerpaný link pro požadovaný formát. V případě, že je formát
již vyčerpán nebo není nalezen platný, je vygenerován nový link.
Pro další detaily prosím čtěte sekci **Stažení souborů k položkám katalogu**
v __popisu rozhraní__.'
requestBody:
content:
application/json:
schema:
properties:
file_id:
description: Id souboru
type: integer
item_id:
description: Id eknihy
type: integer
order_id:
description: Id objednávky - pro DRM
type: string
token:
description: Token podle https://jwt.io, HS512, dist_id a secret
obdržíte v rámci zapojení API
type: string
user_id:
description: Id uživatele - pro DRM
type: string
required:
- item_id
- user_id
- order_id
- file_id
type: object
responses:
'200':
content:
application/json:
schema:
properties:
ebooks/download_addon:
description: Url pro stažení
type: string
status:
example: 200
type: number
status_message:
example: OK
type: string
type: object
description: OK
'403':
content:
application/json:
examples:
status_0:
summary: Chyba při downloadu nebo jeho přípravy
value:
status: 407
status_message: Chyba při downloadu nebo jeho přípravy
status_1:
summary: Not Authorized
value:
status: 403
status_message: Not Authorized
schema:
oneOf:
- properties:
status:
description: Internal number code
example: 407
type: number
status_message:
description: Error description
example: Chyba při downloadu nebo jeho přípravy
type: string
required:
- status
- status_message
type: object
- properties:
status:
description: Internal number code
example: 403
type: number
status_message:
description: Error description
example: Not Authorized
type: string
required:
- status
- status_message
type: object
description: Error
'429':
content:
application/json:
examples:
status_0:
summary: Příliš mnoho pořadavků v krátkém časovém úseku
value:
status: 429
status_message: Příliš mnoho pořadavků v krátkém časovém úseku
schema:
oneOf:
- properties:
status:
description: Internal number code
example: 429
type: number
status_message:
description: Error description
example: Příliš mnoho pořadavků v krátkém časovém úseku
type: string
required:
- status
- status_message
type: object
description: Error
summary: Vrací url pro stažení přílohy.
/generic/categories:
post:
description: "Vrací seznam všech aktivních kategorií. \n\nKategorie označené\
\ jako zastaralé (deprecated) se zde neobjeví, ale po přechodnou dobu mohou\
\ být vraceny z api u položek tak, aby bylo možné změnu v kategoriích zohlednit."
requestBody:
content:
application/json:
schema:
properties:
token:
description: Token podle https://jwt.io, HS512, dist_id a secret
obdržíte v rámci zapojení API
type: string
type: object
responses:
'200':
content:
application/json:
schema:
properties:
generic/categories:
description: List kategorií
items:
description: Kategorie
properties:
deprecated:
description: Zastaralá kategorie
type: boolean
id:
description: Id kategorie
type: integer
identification:
description: Název kategorie pro automatické importy - jedná
se o seo název. U deprecated kategoriií může chybět.
type: string
name:
description: Název kategorie
type: string
parent_category_id:
description: Id nadřazené kategorie
type: integer
required:
- id
- name
- deprecated
type: object
type: array
status:
example: 200
type: number
status_message:
example: OK
type: string
type: object
description: OK
'403':
content:
application/json:
examples:
status_0:
summary: Not Authorized
value:
status: 403
status_message: Not Authorized
schema:
oneOf:
- properties:
status:
description: Internal number code
example: 403
type: number
status_message:
description: Error description
example: Not Authorized
type: string
required:
- status
- status_message
type: object
description: Error
summary: !!python/object:checkerslib.checkers.StrChkr
_default: !!python/name:checkerslib.checkers.UNDEFINED ''
_descr: Seznam kategorií
_doc_hidden: null
_regex: null
args: !!python/tuple []
kwargs: {}
optional: false
/generic/ping:
post:
description: Tato metoda může sloužit pro monitoring ze strany partnera.
requestBody:
content:
application/json:
schema:
properties:
token:
description: Token podle https://jwt.io, HS512, dist_id a secret
obdržíte v rámci zapojení API
type: string
type: object
responses:
'200':
content:
application/json:
schema:
properties:
generic/ping:
description: pong
type: string
status:
example: 200
type: number
status_message:
example: OK
type: string
type: object
description: OK
'403':
content:
application/json:
examples:
status_0:
summary: Not Authorized
value:
status: 403
status_message: Not Authorized
schema:
oneOf:
- properties:
status:
description: Internal number code
example: 403
type: number
status_message:
description: Error description
example: Not Authorized
type: string
required:
- status
- status_message
type: object
description: Error
summary: Tato metoda může sloužit pro monitoring ze strany partnera.
/reporting/report_payment:
post:
description: 'Slouží k hlášení prodejů.
Distributor reportuje prodeje nejpozději do 24h po zaplacení, v opačném případě
API vyhlásí chybu.'
requestBody:
content:
application/json:
schema:
properties:
amount:
description: Cena položky včetně dph
type: number
channel:
description: 'Informace o detailu prodejního kanálu Například aplikace/mobil/web.
Může být zobrazena následně ve vyúčtování pro nějaké lepší vyhodnocení.
Po vzájemné dohodě lze hodnotu parametru [channel] využít pro
nápočet interních kampaní, např. prodej z voucheru nabo jiné akce,
která se spočítá jako interní kampaň (tzn. sleva se nezobrazuje
na API jako klasická kampaň, vyhodnocuje se pouze na základě zaslané
hodnoty ''channel''). '
type: string
currency:
description: Měna
enum:
- CZK
type: string
is_test:
description: Jedná se o testovací objednávku, default=False
type: boolean
item_ident:
description: Id položky
type: integer
item_type:
description: Typ položky
enum:
- audiobook
- ebook
type: string
paid_when:
description: Čas vzniku platby, ne starší než 24h
type: string
partner_payment_ident:
description: Id platby partnera. Pokud jedna objednávka obsahuje
více položek , je potřeba každou položku reportovat např. jako
[CLIENT_ORDER_ID]-[ITEM_ID].
type: string
test_reason:
description: Důvod označení platby za testovací pokud je znám
enum:
- reviewer
- development
nullable: true
type: string
token:
description: Token podle https://jwt.io, HS512, dist_id a secret
obdržíte v rámci zapojení API
type: string
vat_rate:
description: Aplikovaná sazba dph, default=0
type: integer
required:
- paid_when
- item_type
- item_ident
- amount
- currency
- vat_rate
type: object
responses:
'200':
content:
application/json:
schema:
properties:
reporting/report_payment:
description: Id platby
type: string
status:
example: 200
type: number
status_message:
example: OK
type: string
type: object
description: OK
'403':
content:
application/json:
examples:
status_0:
summary: Platba již existuje
value:
status: 405
status_message: Platba již existuje
status_1:
summary: Vstupní parametry nejsou validní
value:
status: 400
status_message: Vstupní parametry nejsou validní
status_2:
summary: Not Authorized
value:
status: 403
status_message: Not Authorized
schema:
oneOf:
- properties:
status:
description: Internal number code
example: 405
type: number
status_message:
description: Error description
example: Platba již existuje
type: string
required:
- status
- status_message
type: object
- properties:
status:
description: Internal number code
example: 400
type: number
status_message:
description: Error description
example: Vstupní parametry nejsou validní
type: string
required:
- status
- status_message
type: object
- properties:
status:
description: Internal number code
example: 403
type: number
status_message:
description: Error description
example: Not Authorized
type: string
required:
- status
- status_message
type: object
description: Error
summary: Slouží k hlášení prodejů.
/reporting/report_payment_cancel:
post:
description: 'Slouží ke stornu objednávky. Distributor reportuje storna nejpozději
do 24h po zaplacení
Je vhodné uvádět důvod reklamace z dostupného seznamu.'
requestBody:
content:
application/json:
schema:
properties:
canceled_when:
description: Čas vzniku storna, ne starší než 24h
type: string
payment_id:
description: Id platby
type: string
reason:
default: unknown
description: Důvod zrušení platby
enum:
- unknown
- refund_customer_request
- refund_item_quality
- refund_system_error
nullable: true
type: string
token:
description: Token podle https://jwt.io, HS512, dist_id a secret
obdržíte v rámci zapojení API
type: string
required:
- canceled_when
- payment_id
type: object
responses:
'200':
content:
application/json:
schema:
properties:
reporting/report_payment_cancel:
description: Id zrušení platby
type: string
status:
example: 200
type: number
status_message:
example: OK
type: string
type: object
description: OK
'403':
content:
application/json:
examples:
status_0:
summary: Nelze zrušit již dříve zrušenou platbu
value:
status: 402
status_message: Nelze zrušit již dříve zrušenou platbu
status_1:
summary: Platba nebyla nalezena
value:
status: 404
status_message: Platba nebyla nalezena
status_2:
summary: Vstupní parametry nejsou validní
value:
status: 400
status_message: Vstupní parametry nejsou validní
status_3:
summary: Not Authorized
value:
status: 403
status_message: Not Authorized
schema:
oneOf:
- properties:
status:
description: Internal number code
example: 402
type: number
status_message:
description: Error description
example: Nelze zrušit již dříve zrušenou platbu
type: string
required:
- status
- status_message
type: object
- properties:
status:
description: Internal number code
example: 404
type: number
status_message:
description: Error description
example: Platba nebyla nalezena
type: string
required:
- status
- status_message
type: object
- properties:
status:
description: Internal number code
example: 400
type: number
status_message:
description: Error description
example: Vstupní parametry nejsou validní
type: string
required:
- status
- status_message
type: object
- properties:
status:
description: Internal number code
example: 403
type: number
status_message:
description: Error description
example: Not Authorized
type: string
required:
- status
- status_message
type: object
description: Error
summary: Slouží ke stornu objednávky.
servers:
- description: Api url
url: https://api.bookup.cz/