Saltar al contenido principal

Abrir en AthenaHQ

app.athenahq.ai/settings/api

​
Finalidad

La página Ajustes de API permite gestionar el acceso programático a los datos de tu organización. Desde aquí puedes generar y revocar claves de API, acceder a guías de integración de Looker Studio y Model Context Protocol (MCP) y configurar credenciales de inserción en iframe para mostrar el panel en tus propias aplicaciones.

​
Qué hay en la página

Aviso de solo lectura Si no tienes permiso para gestionar claves, aparece «Solo lectura · API» arriba. Al pasar el cursor, una ayuda indica: «Pide a un administrador de la organización acceso de escritura de API para hacer cambios aquí».

​
Pestaña Claves de API

Controles de cabecera
  • Recuento de claves: el número total (por ejemplo, «3 claves»).
  • Desplegable Guías: un menú con instrucciones rápidas de configuración para integraciones concretas.
  • Botón Crear clave de API: abre el diálogo para generar una clave.
Tabla de claves de API Enumera todas las claves existentes que tienes permiso para ver.
  • Nombre: el nombre visible asignado a la clave.
  • Clave: una vista previa con el prefijo seguido del sufijo oculto (por ejemplo, sk_live_••••••).
  • Sitios web: muestra a cuáles puede acceder la clave. Muestra «Todos los sitios web» para claves globales, «Ninguno» para alcances vacíos o hasta 4 logotipos de sitios. Si hay más de 4, aparece una etiqueta +N (al pasar el cursor, una ayuda muestra los nombres restantes).
  • Creación: la fecha de generación de la clave.
  • Creada por: el correo del usuario que la generó.
  • ... (menú Acciones): un menú de tres puntos al extremo derecho de cada fila con Editar y Eliminar.
Estados bloqueado y vacío
  • Oferta de API bloqueada: si tu plan no incluye acceso a API, todo el panel se sustituye por «Pon a trabajar tus datos de AthenaHQ». Según tu rol, verás Suscribirse (abre un presupuesto actual y un flujo de pago) o Contactar con el equipo.
  • Estado vacío: si la organización tiene acceso, pero no hay claves, una tarjeta ilustrada indica «Crea tu primera clave de API» con el botón principal Crear clave de API.

​
Pestaña Inserción

Dominios permitidos
  • Una sección con todos los dominios web autorizados a insertar el panel mediante iframe.
  • Botón Añadir dominio: abre un asistente para autorizar otro dominio.
  • Lista de dominios: muestra la URL del dominio autorizado y la fecha en que se «Añadió». Cada fila tiene un menú ... con Eliminar.
Tokens de inserción
  • Una sección con los tokens seguros que usa el backend del cliente para autenticar las sesiones insertadas.
  • Botón Crear token: abre un diálogo para generar un token.
  • Lista de tokens: muestra su nombre, una etiqueta de estado («Activo» o «En pausa») y «Último uso [date]» (o «Nunca usado»). Al pasar el cursor por la fila, aparece la fecha de creación. Cada fila tiene un menú ... con Pausar (o Reanudar) y Eliminar.
Cómo insertar Athena Un acordeón desplegable al final con documentación de referencia. Incluye el fragmento HTML exacto <iframe ...>, un desglose de parámetros de URL obligatorios y un ejemplo de código de backend Node.js para firmar un JWT.

​
Qué puedes hacer aquí

  • Crear una clave de API: haz clic en Crear clave de API. Dale un nombre en el diálogo. Si eres administrador, puedes elegir «Todos los sitios web» o «Sitios web específicos» (y seleccionarlos de una lista). Crear clave revela el token secreto una sola vez para copiarlo.
  • Editar una clave: abre ... en su fila y selecciona Editar para cambiar el nombre o los sitios concretos a los que puede acceder.
  • Eliminar una clave: abre ... en su fila y selecciona Eliminar. Aparece una confirmación. Eliminar una clave la revoca de forma permanente e inmediata.
  • Acceder a guías de integración: haz clic en Guías para abrir un desplegable.
    • Configuración de MCP abre instrucciones para conectar Claude.ai u otro cliente MCP.
    • Configuración de Looker Studio ofrece instrucciones para conectar sus paneles.
    • Documentación de API abre la documentación externa para desarrolladores en otra pestaña.
  • Añadir un dominio de inserción: en Inserción, haz clic en Añadir dominio. Introduce el dominio (por ejemplo, example.com) y continúa para generar automáticamente un token y un secreto JWT para él.
  • Crear un token de inserción: en Inserción, haz clic en Crear token. Dale un nombre. Un diálogo mostrará el Token de inserción y el Secreto JWT una sola vez para copiarlos.
  • Pausar / reanudar un token de inserción: abre ... en su fila y selecciona Pausar para desactivarlo temporalmente (interrumpe las inserciones activas que lo usan). Reanudar restaura el acceso.
  • Eliminar un dominio o token: abre ... en su fila y selecciona Eliminar.
  • Copiar credenciales: haz clic en cualquier bloque de código que muestre un token o secreto JWT para copiarlo inmediatamente. La ayuda «¡Copiado!» confirma la acción.
  • Comprar acceso a API: si la función está bloqueada y eres administrador, Suscribirse (o Obtener acceso a API) abre un presupuesto con el importe prorrateado a pagar hoy. Confirmar carga el importe en la tarjeta guardada o te lleva a una página de pago de Stripe.

​
Datos mostrados

  • Claves de API: claves de tu organización. Si eres miembro externo (invitado solo a sitios concretos), solo ves las claves limitadas a sitios a los que tienes acceso.
  • Dominios y tokens de inserción: todos los configurados para el panel insertable de la organización.
  • Presupuestos de suscripción: si compras acceso a API, el diálogo obtiene del sistema de facturación precios prorrateados actuales según el ciclo de tu plan.

​
Flujos habituales

Crear una clave de API para un sitio concreto
  1. En Claves de API, haz clic en Crear clave de API.
  2. Introduce un nombre descriptivo.
  3. En «Alcance de acceso», selecciona Sitios web específicos.
  4. Marca las casillas de los sitios a los que deba acceder.
  5. Haz clic en Crear clave.
  6. Haz clic en la cadena de clave generada para copiarla y guárdala de forma segura. Haz clic en Listo.
Configurar un panel insertado nuevo
  1. Haz clic en Inserción.
  2. Haz clic en Añadir dominio.
  3. Escribe el dominio donde se alojará el iframe (por ejemplo, internal.mycompany.com) y pulsa Intro o Añadir dominio.
  4. En «Dominio añadido», haz clic en Crear token.
  5. Aparece «Inserción lista». Haz clic para copiar tu Token de inserción, Secreto JWT y el fragmento Ejemplo de iframe.
  6. Entrega estas credenciales a tu equipo de desarrollo junto con las instrucciones para firmar JWT del final de la pestaña Inserción.

​
Estados vacíos, de carga y de error

  • Carga: mientras comprueba permisos y obtiene datos, aparece un indicador animado centrado. Si solo se están obteniendo las listas de claves o inserción, puede aparecer «Cargando dominios…» o «Cargando tokens…».
  • Claves vacías: si no hay claves, aparece una tarjeta ilustrada «Crea tu primera clave de API» que describe para qué sirven.
  • Listas de inserción vacías: si no hay dominios, aparece un globo con «Aún no se han añadido dominios». Si no hay tokens, una llave con «Aún no se han creado tokens».
  • Errores: si falla crear, editar o eliminar elementos, aparece una notificación roja arriba (por ejemplo, «No se ha podido actualizar la clave de API»). Si no se carga el presupuesto al comprar, el diálogo indica «No se pueden cargar los precios ahora mismo. Cierra esto e inténtalo de nuevo».
  • Desde dónde se enlaza: el menú principal de Ajustes (Ajustes > API). También desde la etiqueta «API» bloqueada de la barra lateral si tienes Free.
  • Adónde enlaza:
    • Documentación de API: abre docs.athenahq.ai en una pestaña nueva.
    • Contactar con el equipo: abre una página de reservas de Cal.com para ventas o soporte en otra pestaña.
    • Claude.ai y Model Context Protocol: enlaces externos de la guía de MCP.
    • Stripe Checkout: si un usuario sin tarjeta guardada intenta suscribirse al acceso a API.

​
Preguntas habituales de soporte

¿Por qué está desactivado «Crear clave de API»? El botón aparece en gris si no tienes permisos de escritura de API. Al pasar el cursor, muestra «Solo los administradores pueden crear claves de API». Pide a un administrador acceso api:write o que cree la clave por ti. He perdido mi clave de API o secreto JWT. ¿Cómo puedo volver a verlo? Por seguridad, las claves secretas y los tokens solo se muestran una vez, justo después de crearlos. Si pierdes una clave, debes eliminarla (o pausarla, en el caso de tokens de inserción) y generar otra. ¿Puedo limitar una clave a un solo sitio? Sí. Al crearla o editarla, elige «Sitios web específicos» en Alcance de acceso y marca solo los sitios a los que quieras que acceda. ¿Por qué no puedo pulsar nada? Solo aparece una pantalla de bloqueo. El acceso a API es de pago. En Free, toda la página está restringida tras «Pon a trabajar tus datos». Un administrador debe mejorar el plan para desbloquear estos ajustes.