Claves de API
En esta página
Las claves de API permiten que tu propio software, o cualquier sistema de terceros compatible con BYOK (Bring Your Own Key, trae tu propia clave), use los modelos que publica Performance Hub. Las claves se administran en Settings (engranaje) → Service Access & API Keys. Para administrarlas, debes ser Organisation Administrator.
"Aprovisiona claves de API para que el software y los sistemas de terceros que admiten BYOK (Bring Your Own Key) puedan conectarse a los modelos publicados por Performance Hub."
Figura 1: La lista de claves de API: etiqueta, clave enmascarada, estado, gasto y límites, modelos, último uso y las acciones de fila
La lista de claves
| Columna | Significado |
|---|---|
| Label | El nombre opcional que le diste a la clave. |
| Key | La clave enmascarada (por ejemplo, phk_7Qm2…Xa9LkP): el secreto completo no se vuelve a mostrar después de crearla. |
| Status | Active, Provisioning… (brevemente, mientras se configura una clave nueva) o Disabled (revocada; la fila aparece atenuada). |
| Spend / limits | El gasto de por vida y el avance hacia los límites de gasto establecidos en la clave. |
| Models | all o la cantidad de modelos a los que está restringida la clave. |
| Last used | Cuándo hizo la clave su última solicitud. |
| Actions | Edit, Rotate, Revoke (o Re-activate) y Delete. |
Si usas Workflows, una fila Workflows muestra Managed service en lugar de una clave enmascarada. Si no hay ninguna clave, la lista muestra "No API keys yet."
Crear una clave
Haz clic en Create key. Se abre el panel Create API key:
Figura 2: El panel Create API key: etiqueta, tipo de conexión, límites de gasto, límites de frecuencia, restricción de modelos y anulación de las protecciones
| Configuración | Comportamiento |
|---|---|
| Label (optional) | Un nombre para la clave, normalmente el del sistema al que corresponde (por ejemplo, Hotel Concierge App, Clinic Intake Assistant o Booking Website). Muy recomendable: las etiquetas son la forma en que se atribuye el uso en Activity y Logs. |
| Connection type | API key: "Generic API keys remain in the API Keys list." External agent: "External agents appear under Connected Services and use this key to authenticate." Se establece al crear la clave y no se puede cambiar después. |
| Set spend limits for this key | "Set any combination of daily, monthly and lifetime caps for this key.": Daily limit ("Resets at the start of each day (facility timezone)."), Monthly limit ("Resets on the 1st of each month (facility timezone).") y Lifetime cap ("Total spend over the lifetime of this key. Never resets."). |
| Rate limits (optional) | "Cap requests and tokens per minute for this key. Leave blank for unlimited.": Requests / min y Tokens / min. |
| Restrict models for this key | "Only the selected models will be usable with this key." Elige entre los modelos habilitados en la instalación. |
| Override facility guardrails for this key | "Select none to explicitly disable guardrails for this key." Cuando está activada, esta clave usa su propia selección de protecciones en lugar de la de la instalación, incluida la opción "none". Consulta Guardrails. |
Haz clic en Create key.
El secreto de visualización única
La nueva clave se muestra una sola vez, en el cuadro de diálogo Copy your API key:
Figura 3: La nueva clave se muestra una sola vez: cópiala antes de cerrar el cuadro de diálogo
"Esta es la única vez que se muestra la clave completa. Guárdala en un lugar seguro."
Cópiala en tu administrador de secretos antes de hacer clic en Done. Después de cerrar este cuadro de diálogo, solo se muestra la forma enmascarada. Si pierdes el secreto, usa Rotate en la clave para obtener uno nuevo.
Editar una clave
Haz clic en la fila de una clave (o en su lápiz Edit) para abrir el panel Configure API key, con la misma configuración que al crearla (etiqueta, límites de gasto, límites de frecuencia, restricción de modelos y anulación de las protecciones):
Figura 4: El panel Configure API key
Los cambios se aplican pocos instantes después de guardar. Cuando una clave tiene límites diarios o mensuales, su fila muestra el uso respecto de ellos (Today, This month, Lifetime) y una insignia Limit reached cuando se alcanza alguno.
Ciclo de vida de las claves: rotar, revocar y eliminar
Cada acción tiene un cuadro de diálogo de confirmación que indica exactamente lo que va a ocurrir:
| Acción | Efecto | Texto de confirmación |
|---|---|---|
| Rotate | Emite un nuevo secreto (que se muestra una sola vez) con la misma configuración; el secreto anterior deja de funcionar de inmediato. | "A new key will be issued and the current key will stop working immediately." "You will need to reconfigure any services still using the old key. This cannot be undone." |
| Revoke | Deshabilita la clave de inmediato, de forma reversible. | "This key will be disabled immediately and any services using it will stop working. You can re-activate it again later." |
| Re-activate | Restaura una clave revocada (con el mismo secreto). | Ninguno: se ejecuta de inmediato. |
| Delete | Elimina la clave de forma permanente. | "This permanently deletes the key and any services using it will stop working. This cannot be undone." |
Figura 5: La confirmación Delete API key
Cuál usar: rota la clave si sospechas de una filtración (el servicio conserva su configuración y su historial; solo actualiza el secreto); revócala para pausar un sistema temporalmente; elimínala solo cuando la integración haya dejado de usarse definitivamente.
Conectarse con una clave
La tarjeta Connecting to the API, debajo de la lista de claves, muestra la URL base y una solicitud de ejemplo lista para copiar y pegar para tu entorno. Consulta Conectar tu aplicación para ver la guía de inicio rápido completa con ejemplos de SDK y gestión de errores.