Skip to main content

Tutorial Interactivo

Próximamente: Vídeo interactivo con Clueso estará disponible aquí. Por ahora, sigue la guía paso a paso a continuación.

Visión General

Las API Keys de gu1 te permiten integrar la plataforma con tus propios sistemas, automatizar workflows y acceder a datos programáticamente.

¿Qué son las API Keys?

Una API Key es una credencial de autenticación que identifica tu aplicación al hacer peticiones a la API de gu1. Es como una contraseña, pero diseñada para ser usada por aplicaciones en lugar de usuarios humanos.
Seguridad: Trata tus API keys como contraseñas. Nunca las compartas públicamente, no las incluyas en código versionado (Git) y rótalas periódicamente.

Tipos de API Keys

Production Key

Para datos reales
  • Accede a datos de producción
  • Modifica entidades reales
  • Cobra por uso de integraciones
  • Envía webhooks a endpoints reales
  • Requiere máxima seguridad

Sandbox Key

Para desarrollo y pruebas
  • Accede a datos de sandbox
  • Ambiente aislado
  • Sin costo adicional
  • Ideal para desarrollo
  • Puede compartirse en equipos de dev

Crear una Nueva API Key

1

Accede a Configuración

Navega a Settings > API Keys en el menú lateral izquierdo.
2

Haz Clic en 'Create API Key'

En la esquina superior derecha, haz clic en el botón + Create API Key (azul).
3

Configura la API Key

Completa la información:Nombre de la Key:
  • Usa un nombre descriptivo (ej: “Integration Zapier”, “Mobile App”, “Data Pipeline”)
  • Esto ayuda a identificar el uso más adelante
Ambiente:
  • Production: Para aplicaciones en producción
  • Sandbox: Para desarrollo y pruebas
Permisos (opcional): Por defecto, la key hereda permisos de tu usuario. Puedes restringir:
  • Read: Solo lectura de datos
  • Write: Crear y modificar entidades
  • Delete: Eliminar entidades
  • Execute: Ejecutar reglas e integraciones
4

Copia la API Key

IMPORTANTE: La API key completa se mostrará solo una vez. Cópiala inmediatamente a un lugar seguro.
La key tendrá este formato:
gk_production_z1UGrahVx9NA2NG6Pj-6ZuZlFf64CEV73SpUqtt_4fflydka8MmdVAxT0cLqO3d5
Prefijos:
  • gk_production_... - Production key
  • gk_sandbox_... - Sandbox key
5

Almacena de Forma Segura

Opciones recomendadas:
  • Gestor de contraseñas: 1Password, LastPass, Bitwarden
  • Variables de entorno: .env (¡no commit en Git!)
  • Secret managers: AWS Secrets Manager, Google Secret Manager, HashiCorp Vault
  • CI/CD secrets: GitHub Secrets, GitLab CI Variables
❌ Nunca:
  • Commitear en el código
  • Compartir por email/Slack
  • Incluir en screenshots
  • Dejar en archivos de log

Usar tu API Key

Autenticación HTTP

Todas las peticiones deben incluir la API key en el header Authorization:
curl https://api.gu1.ai/entities \
  -H "Authorization: Bearer gk_production_YOUR_API_KEY" \
  -H "Content-Type: application/json"

Ejemplos de Código

const GUENO_API_KEY = process.env.GUENO_API_KEY;

// Usando fetch nativo
const response = await fetch('https://api.gu1.ai/entities', {
  headers: {
    'Authorization': `Bearer ${GUENO_API_KEY}`,
    'Content-Type': 'application/json'
  }
});
const data = await response.json();

// Usando SDK de gu1
import { GueoClient } from '@gueno/sdk';

const client = new GueoClient({
  apiKey: GUENO_API_KEY
});

const entities = await client.entities.list();

Gestionar API Keys Existentes

Ver Todas las Keys

En la página Settings > API Keys, verás una lista de todas las keys activas con información clave como nombre, ambiente, último uso, creación y permisos.
Nota de Seguridad: Solo los primeros y últimos 4 caracteres de la key se muestran (ej: gk_p...3d5). La key completa no puede recuperarse.

Revocar una API Key

Si una key fue comprometida o ya no es necesaria, puedes revocarla inmediatamente. Esta acción es irreversible y todas las integraciones usando esta key dejarán de funcionar.

Rotar una API Key

La rotación es la práctica de sustituir una key periódicamente por seguridad. Se recomienda rotar API keys de producción cada 90 días.
Proceso de rotación: Crea una nueva key, actualiza tus sistemas gradualmente, verifica funcionamiento y revoca la key antigua.

Seguridad y Buenas Prácticas

Almacenamiento Seguro

Usa variables de entorno, secret managers y nunca commites keys en Git

Rotación Regular

Production: cada 90 días, inmediatamente si comprometida

Menor Privilegio

Usa permisos mínimos necesarios para cada integración

Monitoreo

Revisa uso regularmente y configura alertas de anomalías

Rate Limits y Quotas

PlanoRequisiciones/minRequisiciones/díaBurst
Starter6010.00010
Professional300100.00050
Enterprise1.000Ilimitado200
La API retorna información de límites en los headers X-RateLimit-*.

Próximos Pasos

¿Necesitas Ayuda?


Última actualización: Enero 2025