Árvore de páginas


01. DADOS GERAIS

Produto:

Bematech Loja

Linha de Produto:

Bematech Loja

Segmento:

Varejo Live

Módulo:Integrações
Função:Integração Usuários
País:Brasil
Ticket:
Requisito/Story/Issue (informe o requisito relacionado) :

DVARLIVEBT-5734


02. SITUAÇÃO/REQUISITO

Nova API para Recuperar dados de Usuários.

  • Parâmetros de Entrada:
    • Login: Login do usuário | Obrigatório;
  • Dado de retorno do Método:
    • ID: objectid do usuário (GUID 32 caracteres)
    • Nome : Nome do Usuário
    • Email: E-mail do usuário
    • Login : Login do usuário
    • Senha: Senha do usuário (Senha Criptografada)
    • Situacao :  Se o usuário está ativo ou Desabilitado
    • Tipo: tipo do cadastro. (Colaborador GB, Equipe Franquia, etc.)
    • Administrador: 1 - Sim ou 0 - não.
    • Domínios: Irá retornar os códigos dos domínios
    • Integracao : Sim ou Não. Este campo será considerado “sim” somente quando o cadastro ou atualização de dados do usuário vier via integração

Este novo método deve considerar um Token para uso (Padrão de outros métodos).
O novo método deverá possuir tratamento de LOG.

03. SOLUÇÃO

Criado API UsuarioIDEA com um método de consulta "ConsultaUsuarioIDEA"

Como parâmetro de entrada temos o UserName do usuário a ser consultado:

{
    "UserName" : "marcoy@boticario.com.br"
}

Antes de chamar a API de Consulta será necessário chamar a API de Login para obter-se um Token. Esse Token será passado no Header da chamada da API de Consulta Usuário.

O Token gerado tem duração de 3 horas, ou seja, passado esse tempo o mesmo expirará.

Exemplo de Utilização:

Exemplo de chamada via PostMan:

API de Login para obter-se o Token:

Chamada da API de Consulta Usuário:

Chamada exemplo:


Retorno Exemplo:


Campo

Tipo

ObrigatórioInformaçõesExemplo de preenchimentoObs.
IDGUID
ObjectID do usuário no banco

 "ID""b29df080-a2cf-4f02-b476-74beae7cd575"


NomeString
Nome do usuário

"Nome""Colaborador Teste"


EmailString
Email do Usuário

"Email""colaborador@empresa.com.br"


LoginString
User Name do Usuário

"Login""colaborador@empresa.com.br"


SenhaString
Senha Criptografada do usuário

"Senha""KC7BR6JEGCsjkaOTEDIn6Q||"


SituacaoBool
Se o usuário está ativo ou não

"Situacao"true


TipoString

O Tipo do Usuário:

CodigoDescrição
1ColaboradorGB
2EquipeFranquia
3ColaboradorTotvs
4Outros

"Tipo""ColaboradorGB"


AdministradorBool
Se o usuário é Administrador

"Administrador"true


IntegracaoBool
Se o cadastro do usuário veio por integração

"Integracao"true


DomíniosDominio
Domínios que esse usuário está vinculado

"Dominios": [
        {
            "Codigo""990010707",
            "Nome""CENTRAL 990010707"
        },
        {
            "Codigo""9006882",
            "Nome""LOJA 9006882"
        }]






04. DEMAIS INFORMAÇÕES


IMPORTANTE!

Use esse box para destacar informações relevantes e/ou de destaque.


05. ASSUNTOS RELACIONADOS