Dokumentace API - Články

Základní informace

Základní informace k API, autentizaci, stavovým kódům, HTTP metodám, datovým typům a další najdete na API v2 základní informace

Seznam článků

  • URI: /api/v2/articles
  • HTTP metoda: GET
  • hlavičky:
    • Authorization: Basic dGVzdDp0ZXN0
    • Content-Type: application/json
  • parametry - slouží pro filtrování výstupu:
    • creation_time_from (date) - pouze články vytvořené od zadaného data
    • last_update_time_from (date) - pouze články u kterých došlo ke změně od zadaného data
    • active_yn (bool) - aktivní / neaktivní
    • language (language) - jazyk
    • id (int) - id konkrétního článku
    • category_code (string) - pouze články patřící do kategorie s kódem
    • with_subcategories_yn (bool) - specifikace filtru category_code, rozšiřuje i o články z podkategorie
    • page (int) - stránka, pokud není definováno, vrací vždy stranu 1

Odpověď

Seznam článků je dostupný po jednotlivých stranách. Výstup je omezen na 100 položek na stránku.

  • tělo:
    • current_page (int) - aktuální strana
    • current_page_items (int) - počet položek na aktuální straně
    • number_of_pages (int) - celkový počet stran
    • number_of_items (int) - celkový počet položek
    • articles (array) - pole objektů s články
      • article_id (int) - ID článku
      • active_yn (date) - zobrazit článek na webu
      • creation_time (date) - čas vytvoření článků
      • last_update_time (date) - čas poslední aktualizace
      • descriptions (array) - pole objektů s texty
        • language (language) - specifikace jazykové mutace
        • title (string) - název článku
        • short_description (string) - krátký popis, bez HTML formátování
        • long_description (string) - dlouhý popis, může obsahovat formátování pouze pomocí HTML značek
        • url (string) - URL adresa článku
      • images (array) - pole objektů s obrázky
        • url (string) - URL adresa obrázku
        • main_yn (bool) - hlavní obrázek
        • list_yn (bool) - seznamový obrázek
        • position (int) - pozice obrázku
Na této stránce
Zpět

Další zdroje informací

Facebook poradna

Výměna zkušeností, rady a tipy mezi provozovateli e-shopů na systému UPgates.

Přejít do poradny

Akademie

Získejte znalosti od našich specialistů na marketing, obchod, právo a podnikání.

Přejít do akademie

Novinky z Blogu

Co nového jsme pro vás připravili nebo chystáme najdete na blogu.

Přejít do blogu

Nepodařilo se Vám najít tu správnou odpověď?

Kontaktujte naši technickou podporu, která je tu pro vás od pondělí do pátku 8:00 až 16:00 hod.

Zákaznická podpora