¿Cómo puedo crear y gestionar claves API para conectar otros programas a Corfix?

Si su empresa desea conectar Corfix a otro sistema de software, como una plataforma de nóminas, de contabilidad o de planificación de recursos empresariales (ERP), necesitará una clave API. Este artículo le guía a través del proceso de creación, edición y eliminación de claves API, y explica quiénes de su equipo pueden gestionarlas.

• Necesita permiso para gestionar claves API. Su rol debe tener habilitados los permisos de claves API (consulte «¿Quién puede gestionar claves API?» más abajo). Si no ve el botón «Gestionar claves API», póngase en contacto con el administrador de su empresa.
• Póngase en contacto con su gestor de éxito del cliente o consulte la documentación de la API.
• El secreto de la clave solo se muestra una vez. Cuando crea una clave, Corfix muestra el secreto una única vez. Si lo pierde, no podrá recuperarlo; tendrá que eliminar la clave y crear una nueva.
• La eliminación de una clave es definitiva. Cualquier conexión que utilice dicha clave dejará de funcionar de inmediato.

Una clave API funciona como una contraseña especial para programas informáticos, en lugar de para personas. Permite que otro sistema, como su plataforma de nóminas o de contabilidad, se comunique de forma segura con Corfix en nombre de su empresa sin que nadie tenga que iniciar sesión manualmente.

Cada clave consta de dos partes:

• Un nombre y una descripción para que pueda recordar para qué se utiliza la clave (por ejemplo, «Acumatica»).
• Un «secreto», que es la contraseña propiamente dicha que utiliza el otro software. Trátelo como cualquier otra contraseña: manténgalo en secreto y guárdelo en un lugar seguro.

A cada clave se le asigna además un «Rol», que controla lo que el software conectado puede ver y hacer en Corfix. Por ejemplo, una clave a la que se le haya asignado el rol de «Admin» puede acceder a la misma información que un usuario con privilegios de administrador.

Creación de una clave API

1. Vaya a «Detalles de mi cuenta» en el menú de la izquierda.
2. En «Datos de la empresa», haga clic en «Gestionar claves API».
3. En la página «Claves API», haga clic en el botón azul «Añadir» situado en la esquina superior derecha.
4. En la ventana «Añadir clave API»:
   • Introduzca un nombre para la clave (obligatorio, de al menos 3 caracteres). Utilice un nombre que describa a qué se conecta, como «Acumatica».
   • Si lo desea, añada una «Descripción» con más detalles.
   • Seleccione una función. Esto determina a qué puede acceder el software conectado. Elija la función más restringida que permita que la conexión siga funcionando.
5. Haga clic en «Guardar».
6. Aparecerá una ventana de confirmación con el «Secreto» de su clave. Haga clic en «Copiar» y guarde el secreto inmediatamente en un lugar seguro; esta será la única vez que se muestre.
7. Haga clic en «Aceptar» para finalizar. Su nueva clave aparecerá ahora en la lista de claves API.

Edición o eliminación de una clave API

1. En la página «Claves API», busque la clave en la lista.
2. Haga clic en «Elegir acción» en la columna «Acciones»
3. Seleccione «Editar» para actualizar el nombre, la descripción o la función de la clave, o seleccione «Eliminar» para borrarla.

Advertencia: Al eliminar una clave, se desconectará inmediatamente cualquier software que la esté utilizando. Elimine una clave únicamente si está seguro de que ya no es necesaria o si cree que el secreto ha quedado expuesto.

¿Quién puede gestionar las claves API?

Los administradores pueden controlar qué roles tienen permiso para trabajar con claves de API. En la configuración de su rol, la sección «Permisos de claves de API» contiene cuatro botones de activación/desactivación:

1. Ver claves API: consulte la lista de claves.
2. Añadir clave de API: cree nuevas claves.
3. Editar clave de API: cambie el nombre, la descripción o el rol de una clave.
4. Eliminar clave API: elimine claves.

Active únicamente los permisos que necesite cada rol y, a continuación, haga clic en «Guardar».

• Conecte su software de nóminas: envíe automáticamente los datos de horas y nóminas entre Corfix y su plataforma de nóminas, eliminando las exportaciones manuales.
• Sincronice con su sistema de contabilidad o ERP: mantenga los proyectos y registros alineados entre sistemas, como Acumatica o Sage.
• Controle exactamente a qué puede acceder el software conectado: al asignar un rol a cada clave, la conexión solo ve lo que necesita, nada más.
• Revoque el acceso al instante: si una conexión ya no es necesaria o se ha filtrado una clave secreta, al eliminar la clave se interrumpe el acceso de inmediato.
• Realice un seguimiento de sus conexiones: la lista de claves API muestra el nombre, la descripción, la fecha de creación y el rol de cada clave, para que siempre sepa qué está conectado y por qué.