🔌 API Endpoints

La API del P2P Dashboard es el medio principal para interactuar programáticamente con el sistema, tanto para la ingesta de datos como para la consulta de información analítica. Está construida con FastAPI, lo que proporciona una documentación interactiva automática (Swagger UI y ReDoc) y una validación de datos robusta.

Visión General de la API

La API se divide lógicamente en dos grandes secciones, reflejando las capas de Ingesta y Analítica:

1. API de Ingesta: Diseñada para recibir datos de los Workers externos. Requiere autenticación mediante API Keys.
2. API de Analítica: Ofrece endpoints para consultar datos procesados y agregados. Puede tener endpoints públicos y privados con diferentes niveles de autenticación.

Acceso a la Documentación Interactiva

Una vez que la aplicación FastAPI esté en ejecución, puedes acceder a la documentación interactiva generada automáticamente en las siguientes URLs:

• Swagger UI: http://localhost:8000/docs
• ReDoc: http://localhost:8000/redoc

Estas interfaces te permiten explorar todos los endpoints disponibles, sus parámetros, modelos de respuesta y probar las solicitudes directamente desde el navegador.

Estructura de la API

Todos los endpoints de la API siguen un versionado para asegurar la compatibilidad futura. La versión actual es v1.

• Prefijo General: /api/v1
• Rutas Administrativas: /admin (para gestión de usuarios, API Keys, monitoreo, etc.)

En las siguientes secciones, se detallarán los endpoints más relevantes de cada parte de la API.