Á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-6473


02. SITUAÇÃO/REQUISITO

Nova API para Recuperar dados de Usuários.

  • Parâmetros de Entrada, podendo ser lista:
    • Login: Login do usuário | Não Obrigatório | Lista;
    • Objectid: ID do usuário | Não Obrigatório | Lista;
    • Email: E-mail do usuário | Não Obrigatório | Lista;
    • Situacao : Ativo ou inativo | Não Obrigatório;
    • TipoDescrição: Tipo usuário ex: "Colaborador GB" | Não Obrigatório | Lista;
    • Administrador: Boleado True ou False| Não Obrigatório;
    • Integracao: Boleado True ou False | Não Obrigatório;
    • DataAlteracao: Data de alteração | Não Obrigatório;
  • Dado de retorno do Método:
    • ID: objectid do usuário (GUID 32 caracteres)
    • Nome : Nome do Usuário
    • DataAlteracao: Data de alteraçã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 "ConsultaListaUsuarioIDEA"

Como parâmetro de entrada podemos ter os parâmetros abaixo ou consultar sem parâmetros para retornar todos os Usuário

{
    "IDs": [
       "71108BA4-8B34-4256-9BC1-70CEB034237E",
        "1704DFB3-F259-4F7A-B5A7-7A4C1CAF2E3F",
        "CB8BB7BE-8E37-45FC-94C6-1BEA003EEA4B"
    ]
}

{
    "Logins": [
       "patrick@novaerasp.com.br",
        "fabianara01@e-boticario.com.br",
        "jkleyber01@e-boticario.com.br"
    ]
}

{
    "Emails": [
       "patrick@novaerasp.com.br",
        "fabianara01@e-boticario.com.br",
        "jkleyber01@e-boticario.com.br"
    ]
}

{
    "Situacao"true    
}

{
    "Administrador"true    
}

{
    "Tipos": [
        {"Codigo"1"Descricao""ColaboradorGB"}
    ]   
}

{
    "DataAlteracao""2020-01-01"    
}

-------------------------------------------------------------------------------------------------

{
    "IDs": [
       "71108BA4-8B34-4256-9BC1-70CEB034237E",
        "1704DFB3-F259-4F7A-B5A7-7A4C1CAF2E3F",
        "CB8BB7BE-8E37-45FC-94C6-1BEA003EEA4B"
    ],
    "Logins": [
       "patrick@novaerasp.com.br",
        "fabianara01@e-boticario.com.br",
        "jkleyber01@e-boticario.com.br"
    ],
    "Emails": [
       "patrick@novaerasp.com.br",
        "fabianara01@e-boticario.com.br",
        "jkleyber01@e-boticario.com.br"
    ],

    "Situacao"true ,
    "Administrador"true,
    "Tipos": [
        {"Codigo"1"Descricao""ColaboradorGB"}
    ],   
    "DataAlteracao""2020-01-01"    
}

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:

Token:


Retorno:

    {
        "ID""3a14b028-3213-4ac6-b68d-a68120cabc20",
        "Nome""Noah Henry Sebastião Oliveira",
        "DataAlteracao""2020-02-07T12:32:27"
    },
    {
        "ID""3d5b3bc2-1153-43cc-a980-109785972ad0",
        "Nome""Marcelo Roberto Severino Lima",
        "DataAlteracao""2020-02-07T12:36:04"
    }


Campo

Tipo

Informações

Exemplo de preenchimento

NomeStringNome do usuário

"Nome""Colaborador Teste"

IDGUIDObjectID do usuário no banco

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

DataAlteracaoDateTimeSe o usuário é Administrador

"DataAlteracao""2020-01-01"


04. DEMAIS INFORMAÇÕES


IMPORTANTE!

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


05. ASSUNTOS RELACIONADOS