Popis rozhraní Universal API
Toto rozhraní slouží pro synchronizaci závodníků do zařízení RaceMeter. Má to význam pro ty, kteří mají registraci závodníků (a tedy i jejich seznamy) dostupné na svém webu.
V zařízení RaceMeter se v nastavení synchronizace závodníků v daném závodě nastavuje API url a API token.
Na adresu uvedenou v položce API url se provede GET request do jehož hlavičky se doplní položka Authorization a její obsah se nastaví na "Bearer "+{API_TOKEN}
. V implementaci API se doporučuje kontrolovat položku Authorization a v případě neexistence, nebo v případě odlišné hodnoty od požadované vracet odpověď 401 – Unauthorized response status code.
V případě oprávněného přístupu se očekává odpověď typu JSON pole, které obsahuje seznam všech závodníků zaregistrovaných v daném závodě.
Struktura záznamu jednoho závodníka je následující a pokud není u položky specifikované jinak, jedná se o textovou položku:
- start_number – Položka obsahující startovní číslo závodníka. Je typu integer a je to povinná položka. Závodník bez startovního čísla pro RaceMeter neexistuje.
- V případě, že v daném závodě není nastavené „Automatické dělení jmen“ se očekává jméno závodníka v položkách first_name a last_name. V opačném případě se jméno závodníka importuje z položky full_name.
- team – Položka obsahující tým je nepovinná.
- phone – Položka obsahující telefonní číslo je nepovinná.
- email – Položka obsahující email je nepovinná.
- year_of_birth – Položka určující rok narození je typu integer a použije se pouze v případě, že je v daném závodě nastavené „Používat rok narození“.
- date_of_birth – Položka určující datum narození je textová a měla by obsahovat datum v tzv. ISO formátu. Tedy pro 24.7.1999 je to
1999-7-24
. Použije se pouze v případě, že je v daném závodě nastavené „Používat datum narození“. - category – Položka určující kategorii se použije se pouze v případě, že je v daném závodě nastavené „Používat kategorie“.
- country – Položka určující zemi se použije se pouze v případě, že je v daném závodě nastavené „Používat země“.
- gender – Položka určující pohlaví se použije se pouze v případě, že je v daném závodě nastavené „Používat pohlaví“.
- reg_number – Položka obsahující registrační číslo závodníka se použije se pouze v případě, že je v daném závodě nastavené „Používat registrační čísla“.
- description – Položka obsahující doplňový popis závodníka se použije se pouze v případě, že je v daném závodě nastavené „Používat popis“.
- size – Položka obsahující velikost závodníka se použije se pouze v případě, že je v daném závodě nastavené „Používat velikost“.
- coefficient – Položka obsahující přepočítávací koeficient pro daného závodníka se použije se pouze v případě, že je v daném závodě nastavené „Používat koeficient“. Položka je typu float.
- additional_duration – Položka obsahující dodatečné trvání pro daného závodníka se použije se pouze v případě, že je v daném závodě nastavené „Použít dodatečné trvání“. Položka může být typu float nebo integer a obsahovat dodatečné trvání v sekundách, nebo může být typu text a ve formátu
hh:mm:ss.xx
nebomm:ss.xx
a nebo jenss.xx
. - additional_distance – Položka obsahující dodatečnou vzdálenost pro daného závodníka se použije se pouze v případě, že je v daném závodě nastavené „Použít dodatečnou vzdálenost“. Položka může být typu float nebo integer a obsahovat dodatečnou vzdálenost v metrech.
- start_time – Položka obsahující čas startu daného závodníka se použije se pouze v případě, že je má daný závod nastavený typ startu „Individuální starty“. Položka může být typu integer a pak musí obsahovat počet milisekund od začátku dne, nebo je typu text a je ve formátu
hh:mm:ss
. - start_delay – Položka obsahující časovou prodlevu daného závodníka od startu se použije se pouze v případě, že je má daný závod nastavený typ startu „Intervalový start“. Položka může být typu integer a pak musí obsahovat počet sekund, nebo je typu text a je ve formátu
hh:mm:ss
nebomm:ss
a nebo jenss
. - chip_number – Položka obsahující číslo 1. čipu daného závodníka. Položka se použije v případě, že je v synchronizaci nastaveno přebírat číslo čipu z pole číslo čipu.
- chip2_number – Položka obsahující číslo 2. čipu daného závodníka. Položka se použije v případě, že je v závodě nastaveno, že se mají používat i druhé čipy a v synchronizaci je nastaveno přebírat číslo 2.čipu z pole číslo čipu.
- chip3_number – Položka obsahující číslo 3. čipu daného závodníka. Položka se použije v případě, že je v závodě nastaveno, že se mají používat i třetí čipy a v synchronizaci je nastaveno přebírat číslo 3.čipu z pole číslo čipu.
- chip4_number – Položka obsahující číslo 4. čipu daného závodníka. Položka se použije v případě, že je v závodě nastaveno, že se mají používat i čtvrté čipy a v synchronizaci je nastaveno přebírat číslo 4.čipu z pole číslo čipu.
Součástí webového rozhraní RaceMeteteru je i testovací služba, která poslouchá na adrese:
https://racemeter.xyz/api/v2/racers/test_get_racers
a vyžaduje API token abrakadabrasupertoken
Tato služba slouží k vyzkoušení synchronizace případně získání detailnější informace o datech a vrací testovací (vygenerované) údaje s 60ti závodníky.