Základní principy
Last updated
Was this helpful?
Last updated
Was this helpful?
Actigo poskytuje dva typy API
GraphQL s na adrese určené primárně pro integraci uživatelských rozhraní (webové a mobilní aplikace)
REST na adresách ve tvaru https://actigo.app/api/{module}/{resource-path...}, s dokumentací ve formátu OpenAPI dostupné na adrese , kterou lze prohlížet a testovat prostřednictvím . REST API je určené primárně pro integraci jiných systémů (např. stahování / aktualizaci registrací a import oficiálních výsledků pořádaných aktivit-závodů ze strany pořadatelů či s jimi asociovaných časoměřičů)
Většina operací/metod poskytovaných API, jmenovitě pak všechny provádějící změny v datech vyžaduje autorizaci. Pro tu je potřeba si po přihlášení do aplikace na adrese (položka Pro vývojáře v menu pod ikonou přihlášeného uživatele) vygenerovat přístupové klíče.
Ty se předávají ve voláních API v HTTP hlavičce pořadavku Authorization
a to ve formě
Příklad:
Přístup ke konkrétním datům či rozsah jejich zobrazení ve výsledcích volání metod API může být omezen právy uživatele, kterým byl použitý přístupový klíč vytvořen. Obecně platí, že API poskytuje data pouze v rozsahu v jakém jsou uživateli k dispozici prostřednictvím uživatelského rozhraní, tedy konkrétně
Veřejně dostupné informace o publikovaných pořádaných aktivitách, výsledcích a uživatelských aktivitách uživatele s veřejným profilem všem přístupovým klíčům (případně i bez použití klíče)
Detailní, veřejně nedostupné informace o registracích, nepublikovaných pořádaných aktivitách (závodech) a uživatelských aktivitách uživatele s neveřejným profilem pouze klíčům uživatelů, kteří mají k daným datům přístup (tj. jsou-li součástí pořadatelského týmu, případně spolupořadatelského či časoměřičského týmu s pořadatelem asociovaného, přátelé uživatele vlastnícího danou uživatelskou aktivitu atd.)