DocumentaciónClaves de API

Empezar

Claves de API

Una clave identifica tu aplicación ante la API. Se guarda en tu servidor, como una contraseña.

En esta página
  1. Cómo es una clave
  2. Dónde enviarla
  3. Obtener una clave
  4. Mantenerla en secreto

Cómo es una clave

Una clave siempre empieza por lya, seguido de su tipo. El tipo indica en nombre de quién actúa.

PrefijoTipoPara
lya_svc_ServicioUna aplicación o un servidor de tu espacio de trabajo
lya_usr_PersonalUna persona, con sus propios permisos
lya_prt_SocioUna integración construida con Learnya

Learnya solo guarda una huella, que no permite volver a leerla. Una clave perdida no se recupera, se sustituye.

Dónde enviarla

En la cabecera Authorization, después de Bearer. Los SDK de OpenAI lo hacen por ti. También se acepta la cabecera x-api-key.

CabeceraEjemplo
AuthorizationBearer lya_svc_…
x-api-keylya_svc_…

Una clave rechazada recibe una respuesta 401, sin indicar el motivo. Así, un tercero que prueba claves no averigua nada.

Obtener una clave

Las claves están disponibles para los espacios de trabajo Team y los socios. La creamos contigo y elegimos juntos:

  • su nombre, para reconocerla en tu espacio de trabajo
  • su ámbito, que debe incluir llm:invoke para llamar a los modelos
  • una fecha de caducidad si la clave es para un proyecto limitado en el tiempo

La clave se te muestra una sola vez, al crearla.

Solicitar una clave

Mantenerla en secreto

  • Una clave por aplicación, para poder desactivar una sin detener las demás
  • En una variable de entorno o un gestor de secretos, nunca en el repositorio de código
  • Una clave revocada deja de funcionar en menos de un minuto