Dokumentácia API - Články
Základné informácie
Základné informácie k API, autentizácii, stavovým kódom, HTTP metódam, dátovým typom a ďalšie nájdete na API v2 základné informácie.
Zoznam článkov
- URI: /api/v2/articles
- HTTP metóda: GET
- hlavičky:
- Authorization: Basic dGVzdDp0ZXN0
- Content-Type: application/json
- parametre - slúžia pre filtrovanie výstupu:
- creation_time_from (date) - len články vytvorené od zadaného dátumu
- last_update_time_from (date) - len články, pri ktorých došlo k zmene od zadaného dátumu
- active_yn (bool) - aktívne / neaktívne
- language (language) - jazyk
- id (int) - id konkrétneho článku
- category_code (string) - len články patriace do kategórie s kódom
- with_subcategories_yn (bool) - špecifikácie filtra category_code, rozširuje aj o články z podkategórie
- page (int) - stránka, pokiaľ nie je definované, vracia vždy stranu 1
Odpoveď
Zoznam článkov je dostupný po jednotlivých stranách. Výstup je obmedzený na 100 položiek na stránku.
- telo:
- current_page (int) - aktuálna strana
- current_page_items (int) - počet položiek na aktuálnej strane
- number_of_pages (int) - celkový počet strán
- number_of_items (int) - celkový počet položiek
- articles (array) - pole objektov s článkami
- article_id (int) - ID článku
- active_yn (date) - zobraziť článok na webe
- creation_time (date) - čas vytvorenia článkov
- last_update_time (date) - čas poslednej aktualizácie
- descriptions (array) - pole objektov s textom
- language (language) - špecifikácie jazykovej mutácie
- title (string) - názov článku
- short_description (string) - krátky popis, bez HTML formátovania
- long_description (string) - dlhý popis, môže obsahovať formátovanie len pomocou HTML značiek
- url (string) - URL adresa článku
- images (array) - pole objektov s obrázkami
- url (string) - URL adresa obrázka
- main_yn (bool) - hlavný obrázok
- list_yn (bool) - zoznamový obrázok
- position (int) - pozícia obrázka
- metas (array) - pole objektov s vlastnými poľami článkov
- key (string) - kľúč vlastného poľa
- type (string) - typ vlastného poľa (hodnoty môžu byť: radio, checkbox, input, date, e-mail, number, select, multiselect, textarea, formatted)
- value (string) - hodnota vlastného poľa, v prípade kedy je hodnota vlastného poľa spoločná pre všetky jazyky
- values (array) - pole objektov s hodnotami, v prípade kedy nie je hodnota vlastného poľa spoločná pre všetky jazyky
- language (language) - špecifikácie jazykovej mutácie
- value (string) - hodnota
