Crear una clave API

Genera, gestiona y revoca claves API para la API de Vulgate.

21 may 2026

Las claves API permiten que tu código se autentique en Vulgate igual que la aplicación web. Cada clave está vinculada a un único equipo / Organización y hereda sus permisos.

Generar una nueva clave

  1. Abre la aplicación de Vulgate.
  2. Desde la barra lateral, elige Configuración → API.
  3. Haz clic en Crear una nueva clave API.
  4. Dale a la clave un nombre que explique para qué es ("Producción", "CI/CD", "Desarrollo local"). Los nombres te ayudan a identificar y revocar la clave correcta después.
  5. Haz clic en Crear.

Vulgate muestra el valor de la clave una sola vez — cópialo inmediatamente. Nunca lo mostramos de nuevo; la única recuperación es generar una nueva.

Almacenar la clave

Nunca subas una clave al control de versiones. Los dos patrones seguros son:

  • Variable de entorno en tu shell o CI:
export VULGATE_API_KEY=...
  • Archivo .env cargado en tiempo de ejecución (y .env listado en tu .gitignore):
VULGATE_API_KEY=...

Luego léelo desde tu código:

import os
api_key = os.environ["VULGATE_API_KEY"]

const apiKey = process.env.VULGATE_API_KEY!;

Usar la clave

Cada solicitud necesita la clave en el header Authorization:

curl https://vulgate.ai/api/search \
  -H "Authorization: Bearer $VULGATE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query": "test"}'

Listar claves existentes

La página Configuración → API muestra cada clave creada para el equipo actual, con el nombre de la clave y la fecha de creación.

Eliminar una clave

  1. Abre Configuración → API.
  2. Encuentra la clave en la lista.
  3. Haz clic en Eliminar clave API.
  4. Confirma.

La eliminación entra en vigor en segundos. Cualquier solicitud que use una clave eliminada recibe HTTP 401.

Mejores prácticas para claves

  • Una clave por aplicación. Mezclar claves entre aplicaciones significa que no puedes revocar una sin romper la otra.
  • Usa nombres claros. No cuestan nada y te salvan en un incidente.
  • Rota periódicamente. Genera una nueva clave, despliégala, luego elimina la antigua.
  • Mantén las claves fuera de los logs. Configura tu biblioteca de logging para redactar headers Authorization.

¿Qué alcance tiene una clave?

Cada clave API está vinculada a un único equipo y lleva los permisos del propietario del equipo. Eso significa que una clave API puede hacer todo lo que el Propietario del equipo puede hacer — incluyendo subir, buscar y leer documentos en ese equipo.

Relacionado

Buscar ayuda