Saltar al contenido principal
Phynxa

Claves de API

Cree y revoque claves de API para desarrolladores, envíelas a la API y sepa a qué puede y a qué no puede acceder una clave.

Qué conseguirá

Tendrá una clave que permite a su propio código usar su espacio de trabajo.

Requisitos previos

  • El rol de owner o admin.

Configuración paso a paso

  1. Abra Settings y la pestaña Profile & Account, y busque Developer API Keys («Keys for connecting your own apps to Phynxa»).
  2. Elija Create API Key (o Create your first key).
  3. Escriba un Key Name, por ejemplo «Zapier Integration» o «Production CRM», y elija Generate Key.
  4. Aparece el Important Secret Notice: «This key will not be shown again, so store it somewhere safe.» Elija Copy Key y guárdela, y después Done.

Usar la clave

Envíela como token Bearer:

bash
curl https://phynxa.com/api/agents \
  -H "Authorization: Bearer nxa_live_YOUR_KEY"

Una clave tiene el aspecto nxa_live_ seguido de 40 caracteres. La lista de Settings muestra solo sus cuatro últimos caracteres, su fecha de Created y su hora de Last Used.

A qué puede acceder una clave

Una clave actúa como administrador del espacio de trabajo en el que se creó, solo en estas partes de la API:

agents, calls, contacts, campaigns, tools, knowledge, webhooks, forms, captures, scheduled-calls, stats e insights.

No puede acceder a settings, team, billing, su cuenta, integraciones ni otras claves. Una solicitud a esas rutas con una clave recibe la respuesta 401 Sign in to continue.

Límites

  • 600 solicitudes por minuto y clave. Por encima de eso recibe 429 con «Rate limit reached for this key.»
  • Las llamadas realizadas a través de la API cuentan para los topes de marcación por hora (20 por persona, 200 por espacio de trabajo).

Revocar una clave

En la lista, elija Revoke en la clave y confirme («Revoke Developer API Key»). Deja de funcionar de inmediato. Hágalo si una clave puede haberse filtrado.

Uso

La pestaña API Usage de Settings muestra Total API Requests, Active API Keys, Tools & Actions Used y API Success Rate, un desglose por herramienta y punto de conexión, y la actividad reciente.

Prueba

Llame a GET /api/agents con su clave. Debería recibir una lista JSON de sus agentes. Después compruebe que Last Used se actualiza en Settings.

Resultado esperado

200 con sus agentes. Con una clave errónea o revocada: 401 {"detail":"Sign in to continue."}.

Solución de problemas

  • 401 con una clave correcta. La ruta no es una de las que puede usar una clave, o la clave se revocó.
  • Perdió la clave. No puede volver a mostrarse. Cree una nueva y revoque la antigua.

Seguridad y credenciales

Trate una clave como una contraseña: no la ponga en una aplicación de navegador ni en un repositorio público. Use una clave por integración para poder revocar una sin romper las demás.

Guías relacionadas

¿Algo de esto no coincide con lo que ve en el panel? Avísenos.