Prueba de la API de exportación de datos

Siga este procedimiento para obtener una breve introducción a la API, utilizando la página de documentación interactiva como guía.

Antes de comenzar con esta tarea, cree una clave API a través de RICOH Account Administration.

Este procedimiento le guiará a lo largo de:

  1. Autenticación de la página de documentación interactiva
  2. Obtener la lista de identificadores de las impresoras de su cuenta
  3. Obtener el estado de una o varias impresoras
  4. Solicitar información sobre los trabajos relacionados con una o varias de esas impresoras

Para utilizar la API de exportación de datos:

  1. Acceda aquí a la documentación interactiva de la API de exportación de datos:
  2. Autentíquese mediante una clave API:
    1. Haga clic en Autorizar, situado en la parte derecha de la página.
    2. En el cuadro de diálogo Autorizaciones disponibles, introduzca su clave API en el campo Valor.
      Cuadro de diálogo Autorizaciones disponibles
    1. Haga clic en Autorizar para autenticarse.
    2. Haga clic en Cerrar.
    Ya puede probar las funciones de la API disponibles. Utilice esta interfaz para familiarizarse con la sintaxis antes de integrar la API en sus aplicaciones.
  3. Obtenga la lista de identificadores de las impresoras definidas en su cuenta.
    Para obtener información sobre el estado de los trabajos y de las impresoras, debe incluir los valores de identificación de las impresoras en sus solicitudes a la API. Los identificadores de impresora no cambian. Si los recupera ahora y guarda los valores, podrá utilizar los ID en otras llamadas a la API.
    1. Abra la sección Impresoras y, a continuación, abra el punto final GET /printers.
      Como puede ver, este punto final no requiere ningún parámetro.
    2. Haga clic en Probarlo y, a continuación, en Ejecutar.
    3. Revise el cuerpo de la respuesta. Podrá ver una lista con información detallada sobre las impresoras supervisadas por RICOH Predictive Insight. La respuesta tiene un aspecto similar a este:
      [
  {
    "printerName": "VC80_2",
    "printerId": "0bc6b7b3-8df9-4293-cdd4-5ae3162c4d4c",
    "engines": 2,
    "manufacturer": "Ricoh",
    "model": "RICOH Pro VC80000",
    "printerMode": "duplex",
    "printerType": "continuous_feed",
    "serialNumber": "Printer 1: 10-11111 and Printer 2: 10-11112",
    "connectionStatus": "not_connected"
  },
  {
    "printerName": "IP 5000",
    "printerId": "0f8726da-8q37-9c3l-8710-065d7c265122",
    "engines": 1,
    "manufacturer": "InfoPrint",
    "model": "InfoPrint 5000 GP v3.17.129",
    "printerMode": "simplex",
    "printerType": "continuous_feed",
    "serialNumber": "10-1111111",
    "connectionStatus": "connected"
  }
]

      Anote los valores de los parámetros printerId de cada una de sus impresoras.

  4. Solicite el historial de estado de una o varias impresoras de su sistema.
    1. Abra el punto final GET /printer-states.
    2. Haga clic en Probar.
    3. Junto a printerId, haga clic en Añadir elemento de cadena.
    4. Sustituya el texto del campo por uno de los valores de ID de impresora que haya obtenido en el paso .
      Para recuperar el historial de estado de otras impresoras, haga clic de nuevo en Añadir elemento de cadena y añada otro valor de ID de impresora.
    5. En cuanto a la zona horaria, seleccione la zona horaria que desea utilizar para los datos.
    6. Especifique las horas de inicio y fin del intervalo de tiempo sobre el que se va a elaborar el informe. Deje estos campos en blanco para recuperar los datos de las últimas 24 horas.
    7. Deje los tres últimos valores con los valores predeterminados, para que pueda ver la lista completa de la información que puede devolver la API.
    8. Pulse Ejecutar.
    9. Revise el cuerpo de la respuesta. Aparecerá una lista con los datos del estado de cada motor de impresora, con una entrada por cada cambio de estado de la impresora.
    10. Modifique los valores de los parámetros currentState, stateCategoryOnly y stateCategory y vuelva a hacer clic en Ejecutar para comprobar cómo cambia la respuesta.
      • Dejar estos parámetros con los valores predeterminados (sin configurar) tiene el mismo efecto que establecerlos en falso.
      • Puede utilizarlos por separado o combinándolos entre sí.
  5. Solicite información sobre los trabajos relacionados con una o varias de esas impresoras:
    1. Acceda a la sección Trabajos de la página.
    2. Abra el punto final GET /jobs.
    3. Haga clic en Probar.
    4. Junto a printerId, haga clic en Añadir elemento de cadena.
    5. Sustituya el texto del campo por uno de los valores de ID de impresora que haya obtenido en el paso .
      Para obtener información de trabajos de otras impresoras, haga clic de nuevo en Añadir elemento de cadena y añada otro valor de ID de impresora.
    6. En cuanto a la zona horaria, seleccione la zona horaria que desea utilizar para los datos.
    7. Especifique las horas de inicio y fin del intervalo de tiempo sobre el que se va a elaborar el informe. Deje estos campos en blanco para recuperar los datos de las últimas 24 horas.
    8. En el campo jobState, deje el valor en blanco para ver todas las respuestas que puede devolver la API.
    9. Pulse Ejecutar.
    10. Revise la respuesta para ver la información de trabajos que se ha devuelto.
    11. Modifique el valor de jobState y vuelva a hacer clic en Ejecutar para comprobar cómo cambia la respuesta.
Tema principal: Cómo trabajar con la API de exportación de datos