API de exportación de datos

La API de exportación de datos es una API REST que ofrece cuatro puntos de conexión. Puede utilizar esos puntos de conexión para descargar información sobre sus impresoras y los trabajos que han procesado, así como sobre los estados de funcionamiento de dichas impresoras a lo largo del tiempo y los eventos que han activado mensajes de advertencia o de error en la impresora.

Puede utilizar la API de exportación de datos para importar datos de RICOH Predictive Insight a herramientas de inteligencia empresarial, almacenes de datos, paneles de control y otras aplicaciones de su organización.

Autenticación

Puede crear y gestionar claves API en RICOH Account Administration. Puede crear tantas claves como necesite: una por cada aplicación que descargue datos o una clave para su uso en toda su organización. Configure la fecha de caducidad de acuerdo con sus prácticas de seguridad y renueve las claves según sea necesario. Puede configurar el periodo de solapamiento, de modo que tanto la clave antigua como la nueva funcionen durante varios días. Si es necesario, puede eliminar una clave para desactivarla de inmediato.

La clave API también incluye su identidad de inquilino, por lo que no es necesario incluir ningún parámetro de inquilino o de cuenta en ninguna solicitud. Cualquier persona que disponga de ese valor de clave puede enviar solicitudes en nombre de su inquilino, por lo que debe proteger las claves API del mismo modo que protegería una contraseña.

Puntos finales disponibles

La API incluye los siguientes puntos finales:

/printers
Devuelve la lista de impresoras de su cuenta, incluyendo el nombre de la impresora, el modelo, el fabricante, el número de serie, los motores y el estado actual de la conexión.
/jobs
Proporciona información detallada a nivel de trabajo sobre una o varias impresoras, incluyendo la duración, el número de copias impresas, las páginas, las impresiones, las hojas, la longitud del rollo y el consumo de tinta y de Vaciado por canal de color. Por defecto, la respuesta abarca las últimas 24 horas.
/printer-states
Devuelve el estado de funcionamiento de cada motor de impresión, ya sea como un historial agregado correspondiente a un intervalo de tiempo o únicamente como el estado actual. Puede consultar los estados reales de la impresora, tales como: Printing, Preparing, Maintenance o sleeping, o bien agrupar dichos estados en las siguientes categorías: up, down, idle» o unknown.

Consejo: El punto final /printer-states proporciona información sobre el estado de cada engine de impresión, no de cada impresora. Una impresora con varios motores devuelve una fila por cada motor.

/printer-interventions
Devuelve los eventos que han provocado advertencias o errores en una o varias impresoras, como un atasco de papel o una fuente de papel vacía. Cada evento se registra para un único motor de impresión, indicando la hora de inicio, la hora de finalización, la duración, un código que identifica la condición y el nombre del trabajo que se estaba imprimiendo, si lo hubiera. Por defecto, la respuesta abarca las últimas 24 horas. Puede solicitar las descripciones de los eventos en cualquiera de los idiomas disponibles.

Pruebas de la API

Hay disponible una página de documentación interactiva que le permite revisar cada punto final, consultar los parámetros que admite y probar solicitudes de ejemplo directamente desde su navegador. Para abrir la página, vaya a:

Para enviar solicitudes desde la página de documentación o desde sus propias aplicaciones, primero debe crear una clave API. Puede crear y gestionar claves API en Account Administration.

Tema principal: Cómo trabajar con la API de exportación de datos