Uso de un servicio web REST para autenticar con una aplicación
Para la autenticación de la clave de API, coloque un código de autorización en una propiedad Credencial estática o defina un ID de usuario HTTP y una contraseña. El dispositivo de entrada o la notificación pasa el código de autorización o el ID de usuario HTTP y la contraseña al servicio web que intercambia datos. El servicio web, a continuación, se autentica en la aplicación y devuelve una respuesta.
Para autenticar la sesión, coloque las credenciales de autenticación (ID de usuario y contraseña) y otros valores en un conjunto de propiedades de la solicitud de autenticación. El dispositivo de entrada o la notificación primero llaman a un servicio web REST para autenticarse con la aplicación. Tras autenticarse correctamente, el servicio web devuelve una señal al dispositivo de entrada o a la notificación. A continuación, el dispositivo de entrada o la notificación transmite la señal de la llamada al servicio web que intercambia datos.
- Si la aplicación permite una sesión por usuario, configure los dispositivos de entrada y las notificaciones para llamar a los servicios web con distintos ID de usuario y distintas contraseñas.
- Con cada llamada del servicio web se realiza la autenticación de la sesión y no es necesario cerrar la sesión. Asegúrese de que la duración de la sesión para cada conjunto de credenciales es inferior al tiempo entre llamadas al servicio web. Por ejemplo, la sesión para un dispositivo de entrada caduca transcurridos 10 minutos. Cuando configure el dispositivo de entrada, especifique un intervalo de sondeo superior a 10 minutos.
Para obtener una clave de API o credenciales de autenticación para una aplicación, póngase en contacto con la empresa que aloja la aplicación. Para conocer los requisitos de formato y de sintaxis, consulte la documentación de la aplicación.
- Pulse la pestaña Autenticación en el dispositivo de entrada del servicio web REST o en la notificación.
- Siga las instrucciones para el tipo de autenticación que la aplicación requiere:
- Para la autenticación de la clave de API, especifique el código de autenticación como
el valor de la propiedad Credencial estática.
Deje el resto de propiedades en blanco. Ha completado este procedimiento.
- Para autenticar la sesión, deje la propiedad Credencial estática en blanco. Vaya al paso siguiente y especifique las otras propiedades.
- Para la autenticación de la clave de API, especifique el código de autenticación como
el valor de la propiedad Credencial estática.
- Establezca la propiedad URL de la solicitud de autenticación en la URL que RICOH ProcessDirector utiliza para autenticarse con la aplicación.
- Especifique las credenciales de autenticación introduciendo los valores requeridos
por la aplicación en una o más de las propiedades siguientes: Carga de solicitud de autenticación, Cabecera de la solicitud de autenticación y Parámetros de la solicitud de autenticación.
- Para el valor de la propiedad Carga de solicitud, especifique el cuerpo (si existe) de la solicitud de autorización que el dispositivo
de entrada o la notificación someten a la aplicación.
En estos ejemplos, la carga incluye tres elementos XML: <Credenciales>, <Nombre> y <Contraseña>. El valor del elemento <Contraseña> es un símbolo que utiliza la propiedad Contraseña de la solicitud de autenticación.
En este ejemplo se utiliza la propiedad Contraseña de la solicitud de autenticación para dispositivos de entrada:
<Credentials> <Name>myname</Name> <Password>${WebService.AuthRequestPwd}</Password> </Credentials>
En este ejemplo se utiliza la propiedad Contraseña de la solicitud de autenticación para notificaciones:
<Credentials> <Name>myname</Name> <Password>${WSNotification.WebService.AuthRequestPwd}</Password> </Credentials>
El dispositivo de entrada o la notificación resuelven el símbolo cuando envían la solicitud de autenticación.
- Establezca los valores para las propiedades Cabecera de la solicitud y Parámetros de solicitud, según sea necesario.
Cada campo o parámetro de cabecera es un par palabra clave/valor. Cada par debe aparecer en una línea independiente y debe separarse utilizando dos puntos (:) o un signo igual (=).
La palabra clave y el valor pueden ser varias palabras. RICOH ProcessDirector utiliza el primer signo de dos puntos o de igual de cada línea para dividir las palabras en el par palabra clave/valor.
Estos ejemplos contienen dos parámetros: nombre y contraseña. El valor de la palabra clave contraseña es un símbolo que utiliza la propiedad Contraseña de la solicitud de autenticación.
En este ejemplo se utiliza la propiedad Contraseña de la solicitud de autenticación para dispositivos de entrada:
name:myname pwd:${WebService.AuthRequestPwd}
En este ejemplo se utiliza la propiedad Contraseña de la solicitud de autenticación para notificaciones:
name:myname pwd:${WSNotification.WebService.AuthRequestPwd}
El dispositivo de entrada o la notificación resuelven el símbolo cuando envían la solicitud de autenticación.
- Para el valor de la propiedad Carga de solicitud, especifique el cuerpo (si existe) de la solicitud de autorización que el dispositivo
de entrada o la notificación someten a la aplicación.
- Establezca las propiedades Método de la solicitud y Tipo de contenido de la solicitud en los valores requeridos por el servicio web.
- Establezca la propiedad Atributo de repuesta de autenticación en la expresión XPath que identifica la credencial para la sesión en la respuesta del servicio web.
- Establezca la propiedad Contraseña de la solicitud de autenticación en la contraseña de su cuenta para la aplicación.La contraseña se cifra cuando se almacena en RICOH ProcessDirector.
- Para dispositivos de entrada, la propiedad es WebService.Credential.
- Para notificaciones, la propiedad es WSNotification.WebService.Credential.
Al especificar valores en la pestaña Solicitud para un dispositivo de entrada de un servicio web o una notificación, especifique la propiedad WebService.Credential o WSNotification.WebService.Credential como un símbolo.
RICOH ProcessDirector sustituye el valor de la credencial estática o la señal para el símbolo cuando transmite la solicitud a un servicio web.
- Preparación para recuperar la entrada de servicios web REST.
- Preparación para enviar el estado a un servicio web REST.