Documentación de BizCortex

Claves de API

Claves que permiten a otros programas acceder a los datos de su empresa a través de la API REST.

Las claves de API dan a las integraciones acceso a esta empresa. Trátelas como contraseñas. Abra «Ajustes» y la pestaña «Claves de API». La tabla muestra el nombre, el prefijo (los primeros caracteres de la clave), el rol, la fecha de creación, «Último uso», «Caduca» y el estado Activa o Revocada.

Claves de API
Captura de pantalla de esta vista

Quién puede usarlo

  • Propietario
  • Administrador

Pasos

  1. 1. Cree una clave

    Haga clic en «Crear clave». Introduzca un nombre, por ejemplo «DATEV Export», elija el rol y, si lo desea, una fecha de caducidad. Haga clic en guardar.

  2. 2. Copie la clave

    El cuadro de diálogo «Clave de API creada» muestra la clave una sola vez. Haga clic en el botón de copiar y guarde la clave en un lugar seguro. No se volverá a mostrar.

  3. 3. Revoque una clave

    Abra el menú de la fila y elija «Revocar». Confirme «¿Revocar la clave?». La clave deja de funcionar de inmediato.

Campos y opciones

Nombre

Obligatorio. Le ayuda a reconocer la integración.

Rol

Los permisos de la clave, como máximo los de su propio rol. No se puede elegir Propietario. El valor predeterminado es Lector.

Caduca

Fecha opcional a partir de la cual la clave deja de funcionar.

Consejos

  • Cree una clave por integración para poder revocarla sin afectar a las demás.
  • Asigne a cada clave el rol más restringido que necesite. Una herramienta de informes suele necesitar solo Lector.
  • Un proveedor de identidad puede desactivar automáticamente a los usuarios que dejan la empresa a través de la interfaz SCIM. Para ello necesita una clave con el rol Administrador.

Conviene saber

  • Solo se guarda una huella de la clave. Si pierde la clave, revóquela y cree una nueva.
  • Cuando se da de baja a un usuario, también se revocan las claves de API que creó.
  • La creación y la revocación de claves se registran en el registro de auditoría.

Relacionado