Saltar al contenido principal

​
Descripción general

Las claves de API proporcionan acceso programático a CaseBender. Abra Configuración → Cuenta → Claves de API para gestionar las claves disponibles para su cuenta y organización actual. La página proporciona:
  • Filtros de búsqueda, estado y nivel
  • Identificadores de clave enmascarados
  • Estado, nivel, hora del último uso y número de solicitudes
  • Estadísticas de uso
  • Acciones de ciclo de vida, como rotación, suspensión, revocación y eliminación
Una clave de API es una credencial. Guárdela en un gestor de secretos aprobado; nunca la incluya en el control de código fuente, registros, capturas de pantalla, tickets ni mensajes de chat.

​
Requisitos previos

  • Su rol debe permitir operaciones de escritura y la gestión de claves de API.
  • Los ámbitos disponibles se filtran según su rol.
  • Crear, revocar o eliminar una clave puede requerir autenticación reforzada.
  • Su organización puede imponer políticas adicionales de autenticación y acceso.
Los roles de solo lectura pueden ver la información permitida, pero no modificar claves.

​
Crear una clave de API

1

Abra Claves de API

Vaya a Configuración → Cuenta → Claves de API.
2

Inicie la creación

Seleccione Crear clave de API.
3

Describa la clave

Introduzca un Nombre claro y una descripción opcional que identifique la carga de trabajo, el responsable y la finalidad.
4

Seleccione un nivel

Elija el nivel adecuado para el volumen de solicitudes previsto de la carga de trabajo. Los niveles disponibles van de Basic a Unlimited.
5

Establezca una fecha de caducidad

Opcionalmente, introduzca el número de días hasta la caducidad. Para credenciales de producción, utilice preferentemente periodos cortos que se ajusten a la política.
6

Seleccione los ámbitos

Elija al menos un ámbito. Utilice Seleccionar todos solo cuando la carga de trabajo necesite legítimamente todos los ámbitos disponibles para su rol.
7

Cree y autentíquese

Seleccione Crear clave y complete la autenticación reforzada cuando se le solicite.
8

Guarde la credencial

Copie la clave completa desde Guarde su clave de API en un gestor de secretos aprobado antes de seleccionar Listo.
La clave completa solo se muestra una vez. CaseBender almacena únicamente la información necesaria para validarla e identificarla; la credencial en texto sin formato no se puede recuperar posteriormente.

​
Elegir ámbitos

Los ámbitos utilizan un patrón de recurso y acción, como cases:read u organizations:*. Las categorías de ámbitos pueden incluir casos, alertas, tareas, usuarios, equipos, organizaciones, configuración y gestión de claves de API. Aplique el principio de mínimo privilegio:
  • Utilice ámbitos de solo lectura para cargas de trabajo de informes y búsquedas.
  • Conceda ámbitos de escritura solo cuando la integración realice mutaciones.
  • Evite los ámbitos comodín y administrativos en las integraciones con una única finalidad.
  • Cree claves distintas para servicios o entornos no relacionados.
  • Revise los requisitos de ámbitos cada vez que cambie una integración.
El formulario de creación de Configuración solo ofrece los ámbitos permitidos por su rol actual. Las solicitudes de API se evalúan con respecto a los ámbitos de la clave y a los demás controles de datos aplicables.
Conceda api-keys:write, ámbitos comodín o ámbitos administrativos únicamente a automatizaciones de confianza que estén autorizadas explícitamente para crear o gestionar otras credenciales.

​
Elegir un nivel

El nivel registra la clase de servicio prevista para una clave. Los niveles disponibles son:
  • Basic
  • Standard
  • Professional
  • Enterprise
  • Unlimited
Los límites efectivos de solicitudes, operaciones masivas y concurrencia dependen de la configuración de la implementación. Valide el rendimiento y la aplicación de límites en producción con el administrador de la plataforma, en lugar de asumir que seleccionar un nivel cambia los límites activos o elimina las restricciones de una clave.

​
Autenticar solicitudes de API

Utilice la clave completa con uno de los encabezados compatibles de clave única.

​
Recomendado: token Bearer

​
Alternativa: X-Api-Key

Guarde la clave en una variable de entorno o en un mecanismo de inyección de secretos. No pegue una clave real directamente en el historial del shell ni en el código fuente.
Consulte la introducción a la referencia de la API para ver más ejemplos.

​
Comprender los estados de las claves

  • Las claves Activas pueden autenticar solicitudes, sujetas a las comprobaciones de ámbitos y políticas.
  • Las claves Suspendidas están deshabilitadas temporalmente y se pueden reactivar.
  • Las claves Revocadas dejan de ser válidas de forma permanente.
  • Las claves Caducadas han superado la fecha de caducidad configurada.

​
Ver estadísticas de uso

Abra el menú de acciones de una clave y seleccione Ver estadísticas para revisar:
  • Solicitudes totales
  • Solicitudes correctas
  • Solicitudes fallidas
  • Tiempo medio de respuesta
  • Endpoints principales
Utilice estas estadísticas para identificar credenciales sin uso, endpoints inesperados y cargas de trabajo que necesiten un nivel diferente.

​
Rotar una clave

La rotación sustituye el secreto actual por uno nuevo.
1

Prepare el consumidor

Confirme que puede actualizar de inmediato el servicio consumidor y que dispone de un plan de reversión.
2

Rote la clave

Abra el menú de acciones de la clave y seleccione Rotar clave.
3

Guarde la clave nueva

Copie la credencial que acaba de mostrarse en su gestor de secretos.
4

Actualice y compruebe

Actualice la carga de trabajo consumidora, reiníciela o vuelva a implementarla según sea necesario y realice una solicitud de prueba dentro del ámbito.
La rotación invalida el secreto anterior. Coordine el cambio para evitar la interrupción de una integración.
La rotación la inicia el operador. Un intervalo de rotación almacenado no garantiza por sí solo que CaseBender rote y distribuya automáticamente una clave de sustitución.

​
Suspender o reactivar una clave

Utilice Suspender para detener temporalmente una clave durante una investigación o un mantenimiento planificado. Utilice Reactivar solo después de confirmar que la credencial y su consumidor son de confianza. La suspensión es preferible a la eliminación cuando se necesita una acción de contención reversible.

​
Revocar una clave

Utilice Revocar cuando una credencial esté comprometida, haya dejado de ser de confianza o se retire de forma permanente. La revocación puede requerir autenticación reforzada y no se puede revertir. Después de revocarla:
  1. Elimine el secreto de todos los consumidores.
  2. Revise las estadísticas de uso y la telemetría de seguridad.
  3. Investigue las solicitudes inesperadas.
  4. Cree una clave de sustitución independiente solo si la carga de trabajo sigue estando autorizada.

​
Eliminar una clave

La eliminación borra el registro de la clave y su visibilidad directa para la gestión. Puede requerir autenticación reforzada.
Revoque una clave antes de eliminarla cuando necesite una secuencia clara de retirada de la credencial. El menú de acciones actual no muestra un cuadro de diálogo de confirmación independiente para todas las operaciones destructivas.

​
Recomendaciones de seguridad

  • Asigne un responsable humano y un responsable de la carga de trabajo identificados.
  • Utilice claves distintas para producción, preproducción y desarrollo.
  • Establezca una caducidad que se ajuste a su política de credenciales.
  • Rote la clave inmediatamente después de una posible exposición.
  • Supervise las solicitudes fallidas y los endpoints inesperados.
  • Revoque las claves sin uso en lugar de dejarlas activas.
  • Nunca envíe claves por correo electrónico ni mediante herramientas de colaboración.

​
Solución de problemas

​
Se rechaza Crear clave

Introduzca un nombre, seleccione al menos un ámbito, confirme que su rol tenga acceso de escritura y complete cualquier desafío de autenticación reforzada.

​
Una solicitud de API devuelve 401

Confirme que se proporcione la clave activa completa como token Bearer o X-Api-Key, y compruebe que no haya caducado ni se haya suspendido o revocado.

​
Una solicitud de API devuelve 403

La clave se ha autenticado correctamente, pero no dispone del ámbito o acceso a datos necesario. Añada únicamente el ámbito mínimo necesario mediante un flujo de gestión de claves autorizado.

​
Las solicitudes están limitadas por tasa

Reduzca la frecuencia de las solicitudes, respete las indicaciones de reintento de la respuesta o pregunte a un administrador si la carga de trabajo necesita otro nivel.

​
La clave completa ya no está visible

Las claves en texto sin formato no se pueden recuperar. Rote la clave o cree una de sustitución y actualice el consumidor.

​
Referencia de la API

​
Guías relacionadas