Vytváření vlastních funkcí API
Funkce se vytváří stejným způsobem jako dotazy Ke stažení, pouze s tím rozdílem, že budou poté dostupné i jako API funkce. Stránka, určená pro správu funkcí API, je dostupná v hlavním menu pod položkami Nastavení / Funkce API.
Funkce budou v API dostupné pod URL parametrem function, který se nastavuje v sekci Výstup jako Název funkce.
Pokud je v dotazu použit parametr, je očekáván při volání API funkce v URL adrese. Funkce vrací vždy pole objektů v JSON s takovými atributy, jako jsou sloupce SELECT dotazu v SQL. Funkce se budou spouštět v transakci, která se na konci provedení dotazu vrátí zpět (rollback), pokud bude dotaz obsahovat nějaké úpravy databáze, nebudou provedeny.
Při volání funkce API jsou data vyhledávána v databázi plusPortal, takže název funkce a parametry funkce jsou case insensitive.
Příklad vytvoření API funkce pro výpis seznamu jmen:
- Ve stránce Funkce API se stiskne tlačítko Přidat funkci API.
- V sekci Označení lze nastavit název, popis a případně ikonu funkce. Tyto informace se budou zobrazovat v seznamu funkcí.
- V sekci Získání dat se napíše dotaz, který se bude provádět.
- V sekci Výstup se nastaví název funkce, pod kterým bude funkce v API dostupná.
- Funkce bude po uložení dostupná v seznamu funkcí, kde si lze (kliknutím na ni) stáhnout CSV soubor.
Jiným příkladem může být vytvoření funkce pro výpis průchodů zaměstnance nebo zaměstnanců. Funkci je potřeba vytvořit stejným způsobem jako v příkladu výše. V tomto případě jsou navíc použity parametry.
Při zavolání funkce je zapotřebí tyto parametry zapsat do URL.
