Authentication.svc

Sobre

Serviço com operações relacionadas a sessão do usuário (autenticação, validação de ticket, troca de senha e logout).

Todos os serviços listados nesta página estão hospedados junto à instância do LATROMI Web. Portanto, o parâmetro {latromiUrl} presente nos Templates de URL listados abaixo, deve ser substituído pelo endereço do LATROMI Web (exemplo: http://latromi.minhaempresa.com.br/web).

Web Service REST

Códigos de Retorno (Status)

Código	Nome	Descrição
100	Sucess	Operação realizada com sucesso.
201	UserOrPasswordInvalid
202	UserNotFound
203	InactiveUser
204	InvalidToken
205	ExpiredToken
206	AccessDenied
207	SessionNotFound
208	SessionIsClosed
209	IPAddressMismatch
999	Error

Authenticate2

• Verbo Http: POST
• Template de URL: {latromiUrl}/Services/Authentication.svc/rest/authenticate2/
• Exemplo: http://samples.latromi.com.br/Auth/
• Recomendação: Https

Serviço de autenticação de usuário.

OBS: Não é recomendado o uso deste método quando o site não está usando o protocolo Https.

JSON de entrada

{  
   "username": string,
   "password": string
}

JSON de Retorno

{
    "status": 100,
    "message": "Usuário autenticado.",
    "details": null,
    "authToken": "IkXuQxepET......",
    "authType": 1,
    "userProfile": {
        "id": 1,
        "referenceCode": null,
        "username": "admin",
        "fullName": "Administrador",
        "emailAddress": "",
        "isActive": true,
        "isAdmin": true,
        "isIntegratedUser": false,
        "keepAliveEnabled": true,
        "documentType": 0,
        "documentNumber": "",
        "policies": null,
        "extendedProperties": [
            {
                "Key": "CampoLivre1",
                "Value": null
            },
            {
                "Key": "CampoLivre2",
                "Value": null
            },
            {
                "Key": "CampoLivre3",
                "Value": null
            },
            {
                "Key": "CampoLivre4",
                "Value": null
            },
            {
                "Key": "CampoLivre5",
                "Value": null
            }
        ]
    }
}

Authenticate

• Verbo Http: GET
• Template de URL: {latromiUrl}/Services/Authentication.svc/rest/authenticate/{requestToken}
• Exemplo: http://samples.latromi.com.br/AuthToken/

Serviço de autenticação de usuário. Por uma questão de segurança, é recomendado o uso deste método quando o site não está usando o protocolo HTTPS. Passar no parâmetro requestToken o token gerado pelo serviço generateAuthResquestToken.

JSON de Retorno

{
    "status": 100,
    "message": "Usuário autenticado.",
    "details": null,
    "authToken": "IkXuQxepET......",
    "authType": 1,
    "userProfile": {
        "id": 1,
        "referenceCode": null,
        "username": "admin",
        "fullName": "Administrador",
        "emailAddress": "",
        "isActive": true,
        "isAdmin": true,
        "isIntegratedUser": false,
        "keepAliveEnabled": true,
        "documentType": 0,
        "documentNumber": "",
        "policies": null,
        "extendedProperties": [
            {
                "Key": "CampoLivre1",
                "Value": null
            },
            {
                "Key": "CampoLivre2",
                "Value": null
            },
            {
                "Key": "CampoLivre3",
                "Value": null
            },
            {
                "Key": "CampoLivre4",
                "Value": null
            },
            {
                "Key": "CampoLivre5",
                "Value": null
            }
        ]
    }
}

ValidateAuthToken

• Verbo Http: GET
• Template de URL: {latromiUrl}/Services/Authentication.svc/rest/validateAuthToken/{authToken}
• Exemplo: http://samples.latromi.com.br/validatetoken

JSON de Retorno

{
    "status": 100,
    "message": "Sucesso.",
    "details": null
}

EndSession

• Verbo Http: GET
• Template de URL: {latromiUrl}/Services/Authentication.svc/rest/endSession/{authToken}

JSON de Retorno

{
    "status": 100,
    "message": "Sucesso.",
    "details": null
}

ChangePassword

• Verbo Http: GET
• Template de URL: {latromiUrl}/Services/Authentication.svc/rest/changePassword/{requestToken}
• Exemplo: http://samples.latromi.com.br/changePassword

Serviço de troca de senha do usuário. Passar no parâmetro requestToken o token gerado pelo serviço GenerateChangePasswordToken.

JSON de Retorno

{
    "status": 100,
    "message": "Sucesso.",
    "details": null
}