API Builder
API Builder slouží k sestavení volání ARAD-REST-API přímo v uživatelském rozhraní. Uživatel nemusí ručně skládat URL ani znát všechny parametry služby.
Builder postupně provede uživatele výběrem služby, konfigurací parametrů, výběrem API klíče a vygenerováním výsledného volání.
1. Výběr služby
V prvním kroku vyberte službu, kterou chcete použít.
Příklady služeb:
| Služba | Účel |
|---|---|
/data | Jednoduchý seznam dat: ukazatel, období, hodnota. |
/data-trans | Data ve tvaru kontingenční tabulky. |
/indicators | Seznam ukazatelů a jejich základní vlastnosti. |
/indicators-dims | Ukazatele popsané bází a dimenzemi. |
/snapshots | Seznam dostupných snímků. |
/indicators-tree | Zařazení ukazatelů ve stromové hierarchii ARAD. |
/updates | Informace o poslední aktualizaci a mezních obdobích časové řady. |
2. Konfigurace parametrů
Po výběru služby se zobrazí formulář pro nastavení parametrů. Dostupné parametry se liší podle zvolené služby.
U datových služeb lze nastavit například:
- identifikaci dat,
- kódy ukazatelů,
- časové období,
- oddělovač sloupců,
- oddělovač desetinných míst,
- seznam snímků,
- řazení období.
Výběr sestavy z modálního okna
API Builder podporuje výběr parametru sestavy z modálního okna se seznamem sestav. Tato funkce usnadňuje práci uživatelům, kteří neznají kód sestavy zpaměti.
3. Výběr API klíče
Pro použití API je nutné vybrat API klíč. API klíč identifikuje uživatele, který službu volá.
Bezpečnost API klíče
API klíč nikdy nevkládejte do veřejné dokumentace, screenshotů, repozitářů ani sdílených ukázek. Ve screenshotech musí být klíč skrytý nebo nahrazený zástupnou hodnotou.
Screenshot k doplnění
Doplnit screenshot: výběr API klíče v API Builderu s anonymizovanou hodnotou klíče.
4. Vygenerované volání API
Po nastavení parametrů API Builder vytvoří připravené volání. Výstup lze zobrazit v několika variantách:
- URL,
- cURL,
- Python,
- R.
Screenshot k doplnění
Doplnit screenshot: vygenerované volání API se záložkami URL, cURL, Python a R.
Předvyplnění API Builderu
API Builder lze předvyplnit přímo z několika míst aplikace:
- z náhledu ukazatele,
- z košíku,
- z části Mé výběry.
Tato funkce zrychluje vytvoření API dotazu pro ukazatele, se kterými uživatel právě pracuje v uživatelském rozhraní.
