saltar al contenido principal
Explorar la documentación

Claves de API

Crea, revela y revoca los dos tipos de clave que emite Syncanix: una clave secreta para la CLI y MCP, y una clave publicable para el widget incrustado.

Las claves de API permiten que tus propias herramientas lleguen a tu espacio de trabajo. Hay dos tipos, y la diferencia importa: una es un secreto del lado del servidor; la otra puede incluirse sin problema en tu página web.

Los dos tipos de clave

Clave secreta (gak_…)
De capacidad completa y solo del lado del servidor. La CLI la usa para subir tu catálogo y el servidor MCP la usa para autenticarse. Mantenla fuera de cualquier código del lado del cliente.
Clave publicable (pk_…)
Solo para conversación y ligada al origen, por lo que es segura para incrustarla en el código de tu página: justo lo que usa el widget de chat. Puede iniciar un chat y nada más.
gak_<env>_<32 base32 chars>   # secret — CLI / MCP, server-side only
pk_<test|live>_<32 base32 chars>  # publishable — embedded in your page

Crear una clave

Las claves se gestionan en Configuración → Claves de API del panel.

  1. Abre Claves de APIVe a Configuración → Claves de API y elige el entorno para el que creas la clave.
  2. Elige el tipoCrea una clave secreta para la CLI o MCP, o una clave publicable para el widget. Ponle un nombre que reconozcas después.
  3. Cópiala ahoraLa clave completa se muestra exactamente una vez. Cópiala y guárdala en un lugar seguro antes de cerrar el cuadro de diálogo.

Las claves son por entorno

Cada clave pertenece a un entorno. Una clave de desarrollo no puede tocar datos de producción y viceversa, lo que mantiene tu tráfico de pruebas y tu tráfico real bien separados.

Revocar una clave

Revoca una clave desde la misma página y dejará de funcionar de inmediato. Revócala enseguida si alguna vez queda expuesta y luego crea una de reemplazo. Revocar una clave nunca afecta a ninguna otra.

Mantener las claves seguras

  • Guarda las claves secretas en un gestor de secretos o variable de entorno, nunca en el control de versiones ni en el código de front-end.
  • Las claves publicables están hechas para el front-end: solo inician conversaciones y están ligadas a los orígenes que permitas.
  • Rota las claves periódicamente: crea la nueva, cambia tus herramientas a ella y luego revoca la antigua.
  • La creación y revocación de cada clave queda registrada en el registro de auditoría de tu espacio de trabajo.

Próximos pasos

Ejecuta la CLIUsa una clave secreta para subir tu catálogo con syncanix init.Configura el widgetUsa una clave publicable para incrustar el chat en tu aplicación.