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

  1. Accede a la sección de proyecto.
  2. Pulsa Crear clave API y escribe un propósito que la identifique.
  3. Se mostrará la clave y la URL base. Copia la clave y guárdala en un lugar seguro (no volverá a mostrarse).
  4. 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

    Authorization: Bearer <API_KEY>
  • Parámetro de URL

    <GIGANTICS_ENDPOINT>?api_key=<API_KEY>

Ejemplos con curl

Cabecera

curl -X POST "<GIGANTICS_PIPELINE_ENDPOINT>" \
     -H "Authorization: Bearer <API_KEY>"

Parámetro de URL

curl -X POST "<GIGANTICS_PIPELINE_ENDPOINT>?api_key=<API_KEY>"

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.

RecursoMétodoAcción
DatasetGETDevuelve el archivo SQL/CSV del dataset
PipelinePOSTEjecuta el pipeline configurado
JobGETConsulta el estado de un job (no requiere API Key)

Respuesta al ejecutar un pipeline

Cuando se inicia un pipeline, Gigantics responde con:

{
  "job_id": "64c8c45b8a5f1e001a3db9aa",
  "job_url": "https://<host>/api/job/64c8c45b8a5f1e001a3db9aa"
}
  • 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.

Tabla de Contenidos