Llaves de API

Las llaves de API permiten que sistemas externos se integren con Xignable de forma segura y controlada, autenticándose mediante credenciales propias en lugar de utilizar las credenciales de un usuario humano.

Cada llave de API está compuesta por dos elementos:

• Llave: identificador público de la llave.
• Secreto: valor confidencial utilizado para autenticar las solicitudes.

La gestión de llaves de API está disponible únicamente para colaboradores con el rol de Administrador de la organización.

Tabla de llaves de API

Desde el menú Organización → Llaves de API podrás ver todas las llaves definidas en tu organización. La tabla muestra la siguiente información para cada llave:

• Llave: identificador de la llave.
• Secreto: valor del secreto (enmascarado por seguridad).
• Colaborador asociado: colaborador al que se le atribuirán las acciones realizadas con esta llave. Si no hay ninguno asociado, las acciones no se imputarán a un colaborador en particular.
• Habilitada: indica si la llave está activa y puede utilizarse para autenticarse.
• Válida desde: fecha a partir de la cual la llave es válida. Si no se especifica, la llave no tiene restricción de fecha de inicio.
• Válida hasta: fecha hasta la cual la llave es válida. Si no se especifica, la llave no vence.

Colaborador asociado

Las llaves de api que no se asocian a un colaborador adquieren el rol de Administrador de la organización, por lo que su capacidad de llevar a cabo acciones no tiene límites dentro de la suscripción.

Una forma de limitar esta capacidad es asociar la llave de API a una cuenta de colaborador, y asignar a ésta última los roles estrictamente necesarios.

Todas las acciones que se invoquen con dicha llave de API serán registradas y ejecutadas bajo el contexto del colaborador asociado.

Crear una nueva llave de API

Para crear una nueva llave de API, sigue estos pasos:

1. Ingresa al menú Organización → Llaves de API.
2. Presiona el botón Crear nueva llave.
3. En la ventana que se abre, completa los siguientes datos:
   • Habilitada: marca este casillero si deseas que la llave esté activa desde el momento de su creación.
   • Colaborador asociado: opcionalmente, busca y selecciona el colaborador al que se atribuirán las acciones realizadas con esta llave.
   • Válida desde: opcionalmente, ingresa la fecha a partir de la cual la llave será válida.
   • Válida hasta: opcionalmente, ingresa la fecha de vencimiento de la llave.
4. Presiona Guardar.

Editar una llave de API

Para modificar una llave existente, presiona el ícono de edición (lápiz) en la fila correspondiente. Desde el formulario de edición podrás:

• Habilitar o deshabilitar la llave mediante el casillero Habilitada.
• Modificar el colaborador asociado.
• Cambiar las fechas de validez.
• Rotar el secreto: si marcas la opción Rotar secreto, se generará un nuevo valor de secreto al guardar. El secreto anterior quedará invalidado inmediatamente.

Eliminar una llave de API

Para eliminar una llave, presiona el ícono de eliminación (cruz) en la fila correspondiente y confirma la acción.