Saltar al contenido principal

Gestión de Claves de API

El módulo de Claves de API te permite crear y administrar credenciales seguras para integrar tu Panel de Gestión con aplicaciones externas (como ERPs, sistemas de facturación u otros servicios).

:::note Nivel de Acceso Por motivos de seguridad, este módulo está restringido. Únicamente los usuarios con rol de Administrador tienen permisos para acceder y generar nuevas credenciales. :::

Listado de Credenciales​

Al ingresar a la vista de Claves de API, visualizarás una tabla con todas las credenciales generadas previamente. La tabla incluye la siguiente información:

  • Nombre: Nombre descriptivo asignado a la clave para identificar su uso.
  • Prefijo de Clave: Los primeros caracteres de la clave pública (identificador), útiles para reconocer la credencial sin exponer el secreto completo.
  • Estado: Indica si la clave se encuentra Activa (operativa) o Inactiva (bloqueada temporalmente).
  • Último Uso: Fecha de la última vez que un sistema externo utilizó esta credencial para conectarse.

Acciones sobre las claves existentes​

Desde la tabla de listado, puedes gestionar el ciclo de vida de cada clave utilizando los botones de la columna "Acciones":

  1. Activar / Bloquear: Puedes pausar temporalmente el acceso de una clave externa (estado inactivo) o volver a habilitarla mediante el botón circular de verificación/bloqueo.
  2. Eliminar: Elimina la clave de forma permanente. Esta acción es irreversible y cualquier sistema que esté usando esta clave perderá la conexión inmediatamente.

Generar una Nueva Credencial​

Para crear una nueva clave y conectar un sistema externo, haz clic en el botón "Nueva Clave". Serás redirigido a un formulario donde debes configurar lo siguiente:

1. Detalles de la Credencial​

  • Nombre Descriptivo: Obligatorio. Ingresa un nombre que te ayude a identificar dónde se usará (Ej. "Integración Facturación ERP").
  • Descripción: Opcional. Útil para documentar casos de uso más específicos.
  • Entorno: Selecciona si la clave operará en Producción (datos reales) o Sandbox (entorno de pruebas).

2. Permisos (Scopes)​

Para mantener la máxima seguridad, debes otorgar únicamente los permisos necesarios para la integración:

  • Leer Órdenes (read:orders): Permite al sistema externo ver listados y detalles de las órdenes de servicio.
  • Crear/Editar Órdenes (write:orders): Permite al sistema externo crear nuevos ingresos y modificar órdenes existentes.
  • Acceso Admin (read:admin): Otorga acceso a métricas y configuración sensible.

Consideraciones Críticas de Seguridad​

Al finalizar la creación de la clave haciendo clic en "Generar Clave", el sistema mostrará una pantalla de éxito con dos datos esenciales:

  1. Clave Pública (Identificador): Es el API Key público de la integración.
  2. Clave Secreta (Privada): Es el token que autoriza las transacciones.

:::danger ¡IMPORTANTE! Copia tu Clave Secreta La Clave Secreta (Privada) se mostrará una única vez al momento de crear la credencial. Por protocolos de seguridad, el sistema no vuelve a mostrar esta clave en el futuro.

Asegúrate de copiarla (usando el botón dispuesto para ello) y guardarla en un entorno seguro antes de hacer clic en "He guardado la clave secreta, continuar". Si la pierdes, tendrás que eliminar la credencial y crear una nueva. :::