> For the complete documentation index, see [llms.txt](https://docs.wiclax.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.wiclax.com/es/trabajar-en-red/api.md).

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

{% hint style="info" %}
Actualmente, esta API solo cubre la consulta de datos (solo lectura).
{% endhint %}

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

<figure><img src="https://4067006912-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FtANROPE4RnaYJQvld3f4%2Fuploads%2Fhset5m98D6dXELQxcCeC%2Fimage.png?alt=media&amp;token=7c0e7d6a-13a5-4d95-9ccd-038d46e583cb" alt=""><figcaption></figcaption></figure>

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`&#x20;

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


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.wiclax.com/es/trabajar-en-red/api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
