Obtención de información de las impresoras a través de la integración

Parámetros

  • api_token - parámetro obligatorio. Token de integración del proveedor de subcontratación cuyos datos deben recuperarse. Este token puede obtenerse en el menú Configuración > Integración, en el sitio web de PrintWayy;
  • company_token - parámetro opcional. Token para identificar de qué cliente deben obtenerse los datos. Cada cliente registrado en PrintWayy tiene su propio token. El token de cada cliente puede ser consultado a través del método de búsqueda de información del cliente detallado anteriormente. Si no se informa de este parámetro, el parámetro serialNumbers pasa a ser obligatorio;
  • serialNumbers - parámetro opcional. Debe utilizarse para informar el número de serie de la impresora de la que se desea obtener datos. Se puede informar de más de un número de serie por solicitud, separándolos con una coma. Si no se informa de este parámetro, se buscarán todas las impresoras del cliente;
  • initialDate - parámetro opcional. Corresponde a la fecha inicial para la que se desea buscar los contadores. Debe informarse en el formato DD-MM-AAAA. Si no se informa de este parámetro, se utilizará la fecha actual del servidor de PrintWayy como fecha inicial;
  • endDate - parámetro opcional. Si se informa de la fecha de inicio de la búsqueda, se debe informar de la fecha de finalización. Debe informarse en el formato DD-MM-AAAA. Si no se informa de este parámetro, se utilizará la fecha actual del servidor de PrintWayy como fecha de finalización.

Formato de las respuestas

Todas las respuestas a las solicitudes tendrán los siguientes campos, que indican si la solicitud se ha cumplido o no:

  • Éxito - Valor booleano que indica si la solicitud fue atendida con éxito o no;
  • Código - código que indica el resultado de la solicitud. Los posibles códigos de retorno son:
    • 0 - Petición satisfecha;
    • 1 - El token de la API no ha sido introducido o es incorrecto;
    • 2 - La ficha de la empresa cliente no se ha introducido o es incorrecta;
    • 3 - El período de fecha informado no es válido;
    • 999 - Error al solicitar información. Por favor, inténtalo de nuevo.

Cuando el procesamiento de la solicitud encuentra uno o más dispositivos según los parámetros pasados, además de los campos anteriores, se devolverá la siguiente información para cada impresora:

  • SerialNumber - número de serie del equipo;
  • Departamento - nombre del departamento donde se encuentra la máquina, si está configurada en PrintWayy;
  • Ubicación - Ubicación actual de la impresora;
  • AssetNumber - Número de activo del equipo;
  • Contrato - Nombre del contrato asociado a la impresora.
  • IPAddress - Dirección IP del equipo, si es monitoreado a través de la red;
  • GeneralCountStartDateOfCapture - fecha y hora de la primera captura del contador general, considerando la fecha inicial del periodo informado;
  • GeneralCountEndDateOfCapture - fecha y hora de la última captura del contador general, considerando la fecha de finalización del periodo informado;
  • GeneralCountStart - valor del contador general en la primera captura;
  • GeneralCountEnd - valor del contador general en la última captura;
  • MonoCountStartDateOfCapture - fecha y hora de la primera captura del contador B&W, considerando la fecha inicial del periodo informado;
  • MonoCountEndDateOfCapture - fecha y hora de la última captura del contador B&W, considerando la fecha de finalización del periodo informado;
  • MonoCountStart - Valor del contador de B&W en la primera captura;
  • MonoCountEnd - Valor del contador de B&W en la última captura;
  • ColorCountStartDateOfCapture - fecha y hora de la primera captura del contador de colores, considerando la fecha inicial del periodo informado;
  • ColorCountEndDateOfCapture - fecha y hora de la última captura del contador de colores, considerando la fecha de finalización del periodo informado;
  • ColorCountStart - valor del contador de colores en la primera captura;
  • ColorCountEnd - valor del contador de colores en la última captura;
  • ScanCountStartDateOfCapture - fecha y hora de la primera captura del contador de escaneo, considerando la fecha inicial del periodo informado;
  • ScanCountEndDateOfCapture - fecha y hora de la última captura del contador de escaneo, considerando la fecha de finalización del período informado;
  • ScanCountStart - valor del contador de escaneo en la primera captura;
  • ScanCountEnd - valor del contador de escaneo en la última captura;
  • A3MonoCountStartDateOfCapture - fecha y hora de la primera captura del contador A3 B&W, considerando la fecha inicial del periodo informado;
  • A3MonoCountEndDateOfCapture - fecha y hora de la última captura del contador A3 B&W, considerando la fecha de finalización del periodo informado;
  • A3MonoCountStart - Valor del contador A3 B&N en la primera captura;
  • A3MonoCountEnd - Valor del contador A3 B&W en la última captura;
  • A3ColorCountStartDateOfCapture - fecha y hora de la primera captura del contador de colores A3, considerando la fecha inicial del periodo informado;
  • A3ColorCountEndDateOfCapture - fecha y hora de la última captura del contador de colores A3, considerando la fecha de finalización del periodo informado;
  • A3ColorCountStart - Valor del contador de colores A3 en la primera captura;
  • A3ColorCountEnd - Valor del contador de colores A3 en la última captura;
  • A3CountStartDateOfCapture - fecha y hora de la primera captura del contador A3, considerando la fecha inicial del periodo informado;
  • A3CountEndDateOfCapture - fecha y hora de la última captura del contador A3, considerando la fecha de finalización del periodo informado;
  • A3CountStart - Valor del contador A3 en la primera captura;
  • A3CountEnd - Valor del contador A3 en la última captura;

Observaciones

  • Dependiendo del rango de fechas introducido en la solicitud, es posible que en la respuesta haya más de una aparición de la misma impresora. Esto ocurre en los casos en los que se retira una impresora del cliente y se vuelve a supervisar posteriormente, en el mismo cliente. PrintWayy maneja esta situación por separado, creando dos registros distintos para cada seguimiento. De esta manera, al buscar, la misma impresora aparecerá más de una vez en la misma respuesta;
  • Debe prestar atención a las fechas que se devuelven en las respuestas a las solicitudes. Las fechas corresponden siempre a la última información de contadores recibida para la impresora buscada y, por esta razón, no siempre corresponderán al rango de fechas informado en la solicitud. Por ejemplo: al realizar una petición con rango de fechas entre el 01/10/2015 y el 15/10/2015 para una impresora concreta, y esta impresora recibió contadores por última vez el 25/09/2015, serán los contadores del día 25/09 los que se devolverán en la respuesta, siendo esa la fecha de inicio y fin que estará en la respuesta. Esta situación también puede indicar que hay un problema de control del equipo, dado que los últimos datos recibidos fueron el 25/09.

Solicitud de información de una sola imprenta, sin informar de un periodo de fechas

(En este caso, se devuelven los últimos contadores recibidos por la impresora)

Requisición:

Respuesta:

Solicitar información a una impresora que tiene más de un ticket sobre el mismo cliente en el intervalo buscado

(En este caso, se devuelven dos ocurrencias para el mismo equipo)

Requisición:

Respuesta:

Búsqueda en la que el rango de fechas es incorrecto y el código en la respuesta informa de que hay un error de fecha

Requisición:

Respuesta:

 

Para volver al menú de integración menú, haga clic aquí.

¿Le ha resultado útil este artículo?

Artículos relacionados