API KEY CONFIGURATION

Configurar la clave API de Cloud kiconex en Core

La clave API permite que Core kiconex se autentique en Cloud kiconex y consulte la información necesaria para su funcionamiento.

La configuración de esta clave es necesaria para utilizar las secciones de Core que obtienen información desde Cloud kiconex. No es necesario generar una clave API para utilizar normalmente la plataforma Cloud kiconex.

Importante: la clave API es una credencial privada asociada al usuario que la genera. No debe compartirse, publicarse en documentación ni incluirse en capturas de pantalla, correos o tickets de soporte.

Antes de comenzar

Para realizar la configuración necesita:

• Un usuario con acceso a Cloud kiconex.
• Acceso a las instalaciones y datos que se desean consultar desde Core.
• Acceso a la configuración de Core kiconex.
• Una clave API activa de Cloud kiconex.

La clave debe generarse desde el usuario cuyos datos y permisos vayan a utilizarse en Core.

Obtener la clave API en Cloud kiconex

La clave API se administra desde el perfil del usuario de Cloud kiconex.

1. Acceda a Cloud kiconex.

1. Abra el menú del usuario situado en la parte superior derecha.

1. Acceda al perfil de usuario.

1. Pulse el botón de edición del perfil.

1. Seleccione la pestaña Acceso API.

1. Compruebe si el usuario ya dispone de una clave API.

1. Si no existe ninguna clave, pulse el botón + para crearla.

1. Introduzca un nombre identificativo.

1. Añada una descripción cuando sea necesario indicar para qué aplicación se utilizará.

1. Guarde la nueva clave.

1. Copie la clave generada para introducirla posteriormente en Core kiconex.

Formulario para crear una nueva clave API en el perfil de Cloud kiconex.

Cloud kiconex permite disponer de una clave API por usuario. Si el usuario ya tiene una clave activa, puede reutilizarla o renovarla desde esta misma sección.

Puede consultar el procedimiento completo en Acceso API del perfil de usuario.

Configurar la clave en Core kiconex

Después de obtener la clave en Cloud kiconex:

1. Acceda a Core kiconex.

1. Edite su perfil.

1. Localice la pestaña Claves API.

1. Pegue la clave completa en el campo Clave API Cloud, sin añadir espacios al principio o al final.

1. Pulse Guardar.

Campo utilizado para configurar la clave API de Cloud kiconex en Core.

Una vez guardada, Core utilizará esta credencial para realizar las consultas necesarias a Cloud kiconex.

Renovar o sustituir la clave

La clave configurada en Core debe actualizarse cuando:

• La clave se haya renovado desde Cloud kiconex.
• La clave anterior se haya eliminado.
• Exista la posibilidad de que la clave haya quedado expuesta.
• Core deje de acceder a Cloud debido a una clave no válida.
• Se necesite utilizar la clave de otro usuario autorizado.

Cuando se renueva una clave en Cloud kiconex, copie la nueva clave y sustitúyala también en la configuración de Core.

Eliminar una clave

La clave puede eliminarse desde la pestaña Acceso API del perfil de usuario.

Antes de eliminarla, compruebe que no está siendo utilizada por Core u otra integración. Al eliminar una clave utilizada por una aplicación, dicha aplicación dejará de poder autenticarse en Cloud kiconex hasta que se configure una nueva.

Problemas frecuentes

Core no muestra información de Cloud kiconex

Compruebe los siguientes puntos:

• El campo Clave API Cloud no está vacío.
• La clave se ha copiado completa.
• No se han añadido espacios antes o después de la clave.
• La clave continúa existiendo en el perfil de Cloud kiconex.
• La clave configurada en Core corresponde a la versión más reciente.
• El usuario dispone de acceso a las instalaciones y datos que necesita consultar.

Core dejó de funcionar después de renovar la clave

La clave guardada en Core continúa siendo la anterior.

Copie la nueva clave desde Cloud kiconex, introdúzcala en el campo Clave API Cloud y vuelva a guardar la configuración.

No se puede crear otra clave API

Cloud kiconex permite una clave API por usuario. Si ya existe una clave, puede:

• Reutilizar la clave existente.
• Renovarla.
• Eliminarla y crear una nueva.

Antes de renovar o eliminar una clave, revise si está siendo utilizada por Core u otra integración.

La clave ha quedado expuesta

Renueve la clave desde Cloud kiconex y actualice inmediatamente su configuración en Core y en cualquier otra aplicación que la utilice.

No vuelva a utilizar la clave anterior.

Buenas prácticas de seguridad

• Trate la clave API como una contraseña.
• No publique la clave.
• No incluya la clave en capturas de pantalla.
• No la envíe mediante canales no seguros.
• Utilice un nombre y una descripción que permitan identificar su finalidad.
• Renueve la clave cuando exista sospecha de acceso no autorizado.
• Elimine las claves que ya no sean necesarias.
• Revise que el usuario asociado mantenga únicamente los accesos necesarios.

Enlaces relacionados

• Perfil de usuario
• Gestionar el acceso API
• Permisos de usuario
• Acceso a Cloud kiconex
• Acceder a Cloud kiconex