Visão geral
O BoraGame é o sistema de gestão para arenas de beach tennis, futevôlei, vôlei de praia e padel. Esta página lista os recursos públicos que um desenvolvedor ou um agente de IA pode usar para entender e consultar o serviço sem autenticação. A API operacional da plataforma (reservas, filas, torneios, financeiro) vive no aplicativo em app.boragame.app e é autenticada.
Especificação OpenAPI
A especificação OpenAPI 3.1 dos endpoints públicos está publicada em /openapi.json. Cada operação tem um operationId único, descrição, parâmetros tipados e esquemas de resposta — compatível com function calling de LLMs.
Endpoints públicos
GET /api/status
Retorna o status de disponibilidade e metadados do serviço (nome, versão e links de documentação) em JSON. Exemplo de resposta:
{
"name": "BoraGame",
"status": "ok",
"version": "1.0.0",
"site": "https://boragame.app",
"app": "https://app.boragame.app",
"docs": "https://boragame.app/desenvolvedores",
"openapi": "https://boragame.app/openapi.json",
"llms": "https://boragame.app/llms.txt"
}Respostas de erro
Os endpoints sob /api/ retornam erros estruturados em JSON com code (legível por máquina), message e uma hint de resolução — nunca páginas de erro em HTML. Exemplo:
{
"error": {
"code": "not_found",
"message": "Endpoint não encontrado.",
"hint": "Consulte https://boragame.app/openapi.json para os endpoints disponíveis.",
"status": 404
}
}Rate limiting
As respostas da API incluem os cabeçalhos de rate limit do RFC 9331 — RateLimit-Limit, RateLimit-Remaining e RateLimit-Reset — e, em um 429 Too Many Requests, o cabeçalho Retry-After. Use-os para se auto-regular.
Recursos para agentes de IA
- /llms.txt — resumo em linguagem natural, incluindo quando usar o BoraGame.
- /openapi.json — especificação OpenAPI dos endpoints públicos.
- /sitemap.xml — todas as URLs indexáveis.
- /robots.txt — crawlers de IA liberados explicitamente.
Contato
Dúvidas de integração? Escreva para [email protected] ou veja a página de contato.