Derechos de Acceso / Simple API

Derechos de Acceso

Un archivo de evento siempre pertenece a una única cuenta de cliente y solo el propietario de la cuenta puede acceder a la configuración de derechos de acceso por razones de seguridad.

A través de los derechos de acceso puedes otorgar acceso a otra cuenta de RACE RESULT ya sea por nombre de usuario o ID de cliente, además puedes controlar el acceso a ciertas áreas del software para ese evento específico.

Simple API

La API simple sirve para hacer que los datos de su archivo de eventos sean accesibles a través de un enlace estático sin iniciar sesión en su cuenta de cliente, esto puede ser para publicar resultados en otro sitio web.

La configuración se puede acceder mediante Ajustes Básicos ⇒ Derechos de Acceso / Simple API. Simplemente selecciona qué tipo de datos deseas hacer accesibles y luego selecciona el nombre de la lista o ingresa el nombre del parámetro. Los detalles para cada tipo de API se encuentran más abajo.

 

 

El ícono en la columna Enlace te llevará al enlace estático.

Al llamar a las APIs debes considerar que estarán en caché durante entre 10 y 30 segundos, por lo tanto, llamarlas con más frecuencia podría hacer que los datos no se actualicen correctamente.

La Simple API aplica un límite de velocidad de 1 llamada por segundo por cada URL de API única desde cada dirección única. Si tu script cliente llama a una API más de una vez por segundo, recibirá un código de error 406. Si necesitas llamadas más frecuentes, por favor contacta al soporte.


Lists API

The List API takes any Output Lists you have already created and serves it via a static link. You can select the format of the list in the setup or append the format to the end of the URL.

Output Formats

Standard: TXT, HTML, PDF, CSV, XML, XLSX (Excel)
Developer Focused: JSON, JSON ext (includes full formatting/CSS data from the output settings)

Potential Use Case: If you have a "Live Results" output list, you can provide the JSON link to a broadcast to display live results.

Statistics API

The Statistics API provides a snapshot of the Statistics (e.g., finisher counts by gender, t-shirt size totals) defined in the Statistics tab.

Formats: PDF or XLS.

Potential Use Case: Providing a "live-updating" Excel link to the race announcer or the medical tent so they can track the percentage of participants currently on the course versus those who have finished.

Settings API

The Settings API type allows you to retrieve specific event-level configuration data. To use this, select Settings as the Type and enter the specific setting name you wish to retrieve.

The following fields can be called via the Settings API:

Basic Event Settings

Field Setting Location
EventName Name of Event
EventDate Event Date From
EventDate2 Event Date To
EventLocation Event Location City
EventZip Event Location Zip Code
EventCountry Event Location Country
EventStreet Event Location Street
EventLogo Main Event Settings Logo
SpecialDateFormat Localization Settings Special Date Format

Dashboard Summary

Field Setting Location
OverviewNotes Dashboard Summary - Notes
OverviewContact Dashboard Summary - Contact Information
OverviewTodos Dashboard Summary - ToDo List

Derived Settings

Field Setting Location
PortalID Event ID
PortalPublishEvent Activate myraceresult.com Publish Event Checkbox
LastDataAnalysis Last time Participants ⇒ Data Analysis ran
EventLocationLat Latitude of Event Settings Location
EventLocationLng Longitude of Event Settings Location

The list of fields should be comma separated without any spaces.

Potential Use Case: This is particularly useful for synchronizing event metadata with external websites or mobile apps without manual entry. Automatically displaying the official race name on a website showing upcoming events.

Counter API

The Counter API is a lightweight call designed to return a single integer: the number of participants. The API can return the total participants in the event or a particular contest. 

Potential Use Case: Powering a "Registration Counter" on a website homepage that shows "Only X spots left!" by subtracting this API value from your race capacity.

Custom APIs

Custom APIs allow for further refinement of API outputs and also provide some additional functionality when working with RACE RESULT 14.

This guide will document some of the functionality that can be achieved with custom APIs, but should you have any further specific requirements then please contact support with your requirements. 

Acceso al mapa de carreras

Para vincular los datos de participantes de tu archivo de evento con Racemap, necesitas usar la función de API simple que se encuentra en Basic Settings ⇒ Derechos de acceso/API simple

En la configuración Tipo, seleccione "Acceso al mapa de carreras".

Se crea automáticamente una integración, con la configuración predeterminada anterior. Estos deberían estar bien para la mayoría de los eventos, pero puedes editarlos cuando sea necesario.

Aquí hay más información sobre cada campo y lo que debes poner en ellos:

  • Id: debe contener un valor numérico que sea único en el archivo de eventos y que no cambie.
  • RaceNr:ese campo se mostrará en la bandera de cada participante en la visualización del cronometraje. Normalmente es el número de dorsal, pero puede ser el que quieras (incluso puede incluir texto y emojis) y no es necesario que sea único.
  • Transponder1 and Transponder2: códigos de chip asignados a un participante a través de los campos de datos correspondientes. Si está utilizando un archivo de chip en lugar de estos dos campos para asignar chips, reemplace Transponder1 con TransponderInChipFile en el campo Transponder1.
  • Contest: Normalmente, los concursos se configuran en el archivo del evento. Sin embargo, puedes usar este campo para agrupar a los participantes en cualquier categoría relevante para Racemap, por ejemplo, si los participantes de un determinado concurso no realizan todos el mismo recorrido.
  • Visibility: dejarlo como "público" para que los participantes aparezcan en el Racemap
  • Start and Finish: debe contener la hora de inicio y finalización del día (en hora UTC) de los participantes, o dejarse en blanco. Cuando se completan, Racemap usa estos campos para ignorar los seguimientos antes y después de que un participante esté en el curso, por lo que es fundamental que estén configurados correctamente o en blanco.
  • Custom: Utilice este campo para agregar cualquier información adicional. Tendrás que ponerte en contacto con Racemap para asegurarte de que realmente puedan hacer uso de lo que pones allí.


 

Webhooks

RACE RESULT 14 puede enviar webhooks cuando se producen ciertos eventos.
Estos se utilizan principalmente para asegurar la sincronización de datos entre dos almacenes de datos separados.
Por ejemplo, si estás utilizando tu propia plataforma de inscripción y deseas asegurarte de que los datos de los participantes se actualicen cuando se modifiquen en el archivo del evento.

Los webhooks se configuran en Basic Settings ⇒ Derechos de acceso/API simple.

Cada webhook debe definir el activador, la URL de destino y, para ciertos activadores, se pueden definir un filtro y campos.

Cuando se configuran y activan, los webhooks se enviarán automáticamente de acuerdo con los activadores definidos, no hay límite de tiempo durante cuánto tiempo se activarán los webhooks.

Todos los webhooks se envían como una solicitud POST con datos en el cuerpo de la POST como JSON; de forma predeterminada, el cuerpo siempre contendrá el ID del evento, el ID del webhook y la marca de tiempo; los valores adicionales dependen del activador que se utilice.

Una llamada se considera enviada exitosamente si se recibe un código de respuesta <500, incluso si el código de estado es un código de error, aún se considera recibido por el destino. Si una llamada no tiene éxito, el servidor intentará reenviarla con un retraso mayor entre o hasta que se alcance el límite de la cola del servidor, momento en el que se descartará el mensaje.

Los webhooks los envía el SES que ejecuta el archivo del evento; si está sincronizando el tiempo sin conexión, incluso con el reenvío en línea habilitado, los webhooks solo los enviará el SES local.

Impulsos

Nueva participante

Se enviará una llamada cuando se agregue un nuevo participante, esto puede ser a través de participantes importados, registro en línea, registro en el sitio o directamente a través de la ventana de participantes.

Se puede aplicar un filtro para enviar el webhook solo si un determinado filtro es verdadero, por ejemplo, si un participante ha seleccionado una opción específica durante el registro.

El cuerpo de la publicación también puede incluir cualquier campo que esté definido como una lista de valores separados por punto y coma.

Actualización del participante

De manera similar al activador de nuevo participante, la actualización del participante se enviará cada vez que se cambien los campos de datos de un registro de participante; esto no se activará por cambios en las divisiones, los cálculos de resultados o los campos definidos por el usuario.

También se puede aplicar un filtro a las actualizaciones de los participantes y el cuerpo de la publicación se puede configurar para incluir campos también.

Nuevos datos sin procesar

El nuevo activador de datos sin procesar se enviará cada vez que se agregue un nuevo registro de datos sin procesar; el registro está vinculado a un registro de participante, por lo que, opcionalmente, puede definir un filtro y campos que se incluirán en el cuerpo de la POST.

Al utilizar los nuevos datos sin procesar, se recomienda vincular el filtro a un resultado específico o al resultado final, por ejemplo; solo envíe el webhook si el participante ha finalizado. Cualquier cálculo que dependa del registro de datos sin procesar se completará primero, por lo que se enviará incluso si ese tiempo se utiliza para el resultado específico que está viendo.

Configuración cambiada

Esto se aplica a cualquier configuración del archivo de eventos que se cambie, esto incluye, por ejemplo, todas las configuraciones de eventos, sincronización de chips y puntuación en la ventana principal, actualizaciones de las listas de salida, configuraciones de my.rr y más.

Dado que la configuración se aplica al archivo del evento y no al registro de un participante, no se puede filtrar ni incluir campos adicionales. El cuerpo de la publicación incluirá ModJobID en el campo Valores para permitirle realizar un seguimiento de los cambios.

El ID de ModJob es un número entero que representa el último ciclo de cálculo ejecutado por el SES. Cada vez que se cambia algo en un archivo de eventos, se ejecuta un trabajo único que calcula lo que se debe actualizar en la base de datos. Esta identificación aumentará con cada cambio, sin importar cuán grande o pequeño sea.

Todos los cambios

Todos los cambios significa cualquier cambio en el archivo de eventos.

Dado que todos los cambios se aplican al archivo del evento y no al registro de un participante, no se pueden filtrar ni incluir campos adicionales. El cuerpo de la publicación incluirá ModJobID en el campo Valores para permitirle realizar un seguimiento de los cambios.