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 users, pulse Expand Operations y busque GET /users/login.
  3. 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.
  4. Pulse el botón Pruébelo
    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.

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

  6. En la sección objects, pulse Expand Operations. Desplácese hacia abajo hasta encontrar GET /objects/log/{objectType}/{name}.
  7. 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.
    3. Los valores para objectType diferencian entre mayúsculas y minúsculas. Puede utilizar el servicio web GET /util/objecttypes para obtener una lista de los tipos de objetos disponibles en el sistema. El servicio web GET /util/objecttypes se encuentra en la sección util.
    4. Para el parámetro name, escriba Sample.
  8. Pulse el botón Pruébelo
    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.

  9. En la sección users, pulse Expand Operations y busque POST /users/logout/{name}.
  10. 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.
  11. Pulse el botón Pruébelo
    Se cierra sesión en RICOH ProcessDirector.

  12. Algunas API incluyen valores de ejemplo. Con los valores de ejemplo puede copiar una cadena de códigos de ejemplo en el campo del cuerpo y modificarla para probarla.

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

  13. 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/
  14. En la sección users, pulse Expand Operations y busque GET /users/login.
  15. 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.
  16. Pulse el botón Pruébelo
    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.

  17. En el recuadro Cuerpo de respuesta, busque una copia del valor de la señal.
  18. En la sección objects, pulse Expand Operations. Desplácese hacia abajo hasta encontrar POST /objects/{objectType}/connect.
  19. 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 GET /util/objecttypes para obtener una lista de los tipos de objetos disponibles en el sistema. El servicio web GET /util/objecttypes se encuentra en la sección util.
    3. Para el parámetro del cuerpo, pulse el valor de ejemplo. El texto del valor de ejemplo se copia en el parámetro del cuerpo. Sustituya la palabra “string” por “HotFolderPDF”. Asegúrese de que las comillas dobles rodeen el nombre del objeto.
  20. Pulse el botón Pruébelo
    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.
  21. En la sección users, pulse Expand Operations y busque POST /users/logout/{name}.
  22. 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.
  23. Pulse el botón Pruébelo
    Se cierra sesión en RICOH ProcessDirector.

Related information:

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