La sección Claves API en RUFUS Cloud le permite generar y administrar claves API para integrar sus dispositivos y software de cronometraje con RUFUS Cloud a través de **RUFUS Public API**. Esta funcionalidad le permite acceder y administrar de forma remota sus dispositivos de cronometraje, ofreciendo flexibilidad y control para todas sus necesidades de integración.
Cada cuenta de empresa puede crear hasta 10 claves API, y puede personalizar los permisos para garantizar que cada aplicación solo obtenga el nivel de acceso que necesita. La sección Claves API es accesible haciendo clic en su correo electrónico o nombre de empresa en la esquina superior derecha de la barra de navegación y seleccionando la pestaña Claves API.
Creación de una nueva clave API
Para crear una nueva clave API, siga estos pasos:
- Alias: introduzca un alias para su clave API. Se trata simplemente de una etiqueta para ayudarle a identificar el propósito de la clave.
- Tipo de acceso: Seleccione el tipo de acceso adecuado para su clave: * READ: concede permiso para llamar a todos los métodos GET. La clave puede leer información de dispositivos, sesiones y pases. * WRITE: concede permiso para llamar a todos los métodos POST y PATCH. La clave puede vincular dispositivos, insertar sesiones y agregar pases. * READ_WRITE: concede permiso para llamar a todos los métodos, incluidos GET, POST, PATCH y DELETE.
- Desvincular dispositivo: para las claves WRITE y READ_WRITE, puede activar o desactivar la opción Permitir desvincular dispositivo, que otorga permiso para llamar al método DELETE y eliminar un dispositivo de la cuenta.
- Haga clic en Crear clave API para generar la clave. La nueva clave se mostrará en la lista Claves API activas.
Administración de claves API activas
Una vez que se crea una clave API, esta aparece en la lista Claves API activas. Aquí, puede:
- Ver detalles: La lista muestra el alias, la clave API, el tipo de acceso y si tiene permiso para desvincular dispositivos.
- Eliminar claves: Si ya no se necesita una clave API, se puede eliminar de esta lista para revocar sus permisos.
API: Descripción general de los permisos
- LEER: concede permiso para llamar a todos los métodos GET, lo que permite a la aplicación leer información de dispositivos, sesiones y pases.
- ESCRIBIR: Otorga permiso para llamar a todos los métodos POST y PATCH, lo que permite la vinculación de dispositivos y la inserción de sesiones y pases.
- READ_WRITE: Proporciona acceso completo, lo que permite a la aplicación llamar a todos los métodos (GET, POST, PATCH, DELETE).
- Desvincular dispositivo: este permiso solo está disponible para las claves API WRITE y READ_WRITE. Permite que un dispositivo se elimine de su cuenta llamando al método DELETE.
Casos de uso típicos
Para ilustrar cómo se pueden utilizar las claves API, aquí hay algunos ejemplos:
- Dispositivos (ESCRIBIR): Crea una clave API para tus dispositivos de temporización personalizados RFID, lo que les permite vincularse con RUFUS Cloud e insertar datos de sesión.
- Aplicación de cronometraje (READ_WRITE): Utilice una clave API para su software de cronometraje o aplicación de cronometraje manual, otorgándole acceso completo para leer y gestionar sesiones y pasadas.
- Aplicación de clasificación (LEER): configure una clave API para su software de clasificación, lo que le permitirá leer datos como información del dispositivo, sesiones y pases.
- Administrador (READ_WRITE, Unbind = true): genera una clave API para tu panel de administración de tiempo, con permisos completos, incluida la capacidad de desvincular dispositivos de tu cuenta.
Documentación pública API
Para obtener más información sobre la integración de sus sistemas con RUFUS Cloud, puede acceder a la **documentación pública de API**. Esta documentación proporciona detalles sobre cómo utilizar los diferentes puntos de conexión y métodos disponibles.
Seguridad y gestión
Las claves API son una parte fundamental para gestionar su integración de forma segura y eficaz. Asegúrese de que las claves solo se proporcionen a aplicaciones de confianza y elimine siempre las claves que ya no se utilicen para mantener la seguridad del sistema. La gestión adecuada de sus claves API le ayudará a mantener sus datos seguros y sus integraciones funcionando sin problemas.