Necessário para iniciar a sessão da API do serviço Web do VSA. A ID da sessão retornada precisa ser submetida com cada método chamado durante a sessão. A ID da sessão somente é válida quando recebida da mesma máquina da qual a autenticação se origina.
Um registro único dos seguintes campos é retornado.
SessionID |
decimal |
A ID única da sessão atribuída para um conexão de usuário com o URL de destino. |
Method |
string |
A operação que solicitou essa resposta. |
TransactionID |
decimal |
A ID única de mensagem para essa mensagem. |
ErrorMessage |
string |
Se estiver em branco, nenhum erro foi retornado. Possíveis mensagens de erro retornadas incluem:
|
ErrorLocation |
string |
Se estiver em branco, nenhum erro foi retornado. |
Login automático durante a autenticação
Quando você autentica através da API, será também automaticamente conectado ao VSA. Se você já estiver conectado ao VSA no momento da autenticação, as duas sessões serão sincronizadas. Seja a forma, o resultado é o mesmo - você termina tendo sessões válidas em ambos os mundos.
O VSA procurará a SessionID de 26 dígitos da API na sequência de consulta de cada página do VSA. Se o aplicativo for redirecionado para uma página VSA, a página será exibida sem forçar o usuário a se conectar novamente. A sintaxe é:
URL?apiLogonGuid=12345678901234567890123456
Por exemplo:
http://someServer:123/Systemtab/SomePage?apiLogonGuid=12345678901234567890123456&SomeVar=SomeValue
A atividade da API mantém a sessão do VSA ativa. No entanto, como o VSA não pressupõe que sempre é necessária uma API de sessão, a atividade do VSA não mantém a sessão de API ativa.
A API usa o mesmo valor de tempo limite que o VSA, que é mantido usando a página Sistema > Política de logon do VSA, e tem um valor padrão do sistema de 30 minutos.
Algoritmo de hash
Com a versão 6.2, o K2 adotou o algoritmo de hash SHA-256 para autenticações seguras. Anteriormente, o padrão era SHA-1. Consulte o tópico Como alterar senhas usadas por aplicativos externos da ajuda on-line do Sistema para obter uma descrição geral desse aperfeiçoamento.
HashingAlgorithm
em Autenticar terá como padrão SHA-1
, se deixado em branco.Aviso: Alterar uma senha usada por um aplicativo externo herdado desativará a integração até que o aplicativo externo seja atualizado para usar o algoritmo de hash SHA-256 necessário, ou até que uma nova credencial SHA-1 seja criada e implementada. Certifique-se de que senhas usadas por aplicativos externos não sejam alteradas até que a atualização seja implementada. Consulte Como criar uma nova credencial SHA-1 para um aplicativo externo herdado a seguir.
Práticas recomendadas
Para garantir uma migração tranquila de versões anteriores a esta versão, a Kaseya recomenda que o código cliente da API de serviços da Web seja escrito ou modificado para tentar a autenticação usando primeiro SHA-256 e então SHA-1, sucessivamente. Isso garantirá que o código cliente seja compatível com senhas criadas em versões atuais e anteriores do VSA.
HashingAlgorithm
na solicitação Autenticar como SHA-256
. Certifique-se de que o hash é aplicado à senha usando SHA-256. Emita a solicitação Autenticar. Verifique para confirmar se uma ID de sessão válida foi retornada.SessionID
retornar um valor que não seja zero e o parâmetro ErrorMessage
estiver em branco.SessionID
retornar um valor zero. Realize a etapa 2.HashingAlgorithm
como SHA-1
. Aplique novamente o hash ao valor de senha usando SHA-1. Emita de novo a solicitação Autenticar. Verifique para confirmar se uma ID de sessão válida foi retornada.Como criar uma nova credencial SHA-1 para um aplicativo externo herdado
Se você estiver executando o VSA 6.2 ou versão posterior e precisar criar um nome de usuário e senha SHA-1 que sejam compatíveis com um aplicativo externo herdado e ele ainda não tiver sido atualizado para ser compatível com senhas da versão 6.2, use um dos procedimentos a seguir. É possível criar um novo usuário mestre e senha ou redefinir apenas a senha de um usuário mestre existente.
Nota: É necessário ter privilégios de administrador no servidor da Kaseya. Por motivos de segurança, não é possível executar os procedimentos a seguir remotamente.
Criar uma nova conta de usuário mestre
http://localhost/localAuth/setAccountV61.asp
O aplicativo externo agora pode ser atualizado para usar a nova conta de usuário e senha SHA-1 para conexão com o VSA.
Redefinir a senha de uma conta de usuário mestre existente
Nota: A conta de usuário mestre não pode ser desativada.
http://localhost/localAuth/setAccountV61.asp
O aplicativo externo agora pode ser atualizado para usar a nova senha SHA-1 para conexão com o VSA.