Uso de um serviço web SOAP para autenticar com um aplicativo

Os objetos do dispositivo de entrada do serviço web SOAP podem usar um serviço web SOAP para se autenticar em um aplicativo. O RICOH ProcessDirector suporta tanto chave de API quanto autenticação de sessão. Objetos de dispositivo de entrada são autenticados quando fazem varredura para entrada. Objetos de notificação são autenticados quando enviam status para o aplicativo.

Para autenticação de chave de API, coloque um código de autorização em uma propriedade Static credential ou defina um ID do usuário e uma senha HTTP. O código de autorização ou o ID do usuário e a senha HTTP são enviados para o serviço web que troca dados. Em seguida, o serviço web autentica com o aplicativo e retorna uma resposta.

Para autenticação de sessão, coloque as credenciais de autenticação (ID do usuário e senha) e outros valores em um conjunto de propriedades de solicitação de autenticação. Primeiro, o dispositivo de entrada ou a notificação chama um serviço web SOAP para autenticar com o aplicativo. Depois de uma autenticação bem-sucedida, o serviço web retorna um token. O token é transmitido na chamada para o serviço web que troca dados.

  • Se o aplicativo permitir uma sessão por usuário, configure seus objetos para chamar os serviços web com IDs do usuário e senhas diferentes.
  • A autenticação de sessão ocorre com cada chamada de serviço web e o logout não é necessário. Certifique-se de que a duração da sessão para cada conjunto de credenciais é mais curta do que o tempo entre chamadas para o serviço web. Por exemplo, a sessão para um dispositivo de entrada expira após 10 minutos. Ao configurar o dispositivo de entrada, especifique um intervalo de varredura maior que 10 minutos.

Para obter uma chave de API ou credenciais de autenticação para um aplicativo, entre em contato com a empresa que hospeda o aplicativo. Para requisitos de formato e sintaxe, consulte a documentação do aplicativo.

Para usar um serviço web SOAP para autenticação:
  1. Clique na guia Autenticação no dispositivo de entrada de serviço web SOAP ou na notificação.
  2. Siga as instruções para o tipo de autenticação que o aplicativo requer:
    • Para autenticação de chave de API, especifique o código de autenticação como o valor da propriedade Static credential.

      Deixe todas as outras propriedades em branco. Você concluiu este procedimento.

    • Para autenticação de sessão, deixe a propriedade Static credential em branco. Vá para a próxima etapa e especifique as outras propriedades.
  3. Defina a propriedade Authentication request URL para a URL que RICOH ProcessDirector usa para autenticação com o aplicativo.
    Se o aplicativo precisar de credenciais de autenticação na URL, especifique-as usando o formato e a sintaxe necessários.
  4. Para o valor da propriedade Authentication request payload, especifique o corpo da solicitação dos serviços web que o dispositivo de entrada ou notificação envia para o aplicativo para autenticação.
    Nestes exemplos, a carga inclui três elementos: <Credentials>, <Name> e <Password>. O valor do elemento <Password> é um símbolo que usa a propriedade Senha da solicitação de autenticação.

    Este exemplo usa a propriedade Authentication request password para os dispositivos de entrada:

    <Credentials> <Name>myname</Name> <Password>${WebService.AuthRequestPwd}</Password></Credentials>

    Este exemplo usa a propriedade Authentication request password para notificações:

    <Credentials> <Name>myname</Name> <Password>${WSNotification.WebService.AuthRequestPwd}</Password></Credentials>

    O símbolo é resolvido quando a solicitação de autenticação é enviada.

  5. Defina a propriedade Authentication SOAP request para a solicitação SOAP que RICOH ProcessDirector criou quando você importou o arquivo WSDL.
    Por exemplo, você deseja usar a solicitação SOAP AuthenticateUser. Você anexou PrintShop aos nomes das solicitações SOAP ao importá-las. Selecione PrintShop-AuthenticateUser.
  6. Defina a propriedade Authentication response attributepara a expressão XPath que identifica a credencial para a sessão na resposta do serviço web.
  7. Defina a propriedade Authentication request password para a senha de sua conta com o aplicativo.
    A senha é criptografada quando é armazenada em RICOH ProcessDirector.
Para a chave de API e a autenticação de sessão, RICOH ProcessDirector armazena a credencial estática ou o token retornado do aplicativo em uma propriedade.
  • Para dispositivos de entrada, a propriedade é WebService.Credential.
  • Para notificações, a propriedade é WSNotification.WebService.Credential.

Ao especificar valores na guia Solicitação para um dispositivo de entrada ou notificação de serviço web SOAP, você especifica a propriedade WebService.Credential ou WSNotification.WebService.Credential como um símbolo.

RICOH ProcessDirector substitui o valor da credencial estática ou do token para o símbolo ao transmitir o pedido para o serviço web.

Agora que você especificou os valores necessários para autenticação com o aplicativo, conclua as etapas para definir e configurar o dispositivo de entrada ou a notificação. Retorne para um dos seguintes tópicos:
  • Preparação para recuperar entrada de serviços web SOAP.
  • Preparação para enviar status para um serviço web SOAP.