Základní principy

Actigo poskytuje dva typy API

1. GraphQL s na adrese https://actigo.app/graphql určené primárně pro integraci uživatelských rozhraní (webové a mobilní aplikace)

2. REST na adresách ve tvaru https://actigo.app/api/{module}/{resource-path...}, s dokumentací ve formátu OpenAPI dostupné na adrese https://actigo.app/openapi.json, kterou lze prohlížet a testovat prostřednictvím webového rozhraní. 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 https://actigo.app/developers (položka Pro vývojáře v menu pod ikonou přihlášeného uživatele) vygenerovat přístupové klíče.

Při vytváření přístupového klíče můžete předgenerovaný název (name) i tajemství (secret) změnit na libovolnou hodnotu, zvláště pak secret nechte pokud možno co nejsložitější. Využijte popis pro jednoznačnou identifikací klíče (např. "Testovací verze webu mujzavod.cz")

Ty se předávají ve voláních API v HTTP hlavičce pořadavku Authorization a to ve formě

"Basic " + BASE64("keyName:keySecret")

Příklad:

Authorization: Basic AbcdefghijklmnopqrstuvwxyzABCDEF

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.)