Připojení přes REST API

ARAD nabízí datové rozhraní ARAD-REST-API, které umožňuje automatizovaný přístup k datům mimo webové prostředí.

API poskytuje stejnou množinu ukazatelů a hodnot jako webová aplikace ARAD. Zpřístupňuje také definice uložených výběrů uživatele.

Jak API funguje

Rozhraní je realizováno pomocí standardu REST. Jednotlivé služby se volají prostřednictvím URL adres s parametry, komunikace probíhá přes protokol HTTP a struktura dotazů je díky tomu čitelná.

Výstupem volání je strukturovaný soubor určený pro další zpracování.

Kdo může API používat

Použití API je dostupné uživatelům s vytvořeným účtem v systému ARAD. Pro volání je nutné použít API klíč, který si uživatel generuje ve svém profilu.

Podrobnosti jsou v části Jak získám svůj API klíč?.

API Builder

Pro jednodušší sestavení volání API je v aplikaci dostupný API Builder. Uživatel si vybere službu, nastaví parametry, zvolí API klíč a získá připravené volání.

Podrobnosti jsou v části API Builder.

Doporučení k používání API

Nepřetěžujte datové rozhraní nadměrnou četností dotazů nebo neúměrnými objemy stahovaných dat. Při nadměrném zatížení může být účet dočasně uzamčen.

Pravidla jsou popsána také v části Pravidla používání dat ARAD.

Kompletní technická dokumentace

TODO: Doplnit oficiální odkaz na kompletní technickou dokumentaci ARAD-REST-API nebo na PDF dokumentaci.