Pular para o conteúdo

Ajuda do tiro prático

API pública — referência

← Todas as guias

Integre seu sistema ao Orbit pela API REST: consulte a configuração da entidade, gerencie atletas, provas, divisões, stages, squads, ROs e inscrições, obtenha as URLs públicas e leia os resultados completos em JSON. Cada recurso é endereçado por um identificador estável e opaco, seguro para expor.

Esta é a referência do tiro prático. Os módulos de tiro ao prato e de tiro de precisão têm APIs próprias, com a mesma chave de entidade e os mesmos limites. Ver as APIs dos três esportes.

Como começar

  1. No painel da entidade, acesse Chaves de API (somente o owner) e crie uma chave com a permissão desejada — leitura ou leitura e escrita.
  2. Guarde a secret: ela é exibida uma única vez. Se perder, regere a chave.
  3. Envie em cada request o header Authorization: Bearer <access_key>.<secret>.
Todo acesso é limitado aos dados da sua entidade, com limite de requisições por chave (headers X-RateLimit-*).
Campos obrigatórios são definidos pela sua entidade. Quais dados o atleta precisa informar (e-mail, CPF, RG, CR/validade e campos adicionais) — e quais são únicos — é você quem configura, na tela da entidade em Atletas → Configurar campos. Antes de cadastrar atletas ou criar inscrições, consulte GET /entidade: o bloco requisitos_inscricao devolve exatamente o que é obrigatório e único para a sua entidade.
Fabrica ou distribui um timer de tiro? Hoje o sistema conecta direto no navegador aos Special Pie (SP M1A2 e M1A2-F) e Shooters Global (SG Timer, SG Timer 2 e SG Timer GO), e novas integrações de timer são avaliadas caso a caso — do protocolo Bluetooth ao envio dos disparos por API. Entre em contato.

Referência interativa

Explore e teste os endpoints abaixo (Swagger UI). O JSON da especificação OpenAPI está em openapi.json.