For the complete documentation index, see llms.txt. This page is also available as Markdown.

API

Wiclax proporciona una API que permite que una aplicación de terceros acceda directamente a los datos de prueba mediante solicitudes HTTP.

Según el principio de las API Rest, la constitución de direcciones para las solicitudes permite especificar qué datos se solicitan. Las respuestas se proporcionan en formato JSON estándar.

Actualmente, esta API solo cubre la consulta de datos (solo lectura).

Red local y web

El acceso desde la red local está disponible desde el momento en que se abre un evento en Wiclax.

El acceso a través de la Web está disponible tras la activación y solo si ha adquirido la opción "Acceso a la API par Internet" para la licencia actual. Tenga en cuenta que este acceso no es persistente, solo está disponible mientras dure una sesión en la que Wiclax permanece abierto y se edita el archivo de prueba.

En el caso del acceso web, deberá elegir un identificador para la prueba, un texto libre simple que se incluirá en las direcciones y que deberá garantizar que ningún otro usuario esté utilizando el mismo identificador al mismo tiempo. También sirve para la confidencialidad del acceso.

Tanto en el caso de la red local como vía web, el acceso a la API no está protegido por un sistema de autenticación.

Pruebas y documentación

El punto de entrada para descubrir la API es desde el menú G-Live / API Rest

La ventana que se abre le permite seleccionar los parámetros de consulta deseados y descubrir la dirección a utilizar para obtenerlos.

Dado que el formato JSON es autodescriptivo, esta ventana es en sí misma una documentación exhaustiva de las posibilidades que ofrece la API. Las vistas previas de las respuestas se pueden copiar y enviar a un tercero antes de la carrera.

Por ejemplo localmente:

http://localhost:5050/startlist/activerace

devuelve la lista de participantes de la carrera activa (carrera focus)

Última actualización

¿Te fue útil?