Proyectos
API
En Gigantics las claves de API se utilizan para invocar datasets, pipelines y jobs desde sistemas externos (CI/CD, scripts, etc.). A continuación se explica el flujo actualizado:
Creación de una API Key
- Accede a la sección de proyecto.
- Pulsa Crear clave API y escribe un propósito que la identifique.
- Se mostrará la clave y la URL base. Copia la clave y guárdala en un lugar seguro (no volverá a mostrarse).
- Desde la lista de claves podrás ver el propósito, parte del identificador, fecha /hora y número de invocaciones. Allí mismo puedes revocar, editar o eliminar la clave.
Autenticación
Cada petición a la API debe incluir la clave mediante uno de estos métodos:
-
Cabecera HTTP
-
Parámetro de URL
Ejemplos con curl
Cabecera
Parámetro de URL
Guarda la clave en una variable de entorno o gestor de secretos de tu plataforma CI/CD para evitar exponerla.
Endpoints
Las URL completas (incluyendo organización, proyecto, modelo y recurso) se muestran en la interfaz de Gigantics cuando asignas la clave API. Solo necesitas conocer la clave API y pegar la URL proporcionada.
| Recurso | Método | Acción |
|---|---|---|
| Dataset | GET | Devuelve el archivo SQL/CSV del dataset |
| Pipeline | POST | Ejecuta el pipeline configurado |
| Job | GET | Consulta el estado de un job (no requiere API Key) |
Respuesta al ejecutar un pipeline
Cuando se inicia un pipeline, Gigantics responde con:
- job_id: identificador interno del job.
- job_url: URL para consultar su estado.
Cuando el job termine (
status = completed) y el pipeline genere un dataset, en esta misma URL aparecerá el enlace al dataset resultante.