Resumen
Las claves de API permiten que sus aplicaciones, scripts y servicios de backend accedan de forma segura a las API de Astra sin necesidad de que un usuario inicie sesión a través de la interfaz web cada vez. Este artículo explica qué son las claves de API, cómo crearlas y usarlas, y cómo administrar o revocar claves existentes.
Instrucciones
¿Qué es una clave de API?
Una clave de API es una credencial secreta que comienza con sk_live_. Permite que su aplicación se autentique y realice solicitudes a las API de Astra de forma programática.
Las claves de API se usan comúnmente cuando se necesita una conexión de sistema a sistema que se ejecuta automáticamente sin interacción del usuario.
Casos de uso recomendados
Las claves de API son ideales cuando desea:
Sincronizar clientes potenciales calificados de Astra a su CRM automáticamente.
Crear paneles personalizados extrayendo datos de conversaciones y clientes potenciales de Astra.
Desencadenar flujos de trabajo empresariales cuando un agente de IA captura un nuevo cliente potencial.
Enviar datos de conversaciones a sistemas internos de análisis o informes.
Cuándo no usar claves de API
No se recomiendan las claves de API para aplicaciones orientadas al público donde cada usuario necesita otorgar acceso a su propia cuenta.
En estos casos, utilice la autenticación OAuth en su lugar.
Cómo crear una clave de API
Para crear una nueva clave de API:
Inicie sesión en su cuenta de Astra.
Vaya a Cuenta > Claves de API.
Haga clic en Crear clave.
Ingrese un nombre descriptivo para la clave, como Sincronización CRM de producción.
Haga clic en Crear.
Importante: Guarde su clave de API inmediatamente
Después de crear la clave, Astra muestra la clave de API completa solo una vez.
Asegúrese de copiar y almacenar la clave en un lugar seguro antes de cerrar la notificación o abandonar la página.
Después, Astra solo mostrará un prefijo abreviado de la clave para fines de identificación. La clave completa no se podrá ver de nuevo.
Cómo usar una clave de API
Después de crear una clave de API, agréguela a su aplicación, script o integración.
Al realizar solicitudes de API, incluya la clave en el encabezado de autorización de la solicitud, generalmente como un token Bearer.
Una vez configurada, su aplicación puede acceder de forma segura a las API de Astra sin requerir que los usuarios inicien sesión a través de un navegador.
Administrar claves de API existentes
La página Claves de API muestra información sobre todas las claves activas.
Columna | Descripción |
Nombre | El nombre asignado a la clave de API durante la creación |
Prefijo de clave | Los primeros caracteres de la clave de API, utilizados para identificar la clave |
Creado | La fecha y hora en que se creó la clave |
Último uso | La hora más reciente en que se usó la clave; permanece en blanco si la clave nunca se ha utilizado |
Cómo revocar una clave de API
Es posible que necesite revocar una clave de API si:
La clave se expuso o compartió de forma no intencionada
Una integración ya no es necesaria
Un miembro del equipo con acceso a la clave ha abandonado la organización
Está rotando credenciales como parte de un proceso de seguridad
Para revocar una clave de API:
Localice la clave en la lista de Claves de API.
Haga clic en la opción Eliminar.
Confirme la acción.
¿Qué sucede después de la revocación?
La clave de API se invalida de inmediato.
Cualquier aplicación, script o integración que utilice esa clave ya no podrá acceder a las API de Astra hasta que se configure una nueva clave válida.
Mejores prácticas de seguridad al trabajar con claves de API
Siga estas recomendaciones para mantener seguras sus claves de API:
Nunca incluya claves de API en código frontend o del lado del cliente.
Almacene las claves de API en un gestor de secretos seguro o en variables de entorno.
Utilice claves de API separadas para entornos de prueba y producción.
Rote las claves de API regularmente.
Revogue las claves no utilizadas o desactualizadas.
Si una clave de API se ve comprometida, revóquela de inmediato y cree una nueva.