Claves de API

Un « Clave de API » es una credencial que autoriza a una aplicación a enviar solicitudes a una API de RICOH TotalFlow Cloud en nombre de su cuenta. Las claves API se definen en RICOH Account Administration.

Las aplicaciones que utilizan una API en lugar de la interfaz de usuario no pueden iniciar sesión como usuario. En cambio, cada solicitud incluye el valor de una clave API, que identifica la cuenta a la que pertenece la solicitud. Dado que la clave contiene la identidad de su cuenta, no es necesario incluir un parámetro de cuenta o de inquilino en las solicitudes.

Puede definir hasta diez claves para su cuenta. Muchas organizaciones crean una clave para cada aplicación que recupera datos, de modo que se pueda sustituir o eliminar una clave sin interrumpir el funcionamiento de las demás aplicaciones. Cada clave tiene un nombre, una descripción y una fecha de caducidad.

El valor de una clave solo se muestra una vez, en el momento en que se crea o se renueva la clave. Account Administration no almacena el valor en un formato que permita volver a mostrarlo, por lo que deberá copiarlo y guardarlo de forma segura cuando se muestre. Si se pierde un valor, se gira la llave para generar uno nuevo. Cualquier persona que disponga de dicho valor puede enviar solicitudes en nombre de su cuenta, por lo que debe proteger las claves del mismo modo que protege una contraseña. Las claves no están limitadas a impresoras concretas.

Las claves se gestionan en la pestaña « Claves de API ». Puede modificar el nombre, la descripción o la fecha de caducidad de una clave; rotar una clave para sustituir su valor sin alterar su identidad; o eliminar una clave para revocar el acceso de forma inmediata.

En RICOH TotalFlow Cloud, las claves API se utilizan con la API de exportación de datos, que recupera información sobre impresoras, trabajos y el estado de las impresoras recopilada por RICOH Predictive Insight. El número de solicitudes a la API que puede realizar su cuenta, en todas las claves API, viene determinado por su suscripción. Cada suscripción establece un límite máximo para el número de solicitudes de API permitidas en un periodo de 30 días consecutivos. Si supera el número de llamadas que le permite su suscripción, no se aceptarán solicitudes hasta que el total de solicitudes de los últimos 30 días sea inferior al límite de la suscripción. Para consultar cuántas llamadas incluye su suscripción y cuántas ha utilizado en los últimos 30 días, acceda a la página « Claves de API ». Si considera que necesita más capacidad para las solicitudes de API, consulte a su representante de RICOH sobre la posibilidad de ampliar su suscripción.