Saltar al contenido

Centro de ayuda

APIs de Orbit

← Todas las guías

Todos los módulos de Orbit tienen API REST pública: la misma puerta de entrada, la misma autenticación y los mismos límites; cambian los recursos de cada deporte.

Cada tarjeta abre la referencia completa de ese deporte, con consola de prueba y especificación OpenAPI.

Tiro práctico (IPSC)

Matches, atletas, divisiones, Stages, Squads, ROs, inscripciones y resultados de tiro práctico.

/api/v1

Tiro al plato

Matches, pasadas, Squads, inscripciones, campeonatos y resultados de tiro al plato.

/api/v1/clay

Tiro de precisión

Matches, modalidades, series, turnos de bancada, inscripciones, campeonatos y resultados de precisión.

/api/v1/precisao

Lo que es igual en los tres

La misma clave de entidad abre los tres módulos — no existe credencial por deporte. Lo que decide su alcance es que el módulo esté habilitado en la entidad.

Autenticación

  1. En el panel de la entidad, abre Claves de API (solo el owner) y crea una clave con el permiso que necesites — 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>.

Límites y respuestas

  • Alcance de la entidad: todo recurso se filtra por la entidad de la clave. Un identificador de otro club responde 404, nunca 403 — la clave ni siquiera debe saber que ese registro existe.
  • Alcance de escritura: POST, PUT, PATCH y DELETE exigen clave de escritura. Una clave de lectura recibe 403.
  • Rate limit por clave: las respuestas traen los headers X-RateLimit-Limit, X-RateLimit-Remaining y X-RateLimit-Reset. Al superar el límite viene 429 con Retry-After.
  • Módulo desactivado: si la entidad no tiene ese deporte habilitado, sus rutas responden 404.
  • Identificadores opacos: todo recurso se direcciona por un id estable y no secuencial, seguro para exponer y guardar de tu lado.
  • external_id: cada recurso acepta tu propio identificador, único en su alcance. Es lo que permite reprocesar una carga sin duplicar registros.
Los campos obligatorios los define tu entidad. Antes de crear atletas o inscripciones, consulta GET /entidade: el bloque requisitos_inscricao devuelve exactamente lo que es obligatorio y único para tu club.

Lo que la API deliberadamente no hace

Ningún módulo expone el registro de score de campo ni un sustituto de la aceptación del atleta. La integridad del resultado depende de quién estaba en la línea de tiro: la firma nace en el campo, y una clave de integración no puede reproducir eso.

Especificaciones OpenAPI

¿Necesitas algo que la API no cubre? Integraciones a medida y nuevos recursos se evalúan caso por caso. Habla con nosotros.