Integração Usuário - Login Integrado

← Voltar para a tela de visualização de APIs
Descrição

Este método deve ser implementado pelo Cliente e será consumido pelo Contratanet.


Nome do método:

Login


Url do método:

https://www.SITEDOCLIENTE.com.br/CAMINHOPARAOSERVICO/Login


Utilização:

Será utilizado para integrar o login do portal de vagas, com o sistema de autenticação do cliente.
Também será utilizado para controlar o acesso do usuário ao portal e verificar a necessiade de atualizar os dados do mesmo.


Quando será chamado:

Sempre que um usuário acessar o portal de vagas, utilizando a integração com o sistema de login do cliente.


Dependência:

Este método não possui nenhuma dependência


O Contratanet enviará os seguintes parâmetros:


E espera como retorno os seguintes dados:

Parâmetros de Envio (Contratanet)
Termo Tipo do campo Nome do parâmetro Significado
Login do estudante * string userIdentifier Identificação escolhida pelo cliente para poder validar os seus usuário. Exemplo: CPF, RA + ID da Instituição, etc...
Senha do estudante * string userPassword Senha utilizada pelo usuário no sistema do Cliente
Parâmetros de Retorno (Cliente)
Termo Tipo do campo Nome do parâmetro Significado
Status da resposta de login * string loginStatusResponse Informa se o login/senha estão corretos. Possíveis respostas:
Código Descrição
Success Estudante encontrado com o login e senha utilizados
Invalid Usuário ou senha inválidos
Error Ocorreu algum erro ao processar a solicitação
Sitação do usuário* string userSituation Será utilizada para controlar o acesso dos usuários ao portal de vagas.
Possíveis situações do usuário:
Código Descrição
Active Usuário está ativo e pode usar o sistema
Inactive Usuário está inativo e não pode usar o sistema
Motivo da situação string reason Motivo do usuário estar Inactive.
Data da última atualização date lastChangeDate Deve ser informada a data da última atualização dos dados do usuário (dados pessoais, de endereço ou acadêmicos), no sistema do Cliente.
Essa informação será utilizada pelo Contratanet para saber se deve ou não chamar o método Recuperar dados do usuário e atualizar os dados no Contratanet. Para não gerar tráfego desnecessário, nos servidores do Cliente, o Contratanet só chamará o método para atualizar os dados do usuário, caso a data da última alteração seja maior do que a data da última requisição feita.
Versão utilizada string version Será enviado o código da versão da API. Este será utilizada pelo Contratanet, para manter a retrocompatibilidade, caso a API seja atualizada.
Versão atual: V1.0
Mensagens de erro string array errorList Array com todas as mensagens de erro, caso ocorram.
Carregando...