info: description: No description license: name: MIT title: NonameApp version: 0.0.0 openapi: 3.0.0 paths: /cancel_order: post: description: "\n Zruší objednávku\n\n Parametry:\n \ \ str distributor_key distributorův klíč (povinné)\n str\ \ order_id identifikace objednávky (povinné)\n " requestBody: content: application/json: schema: properties: distributor_key: type: string order_id: type: string required: - order_id - distributor_key type: object responses: '200': content: application/json: schema: properties: cancel_order: type: object status: example: 200 type: number status_message: example: OK type: string type: object description: OK summary: Zruší objednávku /category_list: post: description: "\n Vrátí seznam produktů v kategorii\n\n Parametry:\n\ \ str distributor_key distributorův klíč (povinné)\n \ \ str provider název providera (povinné)\n int\ \ category_id id kategorie (povinné)\n int offset \ \ pořadí prvního vypsaného produktu v seznamu\n bool \ \ available_only True a nezadano vrati pouze dostupne polozky\n \ \ False vrati polozky vsech stavu\n \ \ int count počet vypsaných produktů\n filters\ \ filtruje výsledky podle zadaných parametrů\n \ \ (viz níže)\n order řadí výsledek\ \ podle zadaných parametru (viz níže)\n\n order: seznam objektu\n \ \ [{\"column\": ,\n \"ascending\": },\n\ \ ... ]\n povolene hodnoty :\n \ \ \"title\",\n \"release_date\" - datum uvedení do\ \ distribuce\n \"created_date\" - datum nahrávky\n \ \ \"default\"\n je true nebo false\n\n\ \ filters: objekt\n {: , ...}\n\n \ \ : \n \"flag\" : id flagu (produkty s\ \ uvedeným flagem)\n \"flags\" : seznam id flagů, (produkty s\ \ danými flagy)\n \"author\" : jmeno autora (produkty s autory\ \ jejichž jméno obsahuje zadaný\n řetězec)\n \ \ \"type\" : id typu (produkty s daným typem obsahu)\n \ \ \"state\" : id stavu (produkty které jsou v uvedeném stavu)\n \ \ FUNKCNOST MOMENTALNE ZARUCENA JEN PRO core_provider\n\ \ \"last_update\" : čas od kdy chci změněné položky ve formátu\n\ \ \"2015-12-31 23:59:59\"\n (vrátí položky,\ \ které se změnili od zadaném čase)\n \"last_update_price\" :\ \ čas od kdy chci změněné položky ve formátu\n \"2015-12-31\ \ 23:59:59\"\n (vrátí položky, kterým se změnila cena po zadaném\ \ čase)\n \"last_update_meta\" : čas od kdy chci změněné položky\ \ ve formátu\n \"2015-12-31 23:59:59\"\n (vrátí\ \ položky, kterým se změnila metadata po zadaném čase)\n \"last_id\"\ \ : item_id (všechny položky jejichž id je vyšší než zadané)\n \ \ podporováno pouze core_provider\n\n Návratový objekt obsahuje\ \ následující klíče:\n totalCount - obsahuje celkový počet produktů\ \ v kategorii\n content - seznam objektů s informacemi o produktech\ \ vybraných podle\n zadaných parametrů.\n\n \ \ Popis prvků v objektu produktu:\n Všechny prvky nemusí být vyplněny\ \ (závisí na providerovi)\n Některé prvky jsou \"specifické pro\ \ providera\" - většinou se jedná o id.\n Stejné objekty mohou\ \ mít u různých providerů různé id a pod stejným id\n mohou\ \ být u různých providerů různé objekty.\n\n {provider: poskytovatel\ \ produktu\n id: identifikator produktu u poskytovatele (specifické\ \ pro poskytovatele)\n title: objekt s názvem produktu\n \ \ {: název, ...}\n - CZ|SK|EN\n subtitle:\ \ objekt s podtitulem\n {: podtitul, ...}\n \ \ - CZ|SK|EN\n safe_title: objekt se safe title\n \ \ {: safe title, ...}\n - CZ|SK|EN\n \ \ safe title je titulek ze kterého jsou odstraněny háčky a čárky, mezery\n\ \ zaměněny za _ a ponechány pouze alfanumerické znaky a znaky\ \ _-.:\n description: objekt s popisem\n {: popis,\ \ ...}\n - CZ|SK|EN\n release_date: datum vydání\n\ \ available_from: dostupné od data\n available_to: dostupné\ \ do data\n authors: list objektů s informacemi o autorech\n \ \ [{name: jméno autora,\n role: popis role}, ...]\n \ \ previews:list objektů s informacemi o náhledech\n [{name:\ \ název,\n purpose: účel,\n location: link na\ \ umístění}, ...]\n images:list objektů s informacemi o obrázcích\n\ \ [{name: název,\n purpose: účel,\n \ \ location: link na umístění}, ...]\n files:list objektů s informacemi\ \ o stažitelných souborech\n [{name: název,\n purpose:\ \ účel,\n location: link na umístění}, ...]\n flags:\ \ list objektů s popisem přiřazených flagů\n [{id: identifikace\ \ flagu (specifické pro poskytovatele),\n name: název flagu},\ \ ...]\n seznam dostupných flagů pro jednotlivé providery lze\ \ získat pomocí metody\n list_flags()\n categories: list\ \ objektů s popisem kategorií produktu\n [{id: identifikace kategorie\ \ (specifické pro poskytovatele),\n name: název kategorie},\ \ ...]\n types: list objektů popisujících dostupné typy produktu\n\ \ [{type_id: identifikace typu (specifické pro poskytovatele),\n\ \ name: název typu,\n prices: objekt s cenami,\n\ \ {: cena, ... }\n - CZK|EUR\n\ \ měna ceny\n variants: list s objekty\ \ popisující dostupné varianty\n Není-li k dispozici více\ \ variant, pak není tento klíč uveden.\n [{purpose_id: id\ \ varianty (specifické pro poskytovatele),\n purpose:\ \ popis varianty}, ...]\n }, ...]\n klíče file_size\ \ a download_complete:\n tyto klíče mohou být buď ve variants,\ \ nebo v types (pokud variants\n neexistují)\n \ \ file-size reprezentuje velikost downloadovaného obsahu (tedy např.\n\ \ v případě alba součet velikosti jeho tracků)\n \ \ download_complete je True pokud je možné stáhnout daný obsah\ \ na dané\n úrovni najednou (file_size < 2GB)\n \ \ poznámka k typům/variantám:\n Typy reprezentují různé\ \ verze produktu. Např. Dášenka může být\n k dispozici jako\ \ kniha, e-kniha, audiokniha nebo štěně. Typy se\n obvykle\ \ liší provedením a/nebo cenou. Po objednání jednoho typu\n \ \ nejsou objednány typy ostatní (při zakoupení knihy není dodáno\n \ \ automaticky i štěně)\n Varianty odlišují různé\ \ formáty - např e-kniha je k dispozici jako\n mobi, pub,\ \ nebo pdf. Při objednání e-knihy jsou k dispozici všechny\n \ \ její varianty. Pro stáhnutí je však potřeba specifikovat, které\n \ \ varianty jsou k dispozici nebo kterou z nich si chce zákazník\n\ \ stáhnout.\n seznam dostupných typů pro jednotlivé\ \ providery lze získat pomocí metody\n list_types()\n \ \ attributes: objekt atributů\n {length_seconds: délka v sekundách,\n\ \ copyright: copyright,\n popularity: popularita\n\ \ nyní 0, časem škála 1-10\n identification: objekt\ \ s identifikacemi\n {: identifikace, ...}\n \ \ - grid|upc|isrc|ean|cro|generic\n jde\ \ o identifikátor dodavatele, není určem k identifikaci obsahu\n \ \ na tomto rozhraní\n track_number: pořadí tracku\n \ \ volume_number: pořadí volume\n }\n status: stav\ \ produktu\n - presell|available|canceled\n \ \ presell - položka je určena pro předprodej\n \ \ - v rámci předprodeje uživatel získává nárok na dílo v den\n \ \ uvolnění k distribuci, přičemž v rámci předpordeje může\ \ být\n již dostupná část díla ke konzumaci\n \ \ available - určeno k prodeji\n canceled -\ \ není určeno k prodeji, distributor odebere produkt ze svého\n \ \ katalogu\n regions: objekt s popisem jake akce\ \ jsou k dispozici v jakych regionech\n {: {download: True|False,\ \ stream: True|False}, ...}\n - cz|sk|global\n \ \ Položka 'download' určuje práva pro download díla v definovaném teritoriu.\n\ \ Práva pro downownload tracku/kapitoly mají určitá specifika.\n\ \ Pokud je u tracku nastaveno false, je track samostatně neprodjený.\n\ \ Pokud je track nastaven na false a zároveň nastaveno download\n\ \ na úrovni alba na true, takovýto track lze zakoupit pouze\ \ v rámci alba\n Položka 'stream' určuje práva pro streaming v\ \ daném teritoriu\n práva pro streaming se vyskytují u hudby\ \ pouze na úrovni tracku\n campaigns: list objektů s popisem kampaní\n\ \ [{id: id kampaně (specifické pro poskytovatele)\n \ \ name: název kampaně,\n valid_from: kampaň běží od,\n \ \ valid_to: kampaň běží do,\n attributes: objekt\ \ s atributy kampaně,\n price_change: objekt s popisem změn\ \ cen\n {change_type: ,\n typ\ \ změny ceny\n - fix|ratio|sub,\n \ \ fix - dodaná hodnota je výslednou cenou\n \ \ ratio - hodnota, kterou se vynásobí základní cena\n \ \ sub - hodnota se přičte k základní ceně\n \ \ amount: objekt s popisem hodnot\n {: hodnota,\ \ ...},\n - CZK|EUR\n \ \ měna které se změna týká\n types: typy kterých se\ \ kampan tyka,\n }, ...]\n }\n\n Pokud si synchronizujete\ \ katalog, a stav položky je \"canceled\", odeberte\n prosím položku\ \ z vašeho katalogu.\n " requestBody: content: application/json: schema: properties: available_only: type: boolean category_id: type: integer count: type: integer distributor_key: type: string filters: properties: {} type: object offset: type: integer order: items: {} type: array provider: type: string show_details: type: boolean required: - provider - category_id - distributor_key type: object responses: '200': content: application/json: schema: properties: category_list: type: object status: example: 200 type: number status_message: example: OK type: string type: object description: OK summary: Vrátí seznam produktů v kategorii /category_list_nullstream: post: description: "\n Vrací stream produktů. Jednotlivé produkty jsou odděleny\ \ nullbytem 0x00.\n Pro správnou funkci je třeba v hlavičkách uvést\n\ \ Accept: application/json-nullstream\n\n Parametry volání odpovídají\ \ metodě category_list() s následujícími vyjímkami:\n - Jediný povinný\ \ parametr je distributor_key\n - Nejsou dostupné parametry offset\ \ a count\n - Pokud nejsou předány parametry category_id a provider\ \ pak je vrácen obsah\n všech kategorií všech providerů dostupných\ \ distributorovi.\n\n Struktura produktu v odpovědi odpovídá struktuře\ \ odpovědi metody item_detail()\n\n V případě chyby při zpracování\ \ je nullstream ukončen a jako poslední item je\n přidán chybový objekt:\n\ \ {status: kód chyby,\n status_message: popis chyby}\n \ \ " requestBody: content: application/json: schema: properties: available_only: type: boolean category_id: type: integer distributor_key: type: string filters: properties: {} type: object order: items: {} type: array provider: type: string required: - distributor_key type: object responses: '200': content: application/json: schema: properties: category_list_nullstream: type: object status: example: 200 type: number status_message: example: OK type: string type: object description: OK summary: Vrací stream produktů. Jednotlivé produkty jsou odděleny nullbytem 0x00. /changes: post: description: "\n Vrací přehled změn\n " requestBody: content: application/json: schema: type: object responses: '200': content: application/json: schema: properties: changes: type: object status: example: 200 type: number status_message: example: OK type: string type: object description: OK summary: Vrací přehled změn /faq: post: description: "\n Vrací odpovědi na často kladené dotazy\n " requestBody: content: application/json: schema: type: object responses: '200': content: application/json: schema: properties: faq: type: object status: example: 200 type: number status_message: example: OK type: string type: object description: OK summary: Vrací odpovědi na často kladené dotazy /get_event: post: description: '[method description]' requestBody: content: application/json: schema: properties: id: type: string required: - id type: object responses: '200': content: application/json: schema: properties: get_event: type: object status: example: 200 type: number status_message: example: OK type: string type: object description: OK summary: '[method description]' /item_consume: post: description: "\n Vrací link ke stažení produktu\n\n Parametry:\n\ \ str distributor_key distributorův klíč (povinné)\n \ \ str provider provider (povinné)\n str \ \ item_id id produktu ke konzumaci\n str type_id\ \ id požadovaného typu\n str purpose_id id\ \ varianty\n str order_id identifikace objednávky\ \ vůči které se ověřuje\n nákup\n \ \ str user unikátní id uživatele\n \ \ items seznam objektů s údaji o produktech\n \ \ dict request_attrs atributy pro request download\n\n\n Type_id\ \ určuje požadovaný typ.\n Není-ĺi uveden, bere se typ použitý\ \ při objednávce.\n V určitých případech je možné konzumovat i\ \ jiné typy než má zákazník\n zakoupené (např. při zakoupení flac\ \ může být umožněno skladbu získat i\n ve formátu mp3). V takovém\ \ případě je potřeba uvést požadovaný typ.\n Možnost konzumace\ \ jiného než zakoupeného typu se může u jednotlivých\n produktů\ \ lišit. Pro více detailů se, prosím, obraťte na našeho zástupce.\n\n \ \ V případě, že je poskytováno více variant je třeba předat purpose_id\n\ \ (viz. item_detail()). V některých případech má api nadefinovanou\ \ defaultní\n variantu která je použita v případě, že není purpose_id\ \ předáno.\n\n Parametry user a items:\n Musicjet umožňuje\ \ specifikovat stahování více alb/tracků v jednom zipu\n (jinak\ \ než jako součást jednoho alba) - a k tomu slouží parametr items.\n \ \ items: seznam objektů popisující produkty ke stažení\n \ \ [{'item_id': id produktu (povinné),\n 'order_id': id\ \ objednávky pro ověření nákupu}, ...]\n V případě že je při volání\ \ item_consume() uveden parametr items, jsou\n ignorovány parametry\ \ item_id a order_id.\n Pro ověření nákupu je možné uvést buď klíč\ \ order_id u každé položky\n v seznamu items, nebo parametr user\ \ ve volání metody. Pokud je využit\n parametr user, je prohledávána\ \ celá uživatelova knihovna a odpověď bude\n pomalejší.\n \ \ Všechny produkty v balíku budou ve stejném typu/variantě definovanými\n\ \ paremetry type_id a purpose_id.\n V balíku budou zahrnuty\ \ pouze takové produkty ze seznamu items, které budou\n dobře popsány\ \ a vyhodnoceny jako zakoupené. Ostatní budou bez varování\n ignorovány.\ \ Pokud by ke konzumaci nezbyl žádný produkt, je vrácena chyba.\n " requestBody: content: application/json: schema: properties: distributor_key: type: string item_id: type: string items: items: {} type: array order_id: type: string provider: type: string purpose_id: type: string request_attrs: properties: {} type: object type_id: type: string user: type: string required: - distributor_key - provider type: object responses: '200': content: application/json: schema: properties: item_consume: type: object status: example: 200 type: number status_message: example: OK type: string type: object description: OK summary: Vrací link ke stažení produktu /item_detail: post: description: "\n Detailní informace o produktu\n\n Parametry:\n\ \ str distributor_key distributorův klíč (povinné)\n \ \ str provider název providera (povinné)\n \ \ int item_id id produktu (povinné)\n\n Výsledkem je\ \ objekt s informacemi o produktu. Strukturou odpovídá informacím\n \ \ o produktu z výsledku category_list() jen je doplněn o další podrobnosti:\n\ \n items: list objektů popisujících subitemy (např tracky v albu)\n\ \ strukturou odpovídají struktuře výsledku volání item_detail()\n\ \n Pokud si synchronizujete katalog, a stav položky je \"canceled\"\ , odeberte\n prosím položku z vašeho katalogu.\n\n " requestBody: content: application/json: schema: properties: distributor_key: type: string item_id: type: string provider: type: string required: - provider - item_id - distributor_key type: object responses: '200': content: application/json: schema: properties: item_detail: type: object status: example: 200 type: number status_message: example: OK type: string type: object description: OK summary: Detailní informace o produktu /item_order: post: description: "\n Zařadí produkt do uživatelovy knihovny, pokud tam ještě\ \ není.\n\n Parametry:\n str distributor_key distributorův\ \ klíč (povinné)\n str user uživatelovo unikátní\ \ id (povinné)\n str provider poskytovatel produktu\ \ (povinné)\n str item_id id produktu (povinné)\n\ \ str type_id id typu obsahu (povinné)\n \ \ decimal price cena ze kterou je produkt prodavan\ \ (povinné)\n str currency_id id meny (CZK/EUR)(povinné)\n\ \ json custom_attrs libovolné údaje, které chce distributor\n\ \ uložit k objednávce\n \ \ str time čas objednávky ve formátu %Y-%m-%d %H:%M:%S\n\ \ campaign_ids seznam id kampaní, kampaně byly\ \ aplikovány\n v pořadí, v jakém\ \ jsou uvedeny v seznamu\n\n custom_attrs:\n V současné\ \ době jsou používány následující klíče pro účely reportingu:\n \ \ distributor_id_transaction: Unikátní označení transakce distributora\n\ \ distributor_id_item: Unikátní označení položky v katalogu distributora\n\ \ (id alba, audioknihy, tracku, kapitoly, atp.)\n \ \ channel: Kanál, kde byl nákup uskutečněn (např. www, mobil, aplikace,\ \ sms)\n source: Odkud se uživatel dostal k nákupu (např. homepage,\ \ banner,\n kategorie, atp.)\n device: zařízení\ \ (např. desktop,Samsung Galaxy 6, Playstation portable)\n user_agent:\n\ \n Vraci id objednávky.\n " requestBody: content: application/json: schema: properties: campaign_ids: items: {} type: array currency_id: type: string custom_attrs: properties: {} type: object distributor_key: type: string item_id: type: string price: type: number provider: type: string time: type: string type_id: type: string user: type: string required: - provider - item_id - type_id - user - distributor_key - price - currency_id type: object responses: '200': content: application/json: schema: properties: item_order: type: object status: example: 200 type: number status_message: example: OK type: string type: object description: OK summary: Zařadí produkt do uživatelovy knihovny, pokud tam ještě není. /library: post: description: "\n Knihova produktů zakoupených uživatelem\n\n Parametry:\n\ \ str distributor_key distributorův klíč (povinné)\n \ \ str user uživatelovo unikátní id (povinné)\n\n \ \ Výsledkem volání je seznam objektů, které má uživatel zakoupené. Jejich\n\ \ struktura odpovídá struktuře výsledků item_detail(). Navíc jsou doplněny\ \ klíče:\n order_id - id objedvávky\n custom_attrs - údaje,\ \ které si distributor uložil k objednávce\n time - čas vytvoření objednávky\n\ \ " requestBody: content: application/json: schema: properties: distributor_key: type: string user: type: string required: - user - distributor_key type: object responses: '200': content: application/json: schema: properties: library: type: object status: example: 200 type: number status_message: example: OK type: string type: object description: OK summary: Knihova produktů zakoupených uživatelem /list_consume: post: description: '[method description]' requestBody: content: application/json: schema: properties: count: type: integer distributor_id: type: integer extra: properties: {} type: object item_id: type: string offset: type: integer order_id: type: string provider: type: string purpose_id: type: string time_from: type: string time_to: type: string type_id: type: string url: type: string user_id: type: string type: object responses: '200': content: application/json: schema: properties: list_consume: type: object status: example: 200 type: number status_message: example: OK type: string type: object description: OK summary: '[method description]' /list_events: post: description: '[method description]' requestBody: content: application/json: schema: properties: action: type: string count: type: integer extra: properties: {} type: object id: type: string offset: type: integer omit: items: {} type: array time_from: type: string time_to: type: string user_id: type: string type: object responses: '200': content: application/json: schema: properties: list_events: type: object status: example: 200 type: number status_message: example: OK type: string type: object description: OK summary: '[method description]' /list_flags: post: description: "\n Vrátí číselník flagů\n " requestBody: content: application/json: schema: properties: distributor_key: type: string required: - distributor_key type: object responses: '200': content: application/json: schema: properties: list_flags: type: object status: example: 200 type: number status_message: example: OK type: string type: object description: OK summary: Vrátí číselník flagů /list_providers: post: description: "\n Vrátí seznam providerů\n " requestBody: content: application/json: schema: type: object responses: '200': content: application/json: schema: properties: list_providers: type: object status: example: 200 type: number status_message: example: OK type: string type: object description: OK summary: Vrátí seznam providerů /list_states: post: description: "\n Vrátí číselník stavů\n " requestBody: content: application/json: schema: properties: distributor_key: type: string required: - distributor_key type: object responses: '200': content: application/json: schema: properties: list_states: type: object status: example: 200 type: number status_message: example: OK type: string type: object description: OK summary: Vrátí číselník stavů /list_types: post: description: "\n Vrátí číselník typů\n " requestBody: content: application/json: schema: properties: distributor_key: type: string required: - distributor_key type: object responses: '200': content: application/json: schema: properties: list_types: type: object status: example: 200 type: number status_message: example: OK type: string type: object description: OK summary: Vrátí číselník typů /menu_list: post: description: "\n Vrátí seznam kategorií\n\n Parametry:\n \ \ str distributor_key distributorův klíč (povinné)\n \ \ str provider název providera\n\n Vrací seznam objektů:\n\ \ {provider: poskytovatel kategorie\n category_id: id kategorie\ \ v rámci jejího providera (id kategorie určuje\n poskytovatel,\ \ tedy u dvou poskytovatelů mohou být různé kategorie se\n stejným\ \ id),\n name: název kategorie\n childs: seznam podkategorii\ \ (stejná struktura jako rodič)\n }\n\n " requestBody: content: application/json: schema: properties: distributor_key: type: string provider: type: string required: - distributor_key type: object responses: '200': content: application/json: schema: properties: menu_list: type: object status: example: 200 type: number status_message: example: OK type: string type: object description: OK summary: Vrátí seznam kategorií /simple_library: post: description: '[method description]' requestBody: content: application/json: schema: properties: distributor_key: type: string user: type: string required: - user - distributor_key type: object responses: '200': content: application/json: schema: properties: simple_library: type: object status: example: 200 type: number status_message: example: OK type: string type: object description: OK summary: '[method description]' servers: - description: Api url url: http://frontends11-nag:80