Postup pri konfigurácii a práci s xml súbormi.

• 1. Registrácia - vytvorenie užívateľského konta.
  • V prípade, že už prebehla, treba pokračovať nasledujúcim krokom.
  • Po vyplnení a odoslaní registračného formulára bude na zadanú emailovú adresu zaslaný potvrdzujúci email pre dokončenie registrácie.
  • Po kliknutí na link z emailu je konto aktivované a je možné sa prihlásiť.
• 2. Prihásenie do užívateľského konta.
• 3. Vyplnenie základných údajov užívateľského konta.
  • V ponuke "profil" vyplniť profil užívateľa.
  • V prípade, že je profil už vyplnený, treba pokračovať nasledujúcim krokom.
  • Potrebné dáta sú:
  • krstné meno
  • priezvisko
  • email
  • ulica
  • mesto
  • PSČ
  • krajina
  • V ponuke "API" je potrebné vytvoriť a uložiť API kľúč pre API requesty. V tejto ponuke sa tiež dá obmedziť prístup k API requestom pomocou IP adries.
  • Pre fungovanie API je potrebné pridať kredit pre konto v ponuke "kredit".
• 4. Vytvorenie nového projektu v ponuke "projekty"=>"nový" vyplnením a odoslaním formulára s názvom projetku a url feedu.
• 5. Konfigurácia projektu v ponuke "projekty"=>"názov projektu".
  • "Meno projektu" umožňuje uložiť projekt pod iným názvom. Ak je zadaný názov už existujúceho projektu, existujúci projekt bude prepísaný bez upozornenia.
  • "Povolený", "Zakázaný" povolí alebo zakáže použitie projektu v API.
  • "Originálna url adresa fedu" umožňuje zmeniť feed, ktorý bude použitý pri vytváraní výstupného súboru. Tlačítko vpravo aktualizuje uloženú štruktúru feedu.
  • "API url" je generovaná adresa výstupného súboru.
  • "Kódovanie výstupu" umožňuje meniť kódovú stránku výstupného súboru.
  • "Výstup po" je voľba spracovania vstupného feedu jedným alebo 2 prechodmi. 2 prechody majú význam len pri použití pamäťových premenných a podmienkach "runtime" v časti "pravidlá". Pamäťové premenné sa môžu spracovávať v oboch prechodoch, feed len v poslednom.
  • "Poslať hlavičky" pošle hlavičky pred výstupom generovaného výstupného súboru. Možnosti:
    • žiadne
    • text/xml
    • application/rss+xml
    • application/rdf+xml
    • application/atom+xml
  • "Pravidlá" slúžia pre nastavenie podmienok spracovania vstupného feedu.
• 6. "originálny feed", "=>", "nový feed":
  • "originálny feed" je načítaná uložená štruktúra vstupného xml súboru, "nový feed" je načítaná uložená štruktúra výstupného xml súboru. Symbol "=>" slúži na opätovné vyplnenie nového feedu z originálneho feedu. Symbol ▼ predstavuje tag s vnorenými tagmi alebo s atribútmi. Symbol A predstavuje atribút tagu. Ak je riadok bez počiatočného symbolu, ide o tag bez vnorených tagov resp. bez atribútov.
  • Manipulácia s novým feedom, používanie pravidiel a premenných sú popísané v ponuke "Dokumentácia".

API volanie:

• URL adresa je "API url", je v každom detaile projektu. API používa metódu POST. Povinný parameter je key, ktorý musí byť vygenerovaný v ponuke "API"
• Príklad volania pomocou curl:
  • curl xxx --data 'key=ZdNvL467qtqTYsQxOhRn'
  • xxx je URL adresa projektu
• Voliteľný parameter je m. Môže byť použitý pre inicializáciu pamäťových premenných. Je to JSON reťazec, kde kľúč je názov premennej a hodnota je jej hodnota.
• Príklad volania pomocou curl:
  • curl xxx --data 'key=ZdNvL467qtqTYsQxOhRn&m={"rrr":"Test"}'
  • xxx je URL adresa projektu, rrr je názov inicializovanej pamäťovej premennej a Test je jej hodnota