Uso de los servicios web
Preparación de RICOH ProcessDirector para recibir solicitudes de servicio web
Para poder someter solicitudes de servicios web, debe crear un usuario de RICOH ProcessDirector y una contraseña para usar los servicios web. Asegúrese de que el ID de usuario tenga el nivel de autoridad adecuado en RICOH ProcessDirector para realizar las acciones que se proporcionan en el servicio web. Para los ejemplos de este capítulo, es suficiente con la autoridad Operador. Si utiliza el protocolo ligero de acceso a directorios (LDAP) para la autenticación, cree un usuario en LDAP para usar los servicios web. El usuario LDAP debe pertenecer a un grupo con el nivel de autoridad adecuado en RICOH ProcessDirector.
Como todos los usuarios deben cambiar sus contraseñas la primera vez que inician sesión, inicie sesión en la interfaz de usuario de RICOH ProcessDirector mediante el ID de usuario que acaba de crear y cambie la contraseña. Si tiene contraseñas configuradas para caducar después de un determinado periodo de tiempo, debe iniciar sesión y cambiar la contraseña según sea necesario.
Preparación de las solicitudes de servicio web
Cuando cree solicitudes, tenga en cuenta lo siguiente:
- El usuario de los servicios web debe iniciar sesión antes de realizar ninguna acción.
Para someter solicitudes de servicio web, primero debe usar el servicio web GET /users/login para iniciar sesión en RICOH ProcessDirector como usuario del servicio web y recibir una señal de credenciales. Esa señal debe estar incluida en la cabecera de todas las solicitudes de servicio web que someta hasta que someta el servicio web POST /users/logout/{name}.
- Los nombres de propiedad se deben expresar en el formato de la base de datos, no en
el formato de interfaz de usuario.
Cuando incluya un nombre de propiedad en una solicitud, debe usar el nombre de propiedad de base de datos. Por ejemplo, si desea usar GET /objects/{objectType} para recuperar el valor Clase de un trabajo, inserte Job.Class como valor de attribute en la solicitud. Los nombres de propiedad de la base de datos están disponibles en la ayuda de campo de cada propiedad, en el sistema de ayuda del producto, en los resultados recibidos de algunos servicios web y en Nombres de propiedad de base de datos.
- Los valores de propiedad se deben expresar en el formato de la base de datos, no en
el formato de interfaz de usuario.
Cuando incluya un valor de propiedad en una consulta, debe asegurarse de que es un valor válido. En la mayoría de los casos, los campos numéricos requieren valores numéricos y los campos de texto requieren valores de texto. Sin embargo, algunas propiedades tienen limitadas las listas de valores.
Cualquier propiedad que proporcione una lista desplegable sólo puede aceptar ciertos valores. Además, los valores que aparecen en estas listas no son siempre los mismos que están almacenados en la base de datos. Por ejemplo, en la interfaz de usuario, los valores de la propiedad Grapado incluyen:
- 2 a la izquierda
- 2 a la derecha
- Parte superior izquierda
- Parte superior izquierda vertical
- Parte inferior izquierda
- 2_at_left
- 2_at_right
- Top_left
- Top_left_vertical
- Bottom_left
En las solicitudes de servicio web, debe usar el valor de la base de datos. Los valores de la base de datos de las propiedades están disponibles en el sistema de ayuda y en Nombres de propiedad de base de datos.
-
Las propiedades de trabajo posicionales deben incluir la fase, el paso y los nombres del flujo de trabajo en ese orden tras el nombre de la propiedad. Encierre cada uno de los tres nombres entre corchetes.
Esta serie JSON de ejemplo especifica un archivo de control en un sistema Linux como el valor de la propiedad de trabajo Identificar archivo de control PDF (nombre de la base de datos Job.IdentifyPDFControlFile):
"Job.IdentifyPDFControlFile[Prepare][IdentifyPDFDocuments][PullPDFSample]":"/aiw/aiw1/testfiles/PullPDF.ctl"
La propiedad de trabajo está en el paso IdentifyPDFDocuments de la fase Prepare del flujo de trabajo PullPDFSample.