Uso de um serviço web REST para autenticar com um 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 objeto transmite o código de autorização ou o ID do usuário e a senha HTTP 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 REST para autenticar com o aplicativo. Depois de uma autenticação bem-sucedida, o serviço web retorna um token. O dispositivo de entrada ou notificação transmite, então, o token na chamada para o serviço web, que troca dados.
- Se o aplicativo permitir uma sessão por usuário, configure seus dispositivos de entrada e notificações 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.
- Clique na guia Autenticação no dispositivo de entrada de serviço web REST ou na notificação.
- 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.
- Para autenticação de chave de API, especifique o código de autenticação como o valor
da propriedade Static credential.
- Defina a propriedade Authentication request URL para a URL que RICOH ProcessDirector usa para autenticação com o aplicativo.
- Especifique as credenciais de autenticação inserindo valores exigidos pelo aplicativo
em uma ou mais destas propriedades: Authentication request payload, Authentication request header e Authentication request parameters.
- Para o valor da propriedade Carga da solicitação, especifique o corpo (se houver) da solicitação de autorização que o dispositivo de
entrada enviou ao aplicativo.
Nestes exemplos, a carga inclui três elementos XML: <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 dispositivo de entrada ou notificação resolve o símbolo quando envia a solicitação de autenticação.
- Defina os valores para as propriedades Cabeçalho da solicitação e Parâmetros da solicitação conforme necessário.
Cada campo de cabeçalho ou parâmetro é um par palavra-chave/valor. Cada par deve aparecer em uma linha separada e deve ser separado usando sinais de dois pontos (:) ou de igual (=).
A palavra-chave e o valor podem ser várias palavras. RICOH ProcessDirector usa o primeiro sinal de dois pontos ou de igual em cada linha para dividir as palavras em par palavra-chave/valor.
Estes exemplos contêm dois parâmetros: name e pwd. O valor da palavra-chave pwd é 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:
name:mynamepwd:${WebService.AuthRequestPwd}
Este exemplo usa a propriedade Authentication request password para notificações:
name:mynamepwd:${WSNotification.WebService.AuthRequestPwd}
O símbolo é resolvido quando a solicitação de autenticação é enviada.
- Para o valor da propriedade Carga da solicitação, especifique o corpo (se houver) da solicitação de autorização que o dispositivo de
entrada enviou ao aplicativo.
- Defina as propriedades Request method e Request content type para os valores exigidos pelo serviço web.
- Defina a propriedade Authentication response attributepara a expressão XPath que identifica a credencial para a sessão na resposta do serviço web.
- Defina a propriedade Authentication request password para a senha de sua conta com o aplicativo.A senha é criptografada quando é armazenada em RICOH ProcessDirector.
- 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, 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 um serviço web.
- Preparação para recuperar entrada de serviços web REST.
- Preparação para enviar status para um serviço web REST.