Glicko DB

Rotas e notas de integração

Consulte a Ajuda da interface para instruções orientadas a tarefas e o README em português para instalação e configuração.

Índice

Estado da API

A aplicação atual é uma aplicação web Flask renderizada no servidor. Ela não publica atualmente uma API REST pública estável em /api. As rotas /api/backup, /api/player, /api/tournament e outras semelhantes do rascunho anterior não estão implementadas e não devem ser usadas em integrações.

As ações administrativas são envios de formulários HTML. Elas exigem uma sessão autenticada, a função adequada e um token CSRF válido. Algumas ações administrativas assíncronas retornam uma pequena resposta JSON de redirecionamento somente quando a solicitação inclui X-Requested-With: XMLHttpRequest; isso é um comportamento interno do navegador, não um contrato de API versionado.

Rotas GET públicas

Estas páginas podem ser abertas sem uma conta de administrador:

Rota Finalidade
/ Página inicial, resumo do ranking, estatísticas e notícias publicadas
/rankings Ranking público paginado
/players Diretório e filtros de jogadores
/player/view?id=<player_id> Perfil e histórico de partidas de um jogador
/matches Lista e filtros de partidas
/tournaments Lista de torneios públicos
/tournaments/<tournament_id> Detalhes, emparelhamentos e classificação de um torneio
/reports Relatórios por período e jogador
/reports/export.csv Versão CSV dos filtros selecionados
/reports/export.pdf Versão PDF dos filtros selecionados
/category Informações de rating Glicko e categorias
/sgf-library Biblioteca pública de SGF
/sgf-library/<filename> Metadados de um registro SGF
/sgf/<filename> Download de um registro SGF
/matches/<match_id>/record Visualização do SGF vinculado a uma partida
/matches/<match_id>/sgf Download do SGF vinculado a uma partida
/news/<article_id> Artigo de notícia publicado

A maioria das páginas aceita o parâmetro opcional lang=es, lang=en ou lang=pt. Os relatórios também aceitam start_date, end_date e player_id; consulte o guia da interface para exemplos.

Autenticação e rotas de membros

Rota Método Acesso
/admin/login GET, POST Entrar
/admin/register GET, POST Criar uma conta de membro
/admin/forgot-password GET, POST Solicitar um link de recuperação
/admin/reset-password/<token> GET, POST Concluir a recuperação
/admin/report-results GET, POST Enviar um resultado envolvendo o jogador vinculado
/admin/profile GET, POST Gerenciar o perfil da conta autenticada
/admin/logout GET Encerrar a sessão atual

Os envios de membros permanecem pendentes até serem revisados. Antes da aprovação, não alteram partidas públicas, ratings ou relatórios.

Grupos de rotas administrativas

Todas as rotas abaixo exigem uma conta autenticada e permissões conforme a função:

As rotas POST alteram o estado da aplicação e devem ser usadas pelos formulários renderizados. Ações de backup, restauração, importação, exclusão e torneios não são expostas como operações GET sem autenticação.

Orientações para integrações

Para uma integração externa, use as exportações documentadas em CSV/PDF ou o banco de dados por meio de um processo operacional aprovado. Não faça scraping de formulários administrativos nem dependa de respostas JSON não documentadas. Uma futura API REST deve definir autenticação, esquemas de requisição e resposta, códigos de erro, paginação e versionamento antes da criação de clientes.

^