Uso de la documentación de la API REST de RICOH ProcessDirector

RICOH ProcessDirector proporciona las API REST para la integración de los servicios web. Se proporciona documentación interactiva con estas API y se ofrece comprobación en vivo e información para cada API disponible.

La documentación de la API REST incluye muchas API que una aplicación puede utilizar para integrarse con RICOH ProcessDirector. Puede utilizar la documentación de la API REST y la interfaz de prueba para probar la configuración de los parámetros. Cuando utiliza la interfaz para probar los servicios web, accede al servidor primario de RICOH ProcessDirector. Las acciones como crear, suprimir y habilitar objetos se ejecutan en el servidor primario y se reflejan en la interfaz de usuario de RICOH ProcessDirector. Como resultado, le recomendamos que cree objetos especialmente para hacer pruebas.

Estos pasos muestran cómo solicitar los archivos de registro para un objeto mediante API REST. Con estos pasos inicia sesión en RICOH ProcessDirector, solicita los archivos de registro para la impresora de prueba y cierra sesión.

  1. Abra un navegador web e indique el nombre de host de RICOH ProcessDirector o la dirección IP en la barra de direcciones. Añada /restapi/ al final del nombre de host o de la dirección IP para acceder a la documentación de la API REST. Por ejemplo, http://hostname:15080/restapi/
  2. En la sección de usuarios, encuentre POST /users/login.
  3. Pulse Pruébelo
  4. Inicie sesión en RICOH ProcessDirector introduciendo sus credenciales de RICOH ProcessDirector:
    • Para el parámetro name, indique su nombre de usuario de RICOH ProcessDirector.
    • Para el parámetro pwd, indique la contraseña asociada con el nombre de usuario de RICOH ProcessDirector.
  5. Haga clic en Ejecutar.
    La documentación de la API REST utiliza los valores indicados para crear un mandato Curl y una URL de solicitud. A continuación, envía la solicitud a la URL de solicitud e inicia sesión.

    RICOH ProcessDirector envía una respuesta para informarle de si ha iniciado sesión correctamente. La respuesta incorpora información adicional que incluye la señal y las acciones que puede realizar este ID de usuario.

  6. En el recuadro Cuerpo de respuesta, busque una copia del valor de la señal.

  7. En la sección de objects, desplácese hacia abajo hasta encontrar POST /objects/log/{objectType}/{name}.
  8. Pulse Pruébelo
  9. Introduzca estos parámetros para recuperar los mensajes de registro para la impresora de ejemplo:
    1. Para el parámetro token, copie la señal que copió más arriba.
    2. Para el parámetro objectType, escriba Printer.
      Los valores para objectType diferencian entre mayúsculas y minúsculas. Puede utilizar el servicio web POST /util/objecttypes para obtener una lista de los tipos de objetos disponibles en el sistema. El servicio web POST /util/objecttypes se encuentra en la sección util.
    3. Para el parámetro name, escriba Sample.
  10. Haga clic en Ejecutar.
    Las entradas de registro para la impresora de ejemplo se devuelven en el recuadro Cuerpo de respuesta.

    Los valores Curl y de URL de solicitud también se devuelven.

  11. En la sección de users, encuentre POST /users/logout/{name}.
  12. Pulse Pruébelo
  13. Cierre sesión en RICOH ProcessDirector:
    • Para el parámetro token, copie la señal que copió más arriba.
    • Para el parámetro name, indique su nombre de usuario de RICOH ProcessDirector.
  14. Haga clic en Ejecutar.
    Se cierra sesión en RICOH ProcessDirector.

  15. Algunas API incluyen valores de ejemplo. Con los valores de ejemplo puede actualizar el código de muestra y modificarlo para probarlo.

    Estos pasos muestran cómo utilizar una API REST para conectar una carpeta activa usando un valor de ejemplo. Con estos pasos inicia sesión en RICOH ProcessDirector, configura el dispositivo de entrada para aceptar archivos de HotFolderPDF y cierra sesión.

  16. Abra la interfaz de la API REST como se indica más arriba.
  17. En la sección de usuarios, encuentre POST /users/login.
  18. Pulse Pruébelo
  19. Inicie sesión en RICOH ProcessDirector introduciendo sus credenciales de RICOH ProcessDirector:
    • Para el parámetro name, indique su nombre de usuario de.
    • Para el parámetro pwd, indique la contraseña asociada con el nombre de usuario.
  20. Haga clic en Ejecutar.
  21. En el recuadro Cuerpo de respuesta, busque una copia del valor de la señal.
  22. En la sección de objects, desplácese hasta encontrar POST /objects/{objectType}/connect.
  23. Pulse Pruébelo
  24. Conecte HotFolderPDF mediante la introducción de estos parámetros:
    1. Para el parámetro token, copie la señal que copió más arriba.
    2. Para el parámetro objectType, escriba InputDevice.
      Los valores para objectType diferencian entre mayúsculas y minúsculas. Puede utilizar el servicio web POST /util/objecttypes para obtener una lista de los tipos de objetos disponibles en el sistema. El servicio web POST /util/objecttypes se encuentra en la sección util.
    3. Para el parámetro del cuerpo, pulse Editar valor. El texto de ejemplo aparece en un recuadro de código. Sustituya la palabra “string” por “HotFolderPDF”. Asegúrese de que las comillas dobles rodeen el nombre del objeto.
  25. Haga clic en Ejecutar.
    Las propiedades y los ajustes para HotFolderPDF se devuelven en el recuadro Cuerpo de respuesta. También se devuelven el código de respuesta y las cabeceras de respuesta.
  26. En la sección de users, encuentre POST /users/logout/{name}.
  27. Pulse Pruébelo
  28. Cierre sesión en RICOH ProcessDirector:
    • Para el parámetro token, copie la señal que copió más arriba.
    • Para el parámetro name, indique su nombre de usuario de RICOH ProcessDirector.
  29. Haga clic en Ejecutar.
    Se cierra sesión en RICOH ProcessDirector.

Related information:

Preparación para someter trabajos mediante servicios web
Tema principal: Uso de los servicios web