Documentacion API
Explora la API completa de Balla Stats con documentacion interactiva de Swagger. Prueba endpoints, ve esquemas y autenticate directamente en el navegador.
Requisitos previos
Antes de explorar la documentacion API, necesitas:
- Una cuenta de Balla Stats
- Comprension basica de APIs REST
Explora la API completa de Balla Stats con documentacion interactiva de Swagger. Prueba endpoints, ve esquemas y autenticate directamente en el navegador.
Probar endpoints
Ejecuta llamadas API en vivo
Ver esquemas
Tipos compatibles con TypeScript
Autenticacion
Soporte para JWT y claves API
- Acceder a la documentacion API
- Autenticarse en Swagger
- Explorar endpoints
- Probar una llamada API
- Entender esquemas de respuesta
- Patrones comunes de la API
Navega a /api-docs en tu navegador, o haz clic en API Docs en la barra lateral. La interfaz de Swagger carga la referencia completa de la API con todos los endpoints disponibles.
Haz clic en el boton "Authorize" en la parte superior de la pagina. Ingresa tu token Bearer - ya sea un JWT del inicio de sesion o una clave API. Esto autentica todas las solicitudes posteriores realizadas a traves de Swagger UI.
Los endpoints estan organizados por categoria para una navegacion facil. Expande cualquier seccion para ver las operaciones disponibles:
Haz clic en "Try it out" en cualquier endpoint para hacerlo interactivo. Completa los parametros requeridos, luego haz clic en "Execute". El cuerpo de la respuesta, encabezados y codigo de estado se muestran abajo.
Expande la seccion Schema debajo de cualquier endpoint para ver la estructura completa de la respuesta. Estos tipos son compatibles con las definiciones de TypeScript en el paquete @balla-stats/types, facilitando la construccion de integraciones con tipos seguros.
Caracteristicas del esquema
- Tipos de campo: String, number, boolean, array, object con definiciones de tipo exactas
- Campos requeridos: Claramente marcados para distinguir propiedades opcionales de las requeridas
- Enums: Valores permitidos exactos para campos de estado, roles y tipos
- Objetos anidados: Expandibles para mostrar la estructura completa de relaciones
La API de Balla Stats sigue patrones consistentes en todos los endpoints:
Paginacion
Usa los parametros de consulta page y limit. Las respuestas incluyen el conteo total y metadatos de la pagina actual.
Filtrado
Filtra resultados con parametros de consulta como status, teamId, seasonId y rangos de fechas.
Respuestas de error
Formato consistente con campos message y statusCode. Los errores de validacion incluyen detalles a nivel de campo.
Formatos de fecha
Todas las fechas usan formato ISO 8601 (por ejemplo, 2026-02-16T10:30:00.000Z). Las marcas de tiempo siempre estan en UTC.
Prueba antes de programar
Usa Swagger para probar antes de escribir codigo de integracion. Verifica que los endpoints devuelvan los datos que esperas.
Revisa todos los campos
Revisa los esquemas de respuesta para todos los campos disponibles. Las respuestas a menudo incluyen mas datos de los que podrias esperar.
Se aplican limites de solicitudes
Los limites de solicitudes tambien se aplican a las solicitudes de Swagger. Usa claves API para limites mas altos al probar extensamente.
Error 401 en Swagger
- Haz clic en el boton Authorize e ingresa tu token primero
- Asegurate de incluir el token completo sin espacios adicionales
- Los tokens JWT expiran - inicia sesion de nuevo si tu sesion ha expirado
Respuestas vacias
- Verifica que los parametros de consulta sean correctos (por ejemplo, un ID de grupo valido)
- Verifica que tengas acceso al recurso solicitado
- Asegurate de que el recurso exista - intenta listar todos los elementos primero