SETTO API
Referencia de la API

Referencia de la API

Cómo funciona la referencia generada de la API externa de SETTO — una página por operación, un panel Try it donde puedes pegar un token, y el documento OpenAPI crudo.

Las páginas de esta sección se generan desde el documento OpenAPI de la API externa de SETTO, así que no pueden desviarse de la API: una página por operación, con su ruta, su método, cada parámetro, el esquema de seguridad y el esquema de respuesta. Cada página lleva además un panel Try it que dispara una petición real desde tu navegador, para que veas un payload en vivo sin salir de la documentación. Si lo que buscas son ejemplos resueltos y consejos en lugar de una lista exhaustiva de parámetros, lee mejor las guías.

La referencia generada está en inglés

Las páginas por operación se generan a partir del documento OpenAPI y no se traducen: bajo /es/docs/reference/** se sirve la versión en inglés. Las guías y los conceptos sí están en español.

Las operaciones

OperaciónMétodo y rutaGuía
getMeGET /v1/external/meInicio rápido
listTournamentsGET /v1/external/tournamentsListar torneos
getTournamentGET /v1/external/tournaments/{idx}Obtener un torneo
listDivisionsGET /v1/external/tournaments/{idx}/divisionsListar categorías
listTeamsGET /v1/external/tournaments/{idx}/teamsListar equipos
getRoundGET /v1/external/rounds/{idx}Obtener una ronda
getTournamentScheduleGET /v1/external/tournaments/{idx}/scheduleServidor MCP
proposePoolPerCourtSchedulePOST /v1/external/tournaments/{idx}/schedule/proposalsServidor MCP
applySchedulePlacementsPOST /v1/external/tournaments/{idx}/schedule/placementsServidor MCP
listActivityGET /v1/external/activity«Actividad»
searchTournamentGET /v1/external/tournaments/{idx}/searchServidor MCP
createTournamentPOST /v1/external/tournamentsServidor MCP
updateTournamentPATCH /v1/external/tournaments/{idx}Servidor MCP
publishTournamentPOST /v1/external/tournaments/{idx}/publishServidor MCP
setTournamentLifecyclePOST /v1/external/tournaments/{idx}/lifecycleServidor MCP
createDivisionPOST /v1/external/tournaments/{idx}/divisionsServidor MCP
updateDivisionPATCH /v1/external/tournaments/{idx}/divisions/{divisionIdx}Servidor MCP
deleteDivisionDELETE /v1/external/tournaments/{idx}/divisions/{divisionIdx}Servidor MCP
setDivisionSeedsPUT /v1/external/tournaments/{idx}/divisions/{divisionIdx}/seedsServidor MCP
registerTeamPOST /v1/external/tournaments/{idx}/registrationsServidor MCP
registerTeamsPOST /v1/external/tournaments/{idx}/registrations/batchServidor MCP
updateTeamPATCH /v1/external/tournaments/{idx}/teams/{teamIdx}Servidor MCP
deleteTeamDELETE /v1/external/tournaments/{idx}/teams/{teamIdx}Servidor MCP
updatePlayerPATCH /v1/external/tournaments/{idx}/players/{playerIdx}Servidor MCP
substitutePlayerPOST /v1/external/tournaments/{idx}/teams/{teamIdx}/substituteServidor MCP
previewTeamWithdrawalPOST /v1/external/tournaments/{idx}/teams/{teamIdx}/withdraw/previewServidor MCP
withdrawTeamPOST /v1/external/tournaments/{idx}/teams/{teamIdx}/withdrawServidor MCP
previewDivisionFormatPOST /v1/external/tournaments/{idx}/divisions/{divisionIdx}/format/previewServidor MCP
applyDivisionFormatPOST /v1/external/tournaments/{idx}/divisions/{divisionIdx}/formatServidor MCP
appendEliminationRoundPOST /v1/external/tournaments/{idx}/divisions/{divisionIdx}/rounds/appendServidor MCP
previewPoolsPOST /v1/external/tournaments/{idx}/rounds/{roundIdx}/pools/previewServidor MCP
applyPoolsPOST /v1/external/tournaments/{idx}/rounds/{roundIdx}/poolsServidor MCP
previewDrawPOST /v1/external/tournaments/{idx}/rounds/{roundIdx}/draw/previewServidor MCP
applyDrawPOST /v1/external/tournaments/{idx}/rounds/{roundIdx}/drawServidor MCP
confirmDrawPOST /v1/external/tournaments/{idx}/rounds/{roundIdx}/draw/confirmServidor MCP
recordGameResultPOST /v1/external/tournaments/{idx}/games/{gameIdx}/resultServidor MCP
clearGameResultDELETE /v1/external/tournaments/{idx}/games/{gameIdx}/resultServidor MCP
setGameTeamsPATCH /v1/external/tournaments/{idx}/games/{gameIdx}/teamsServidor MCP

Las páginas se agrupan por tag de OpenAPI — Organization, Tournaments, Divisions, Teams, Rounds, Scheduling, Activity — que es también el orden de la barra lateral.

Cómo usar "Try it"

Cada página de operación tiene un panel donde puedes llenar los parámetros de ruta y de consulta y enviar la petición.

  1. Abre el campo Authorization y pega un token de API de SETTO, personal o de organización (setto_live_…). El panel usa el esquema bearer apiToken declarado en el spec.
  2. Llena idx — un UUID real de torneo o de ronda que tu token alcance.
  3. Envía. La respuesta regresa con su estado, sus cabeceras y su cuerpo.

La petición sale de tu navegador

El playground llama a la API de SETTO directamente desde tu navegador; no hay proxy delante, y nada se guarda en los servidores de este sitio. Aun así, un token pegado en un formulario web es un token que estuvo en un formulario web — usa uno de vida corta, o revócalo después desde el panel de organizador. Consulta Autenticación.

Si una petición falla con un error de red o de CORS en lugar de un estado HTTP, el token nunca salió de tu navegador — revisa el token y la URL e inténtalo de nuevo.

El documento OpenAPI crudo

El mismo documento que genera estas páginas se publica en /openapi.json. Apunta ahí un generador de clientes, una importación de Postman o un agente de IA:

curl -s https://docs.setto.io/openapi.json -o setto-external-api.json

Su servers[0].url se llena al momento de la petición con la URL base de la API contra la que está configurado este sitio, así que las URLs de un cliente generado quedan correctas sin editar nada.

Relacionado

  • Autenticación — antes de pegar un token en ningún lado.
  • Errores — cada estado y código que lista la referencia.
  • Límites de uso — las cabeceras que lleva cada respuesta.

En esta página