Saltar al contenido

Ayuda del tiro práctico

API pública — referencia

← Todas las guías

Integra tu sistema con Orbit por la API REST: consulta la configuración de la entidad, gestiona atletas, Pruebas, divisiones, Stages, Squads, ROs e inscripciones, obtén las URLs públicas y lee los resultados completos en JSON. Cada recurso se direcciona por un identificador estable y opaco, seguro para exponer.

Esta es la referencia del tiro práctico. Los módulos de tiro al plato y de tiro de precisión tienen APIs propias, con la misma clave de entidad y los mismos límites. Ver las APIs de los tres deportes.

Cómo empezar

  1. En el panel de la entidad, entra en Claves de API (solo el owner) y crea una clave con el permiso deseado — lectura o lectura y escritura.
  2. Guarda la secret: se muestra una sola vez. Si la pierdes, regenera la clave.
  3. Envía en cada request el header Authorization: Bearer <access_key>.<secret>.
Todo acceso está limitado a los datos de tu entidad, con límite de solicitudes por clave (headers X-RateLimit-*).
Los campos obligatorios los define tu entidad. Qué datos debe informar el atleta (correo, CPF, RG, CR/validez y campos adicionales) — y cuáles son únicos — lo configuras tú, en la pantalla de la entidad en Atletas → Configurar campos. Antes de registrar atletas o crear inscripciones, consulta GET /entidade: el bloque requisitos_inscricao devuelve exactamente lo que es obligatorio y único para tu entidad.
¿Fabrica o distribuye un cronómetro de tiro? Hoy el sistema se conecta directamente en el navegador a Special Pie (SP M1A2 y M1A2-F) y Shooters Global (SG Timer, SG Timer 2 y SG Timer GO), y las nuevas integraciones de timer se evalúan caso por caso — desde el protocolo Bluetooth hasta el envío de los disparos por API. Póngase en contacto.

Referencia interactiva

Explora y prueba los endpoints abajo (Swagger UI). El JSON de la especificación OpenAPI está en openapi.json.