API de Proyectos
Administra proyectos dentro de los tenants de mindzieStudio. Los proyectos son los contenedores de nivel superior para datasets, investigaciones, dashboards y flujos de trabajo de análisis.
Características
Gestión de Proyectos
Crear, recuperar, actualizar y eliminar proyectos. Listar todos los proyectos en un tenant con soporte de paginación.
Operaciones de Caché
Cargar proyectos en memoria para un acceso rápido durante las operaciones del API. Esencial para ejecutar notebooks y bloques de forma eficiente.
Permisos de Usuario
Gestionar el acceso de usuarios a proyectos. Añadir usuarios, actualizar niveles de permiso (propietario vs miembro) y eliminar acceso.
Importar y Exportar
Exportar proyectos como archivos portátiles .mpz para respaldo o transferencia. Importar proyectos desde archivos .mpz. Gestionar miniaturas de proyecto.
Ver API de Importar y Exportar
Endpoints Disponibles
Prueba de Conectividad
| Método | Endpoint | Descripción |
|---|---|---|
| GET | /api/{tenantId}/project/unauthorized-ping |
Prueba de conectividad pública |
| GET | /api/{tenantId}/project/ping |
Prueba de conectividad autenticada |
CRUD de Proyectos
| Método | Endpoint | Descripción |
|---|---|---|
| GET | /api/{tenantId}/project |
Listar todos los proyectos |
| GET | /api/{tenantId}/project/{projectId} |
Obtener detalles del proyecto |
| POST | /api/{tenantId}/project |
Crear un proyecto |
| PUT | /api/{tenantId}/project/{projectId} |
Actualizar un proyecto |
| DELETE | /api/{tenantId}/project/{projectId} |
Eliminar un proyecto |
| GET | /api/{tenantId}/project/{projectId}/summary |
Obtener estadísticas del proyecto |
Gestión de Caché
| Método | Endpoint | Descripción |
|---|---|---|
| GET | /api/{tenantId}/project/{projectId}/load |
Cargar proyecto en caché |
| DELETE | /api/{tenantId}/project/{projectId}/unload |
Descargar proyecto de caché |
Permisos de Usuario
| Método | Endpoint | Descripción |
|---|---|---|
| GET | /api/{tenantId}/project/{projectId}/users |
Listar usuarios del proyecto |
| POST | /api/{tenantId}/project/{projectId}/users/{userId} |
Añadir usuario al proyecto |
| PUT | /api/{tenantId}/project/{projectId}/users/{userId} |
Actualizar permiso de usuario |
| DELETE | /api/{tenantId}/project/{projectId}/users/{userId} |
Eliminar usuario |
Importar/Exportar
| Método | Endpoint | Descripción |
|---|---|---|
| GET | /api/{tenantId}/project/{projectId}/download |
Exportar como .mpz |
| POST | /api/{tenantId}/project/import |
Importar desde .mpz |
Miniaturas
| Método | Endpoint | Descripción |
|---|---|---|
| GET | /api/{tenantId}/project/{projectId}/thumbnail |
Obtener miniatura |
| POST | /api/{tenantId}/project/{projectId}/thumbnail |
Actualizar miniatura |
| DELETE | /api/{tenantId}/project/{projectId}/thumbnail |
Eliminar miniatura |
Autenticación
Todos los endpoints del API de Proyectos requieren una clave API válida. Usa claves API con ámbito de tenant para las operaciones de proyectos.
Consulta Autenticación para detalles sobre tipos y uso de claves API.
Inicio Rápido
# Listar todos los proyectos en un tenant
curl -X GET "https://your-mindzie-instance.com/api/{tenantId}/project" \
-H "Authorization: Bearer YOUR_API_KEY"
# Cargar un proyecto en caché antes de ejecutar notebooks
curl -X GET "https://your-mindzie-instance.com/api/{tenantId}/project/{projectId}/load" \
-H "Authorization: Bearer YOUR_API_KEY"
Notas Importantes
- Eliminación en CASCADA: Eliminar un proyecto elimina permanentemente todos los datasets, investigaciones, dashboards y archivos
- Caché Obligatorio: Carga proyectos en caché antes de ejecutar notebooks o bloques
- Duración de la Caché: Los proyectos permanecen en caché por 30 minutos después del último acceso
- Exportar Antes de Eliminar: Siempre exporta los proyectos antes de eliminarlos como respaldo