Webservice (Autenticação Usuários - Logar no sistema (validação por login e senha)): mudanças entre as edições

De Adapter
Ir para navegação Ir para pesquisar
VisualWikitexto
Sem resumo de edição
Sem resumo de edição
 
Linha 1: Linha 1:
'''Descrição:''' Obtém as notificações do cliente informado.
'''Descrição:''' Logar no sistema através de usuário e senha.


'''URL:''' https://[URL]/ws/comercial/avisos_app/cliente/{idCliente}
'''URL:''' https://[URL]/ws/auth/logar


'''Método:''' POST
'''Método:''' POST


'''Entrada:''' Pelo Path Param passar o código do cliente e JSON contendo usuário e senha
'''Entrada:''' Header: ''Token <nowiki>{{token}}</nowiki>, Authorization Basic <nowiki>{{authorization}}</nowiki>'' Body: JSON contendo os dados de usuário e senha.


'''Saída:''' JSON contendo listas de notificações para o cliente.
'''Saída:''' JSON contendo a ID do usuário ou JSON contendo mensagem de erro.


'''Campos JSON de entrada:'''
'''Campos JSON de entrada:'''
{| class="wikitable"
{| class="wikitable"
|'''Tag'''
|'''Tag'''
|'''Tipo Parâmetro'''
|'''Tipo'''
|'''Tipo'''
|'''Obrigatório'''
|'''Obrigatório'''
|'''Observação'''
|'''Observação'''
|-
|Authorization
|header
|String
|SIM
|
|-
|Token
|header
|String
|SIM
|
|-
|-
|usuario
|usuario
|body
|String
|String
|SIM
|SIM
|Esse campo faz referencia ao CPF/CNPJ vinculado ao cadastro do cliente.
|
|-
|-
|senha
|senha
|body
|String
|String
|SIM
|SIM
Linha 29: Linha 44:


* '''Envio:'''
* '''Envio:'''
** https://[URL]/ws/comercial/avisos_app/cliente/{idCliente}
** https://[URL]/ws/auth/logar
*** '''Parâmetros adicionais:'''
***'''Parâmetros adicionais:'''<syntaxhighlight lang="json" line="1">
 
{
 
  "usuario":"telco.usuario",
 
  "senha":"senha_usuario"
 
}
 
</syntaxhighlight>
 
* '''Retorno:'''
 
** '''Sucesso:'''<syntaxhighlight lang="json" line="1">
 
{
 
  "idUsuario":1,
 
  "idPerfil":1,
 
  "vendedor":true,
  "podeAprovarReprovarProspecto":true
}
</syntaxhighlight>
** '''Erro:'''<syntaxhighlight lang="json">
{
  "error":"Usuário e senha informados não pertencem a um usuário ativo no sistema."
}
</syntaxhighlight>


[[Webservice (Autenticação Usuários)|Voltar ao menu Webservice Autenticação Usuários]]
[[Webservice (Autenticação Usuários)|Voltar ao menu Webservice Autenticação Usuários]]

Edição atual tal como às 13h13min de 17 de maio de 2023

Descrição: Logar no sistema através de usuário e senha.

URL: https://[URL]/ws/auth/logar

Método: POST

Entrada: Header: Token {{token}}, Authorization Basic {{authorization}} Body: JSON contendo os dados de usuário e senha.

Saída: JSON contendo a ID do usuário ou JSON contendo mensagem de erro.

Campos JSON de entrada:

Tag Tipo Parâmetro Tipo Obrigatório Observação
Authorization header String SIM
Token header String SIM
usuario body String SIM
senha body String SIM

Exemplo:

  • Envio:
    • https://[URL]/ws/auth/logar
      • Parâmetros adicionais:
        {
   "usuario":"telco.usuario",
   "senha":"senha_usuario"
}
  • Retorno:
    • Sucesso:
      {
   "idUsuario":1,
   "idPerfil":1,
   "vendedor":true,
   "podeAprovarReprovarProspecto":true
}
    • Erro:
      {
   "error":"Usuário e senha informados não pertencem a um usuário ativo no sistema."
}

Voltar ao menu Webservice Autenticação Usuários

Disponível em “http://192.168.0.28:80/wiki/index.php?title=Webservice_(Autenticação_Usuários_-_Logar_no_sistema_(validação_por_login_e_senha))&oldid=1575”