Os administradores podem se beneficiar do uso de servidores de autenticação externos para autenticar usuários no MyQ. Isso é útil principalmente em ambientes onde é utilizado um serviço de autenticação não suportado nativamente pelo MyQ.
A autenticação externa é usada para login no MyQ terminal embarcado e no MyQ Desktop Client. A MyQ Web User Interface e o MyQ X Mobile Client exigem credenciais definidas no MyQ.
Como funciona
É configurado um conector de API entre o MyQ e o serviço de autenticação. O MyQ solicita a autenticação por meio desse conector, e do outro lado está o próprio serviço de autenticação, onde os usuários e suas credenciais são armazenados.
O usuário tenta fazer login no Terminal Embarcado do MyQ
-
Passando um cartão de identificação
-
Digitando um PIN
A solicitação é enviada ao conector de API, contendo o tipo de método de login e o valor
O conector lida com a comunicação com o serviço de autenticação e retorna ao MyQ o usuário correspondente
Existem dois modos de operação para a Autenticação Externa. Ela pode ser a principal forma de autenticar usuários ou pode ser configurada como uma autenticação de backup, caso a autenticação no MyQ falhe. Para isso, é possível selecionar a opção “Usar somente se a autenticação no banco de dados do MyQ falhar”.
Solicitação de autenticação
Métodos de login suportados
Esta configuração define o método de login para o qual a Autenticação Externa é utilizada. O outro método de login, não selecionado, autentica o usuário com base nas credenciais no MyQ.
-
Cartão de identificação
-
PIN
O MyQ envia o tipo de método de login juntamente com o valor real do PIN/cartão de identificação, para que o conector da API possa reconhecer qual propriedade do usuário deve ser usada para localizar o usuário correto.
Por exemplo, se um cartão de identificação for selecionado e o usuário realizar a autenticação no terminal embarcado com um cartão de identificação, o MyQ envia loginType=1&loginValue=1234. Isso pode ser interpretado como o número do cartão de identificação 1234.
Se um leitor de cartão que emula teclas estiver conectado ao dispositivo e um usuário passar seu cartão, o MyQ não consegue reconhecer se o valor recebido é um PIN ou o número do cartão de identificação. O MyQ indica isso ao conector da API (loginType=7). O conector deve ser configurado para lidar com essas solicitações, por exemplo, tentando a autenticação com ambas as propriedades do usuário.
Resposta de autenticação
Identificadores de usuário suportados
O conector da API deve responder no formato JSON com um dos valores ao MyQ para associar o usuário correto e fazer seu login no cliente.
-
Número pessoal de um usuário existente no MyQ
-
Nome de usuário de um usuário existente no MyQ
Exemplos de respostas:
-
{"result":0,"personalNumber":"123456"}significa que o usuário foi identificado com sucesso pelo serviço de autenticação e que seu número pessoal é123456. O usuário com esse número pessoal no MyQ está submetido à autenticação. -
{"result":0,"username":"JohnDoe"}significa que o usuário foi identificado e que seu nome de usuário éJohnDoe. O usuário com esse nome de usuário no MyQ está submetido à autenticação.
Estados de erro
-
Usuário inválido (
{"result":1})-- o usuário foi encontrado, mas sua conta é inválida (por exemplo, desativada) -
Nenhum usuário encontrado (
{"result":2})-- não há nenhum usuário associado às credenciais
Documentação da API
Para obter detalhes de implementação, incluindo informações sobre os endpoints da API e respostas válidas, consulte a documentação da API do MyQ:
Casos de uso comuns
O conector da API Externa pode ser usado, na sua forma mais simples, para “traduzir” solicitações. Mas ele também permite fluxos de trabalho de autenticação mais avançados, já que o próprio conector pode realizar um conjunto de operações antes de retornar o usuário correspondente ao MyQ.
Exemplo 1: É necessário um serviço de autenticação não suportado pelo MyQ
Um conector que traduz as chamadas de API entre o MyQ e o serviço de autenticação remoto.
Exemplo 2: Fluxo de trabalho avançado de autenticação – múltiplas identidades
A autenticação externa pode ser usada em casos em que é necessário que alguma operação ocorra entre o MyQ e o servidor de autenticação. Isso pode incluir transformação, reconhecimento avançado de usuários em ambientes com vários domínios e muito mais.
Configuração da autenticação externa
O destino de autenticação externa pode ser ativado e configurado no MyQ, em Configurações, Autenticação de usuário.
-
URL: digite a URL onde o conector da API está em execução
-
Nome de usuário: digite o nome de usuário necessário para a conexão com o servidor externo via API
-
Senha: digite a senha necessária para a conexão com o servidor externo via API
-
Método de login: escolha o método de login do usuário — cartão de identificação ou PIN
-
Usar somente se a autenticação no banco de dados do MyQ falhar: esta opção define se a Autenticação Externa será o método primário ou secundário de autenticação
-
Se ativada, o usuário é primeiro autenticado no MyQ Print Server e, somente após a falha dessa autenticação, a próxima tentativa é feita por meio do serviço de autenticação remota
-
Se desativada, não é realizada nenhuma autenticação no MyQ Print Server; o serviço de autenticação externa é sempre utilizado
-