API

Wiclax met à disposition une API permettant à une application tierce d'accéder en direct aux données d'une épreuve, par le biais de requètes HTTP.

Sur le principe des API Rest, la constitution des adresses pour les requètes permet de préciser quelles données sont demandées. Les réponses sont fournies au format standard JSON.

A l'heure actuelle cette API couvre uniquement la consultation de données (lecture seule).

Réseau local et Web

L'accès depuis le réseau local est disponible à partir du moment où une épreuve est ouverte dans Wiclax.

L'accès via le Web est disponible sur activation, et uniquement si vous avez fait l'acquisition de l'option "Accès à l'API à travers le Web" pour la licence en cours. Notez que cet accès n'est pas persistant, il n'est disponible que pendans la durée d'une session où Wiclax reste ouvert et le fichier de l'épreuve est édité.

Dans le cas d'un accès Web vous devrez choisir un identifiant pour l'épreuve - un simple texte libre qui sera inclu dans les adresses et qui doit garantir qu'aucun autre utilisateur n'utilise le même identifiant au même moment. Il sert également à la confidentialité de l'accès.

Dans le cas du réseau local comme via le web, l'accès à l'API n'est pas protégé par un systême d'authentification.

Tests et documentation

Le point d'entrée pour découvrir l'API est depuis le menu G-Live / API Rest

La fenêtre qui s'ouvre permet de sélectionner les paramètres de requètes souhaités, et de découvrir en vis-à-vis l'adresse à utiliser pour les obtenir.

Dans la mesure où le format JSON est auto descriptif, cette fenêtre est en soi une documentation exhaustive des possibilités offertes par l'API. Les aperçus de réponses peuvent être copiés et transmis à un correspondant tiers en amont de la course.

Par exemple en local :

http://localhost:5050/startlist/activerace

renvoie la liste des partants pour la course active (course focus)