Pular para o conteúdo principal

Autenticação

Observação: Este método faz parte da API Common, exposta pelo WebService Common.

O endpoint LoginSession autentica o usuário e cria uma sessão no WebService, retornando um token de autenticação (AuthToken) para uso nas demais chamadas da API da Common.


Request HTTP Post

Tipo da RequisiçãoURL Exemplo
POST{{url_base}}/LoginSession
Exemplohttp://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"LoginSession"

Parâmetros de Entrada

ParâmetroTipoObrigatórioDescrição
LoginString(100)SimUsuário para autenticação no sistema
EncryptedPasswordStringSimSenha criptografada do usuário. Quando a autenticação via Active Directory estiver habilitada, deve ser enviada em AES‑256/CBC, usando a mesma chave do aplicativo móvel
BranchNoString(25)SimCódigo da filial onde o usuário está se autenticando

Retorno

ParâmetroTipoObrigatórioDescrição
WebServiceReturnWebServiceReturnSimInformações padrão de resposta do WebService na execução do método.
SessionInfoDataLoginSessionInfoDataSimObjeto com os dados da sessão autenticada, incluindo o token de autenticação (AuthToken)

📝 Objeto LoginSessionInfoData

O objeto LoginSessionInfoData representa as informações da sessão criada após o login.

Parâmetros de Retorno

ParâmetroTipoObrigatórioDescrição
UserCodeIntegerSimCódigo interno do usuário no sistema
UserNameStringSimNome reduzido do usuário
AuthTokenStringSimToken de autenticação gerado para a sessão. Deve ser utilizado no campo AuthToken das chamadas autenticadas.
AuthTokenExpirationDateTimeSimData/hora de expiração do token de autenticação (Após este horário, um novo login será necessário)

Exemplo de Request

curl --location 'http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"LoginSession"' \
--header 'Content-Type: application/json' \
--data '{
"Login": "edata",
"EncryptedPassword": "7012A6A2FE642116DE7BB",
"BranchNo": "0102",
"AuthType": "atMIMS"
}'

Exemplo de Response

{
"WebServiceReturn": {
"Status": "wrsSuccess",
"ErrorCode": "",
"Message": "",
"Actor": "",
"ReturnQuestion": null
},
"SessionInfoData": {
"UserCode": 12345,
"UserName": "USUÁRIO TESTE",
"AuthToken": "3F2C8A0D4B61441FAF9D0C2A6B8E9F10",
"AuthTokenExpiration": "2025-11-11T21:00:00"
}
}