APIs do Orbit

Todos os módulos do Orbit têm API REST pública. A porta de entrada, a autenticação e os limites são os mesmos nos três; o que muda são os recursos de cada esporte.

Cada card abre a referência completa daquele esporte, com console de teste e especificação OpenAPI.

O que é igual nos três

A mesma chave de entidade abre os três módulos — não existe credencial por esporte. O que decide o que ela alcança é o módulo estar habilitado na entidade.

Autenticação

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

Limites e respostas

• Escopo da entidade: todo recurso é filtrado pela entidade da chave. Identificador de outro clube responde 404, nunca 403 — a chave não deve nem saber que aquele registro existe.
• Escopo de escrita: POST, PUT, PATCH e DELETE exigem chave de escrita. Chave de leitura recebe 403.
• Rate limit por chave: as respostas trazem os headers X-RateLimit-Limit, X-RateLimit-Remaining e X-RateLimit-Reset. Estourando o limite vem 429 com Retry-After.
• Módulo desligado: se a entidade não tem o esporte habilitado, as rotas dele respondem 404.
• Identificadores opacos: todo recurso é endereçado por um id estável e não sequencial, seguro para expor e guardar do seu lado.
• external_id: cada recurso aceita o seu próprio identificador, único no escopo dele. É o que permite reprocessar uma carga sem duplicar registro.

O que a API deliberadamente não faz

Nenhum módulo expõe lançamento de score de campo nem substituto do aceite do atleta. A integridade do resultado depende de quem estava na linha de tiro: a assinatura nasce no campo, e uma chave de integração não tem como reproduzir isso.

Especificações OpenAPI

• Tiro prático (IPSC) — openapi.json
• Tiro ao prato — openapi.json
• Tiro de precisão — openapi.json