Skip to main content

Visão Geral

O cadastro de pessoas no FreedomNEO é separado em 4 etapas:

Observação:

Este documento irá detalhar cada etapa para realizar o cadastro completo de uma pessoa.

1) Dados Pessoais​

Os dados pessoais englobam a identificação da pessoa, seus documentos, endereços e contatos.

Uma pessoa pode ter múltiplos documentos, endereços e contatos.

1.1) Identificação​

São as informações básicas que identificam uma pessoa.

É necessário informar:

  • Tipo Pessoa
    • Física | Jurídica
  • Tipo Documento (deverá ser feito um GET em /tipodocumento para obter os tipos de documentos)
  • Identificador/Nº do Documento (É possível utilizar o método POST no endpoint /pessoadocumento/consulta para preencher automaticamente o nome e a data de nascimento da pessoa quando o documento for do tipo CPF)
  • Nome completo ou razão social
  • Nome social ou apelido
  • Data de Nascimento
  • Foto da Pessoa
  • Foto do Documento
  • Usuário Cadastro (invisível para o usuário)
Observação:

A partir de agora será necessário passar a sequência da pessoa para a maioria dos endpoints.

  • Para isso faça um
    GET
    no endpoint /pessoa para obter a sequência.
GET
/pessoa

1.2) Documentos​

São os documentos adicionais da pessoa.

É necessário informar:

  • Tipo Documento (deverá ser feito um GET em /tipodocumento para obter os tipos de documentos)
  • Identificador/Nº do Documento
  • Imagem/Foto do Documento
  • RG Emissão (somente se o documento for RG)
  • RG Expedidor (somente se o documento for RG)
  • CNH Validade (somente se o documento for CNH)
  • Documento Favorito (Sim ou Não)
  • Sequência da Pessoa

1.3) Endereços​

São todos os endereços que a pessoa possui.

É necessário informar:

  • Tipo Endereço (deverá ser feito um GET em /tipoendereco para obter os tipos de endereço)
  • País (existe um endpoint /pais para obter todos os países)
  • Estado (existe um endpoint /estado para obter todos os estados)
  • CEP
  • Endereço
  • Número
  • Complemento
  • Bairro
  • Cidade (existe um endpoint /cidade para obter as cidades de acordo com o estado)
  • Endereço Favorito (Sim ou Não)
  • Sequência da Pessoa

1.4) Contatos​

Os contatos são os meios de comunicação que a pessoa possui.

É necessário informar:

  • Tipo Contato (deverá ser feito um GET em /tipocontato para obter os tipos de contato)
  • Contato (Número de telefone, e-mail ou link)
  • Falar com (Somente se o tipo for telefone)
  • Ramal (Somente se o tipo for telefone)
  • Contato Privado (Sim ou Não)
  • Contato Favorito (Sim ou Não)
  • Sequência da Pessoa

2) Vínculos​

Antes de cadastrar um vínculo é necessário consultar os destinos e as classificações disponíveis.

2.1) Destinos​

GET
/destino

A API irá retornar todos os destinos/unidades que estão cadastradas no sistema.

2.2) Classificações​

GET
/classificacao
?necessitavinculo=true

A API irá retornar todas as classificações que necessitam de vínculo.

2.3) Vínculo​

POST
/pessoavinculo

Os vínculos são as relações que a pessoa possui com um destino/unidade.

É necessário informar:

  • Sequência da Pessoa
  • Sequência do Destino/Unidade
  • Sequência da Classificação (É necessário passar o parâmetro necessitavinculo como true)
  • Proprietário (Sim ou Não)
  • Locatário (Sim ou Não)
  • Titular (Sim ou Não)
  • Morador (Sim ou Não)
  • Responsável (Sim ou Não)
  • Permite Autorização (Sim ou Não)
  • Permite Liberação (Sim ou Não)

3) Autorizações​

Antes de cadastrar uma autorização é necessário consultar os destinos, os responsáveis pelo destino, as classificações e os templates de políticas de acesso disponíveis.

3.1) Destinos​

GET
/destino

A API irá retornar todos os destinos/unidades que estão cadastradas no sistema.

3.2) Responsável pelo Destino​

GET
/destino/responsavel?seqdestino=SEQ&notinseqpessoa=SEQ&permitestatus=autorizacao

A API irá retornar apenas as pessoas responsáveis pelo destino/unidade selecionada.

3.3) Classificações​

GET
/classificacao
?necessitavinculo=false

A API irá retornar todas as classificações que podem ser utilizadas para autorização.

3.4) Políticas de Acesso​

GET
/politicaacessotemplate

A API irá retornar todos os templates de políticas de acesso que podem ser utilizadas para autorização.

3.5) Autorização​

POST
/autorizacao

As autorizações são as permissões que a pessoa possui para acessar um destino/unidade.

É necessário informar:

  • Sequência da Pessoa
  • Sequência da Classificação (É necessário passar o parâmetro necessitavinculo como false)
  • Sequência do Destino/Unidade
  • Sequência do Autorizador/Responsável (deverá ser feito um GET em /destino/responsavel passando os parâmetros seqdestino = DESTINO SELECIONADO,notinseqpessoa = SEQUENCIA DA PESSOA e permitestatus=autorizacao para obter apenas as pessoas responsáveis pelo destino/unidade selecionada)
  • Lista (Tipos de Autorização)
    • 0 - Permanente
    • 1 - Por Período
      • Data/Hora Início Vigência
      • Data/Hora Fim Vigência
      • Política de Acesso
        • Personalizar (Sim ou não)
          • Dia da semana (segunda, terca, quarta, quinta, sexta, sabado, domingo)
            • Hora Início
            • Hora Fim
  • Permite autorização (Sim ou não)
  • Permite liberação (Sim ou não)
  • Empresa (deverá ser informado se a classificação retornar dadosempresa = true)
  • Função (deverá ser informado se a classificação retornar dadosempresa = true)
  • Usuário Cadastro (invisível para o usuário)
  • Sequência Porteiro (invisível para o usuário)
TIPOS DE AUTORIZAÇÃO

0 - PERMANENTE: para autorizações com prazo indeterminado. A pessoa terá acesso a qualquer dia e horário a partir do momento da autorização, até que a autorização seja cancelada.

1 - POR PERÍODO: para autorizações com prazo determinado, com possibilidade de grade de horários personalizada.

O sistema considera como prioritário as datas e horas do período de vigência, depois a grade de horários personalizada.

4) Formas de Acesso​

As formas de acesso são meios de identificação da pessoa para acessar o sistema.

4.1) Foto Facial​

POST
/pessoaacesso/foto

A foto facial é a imagem que será utilizada para reconhecimento facial no acesso da pessoa.

É necessário informar:

  • Foto
  • Sequência da Pessoa
Recomendações para envio de foto
  • Deve-se estar sempre sob boa iluminação, sem sombras atrás ou no rosto.
  • É necessário retirar óculos, chapéus, bonés, brincos ou outros adereços.
  • Deve-se manter a expressão facial natural, com os lábios fechados e os olhos abertos.
  • É importante posicionar-se de frente, com o rosto em primeiro plano e ocupando o máximo possível da foto.
  • O fundo deve ser neutro e claro, sem objetos ou outras pessoas.

4.2) Cartão de Proximidade​

O cartão de proximidade (RFID) é uma forma de acesso para liberar a passagem da pessoa.

É necessário informar:

  • Nº do Cartão/ID Acesso
    • É o código impresso em "S" no cartão de proximidade
    • Caracteres aceitos: 0-9, A-F
  • Sequência do Tipo de ID Acesso (deverá ser feito um GET em /tipoacessoid para obter os tipos de ID Acesso)
  • Sequência da Pessoa
  • Usuário Operação (invisível para o usuário)

4.3) Tag Veicular​

O tag veicular é uma forma de acesso através de um adesivo colado no veículo.

É necessário informar:

  • Nº do Tag/ID Acesso
    • É o código localizado abaixo do logotipo da Safebras
  • Sequência do Tipo de ID Acesso (deverá ser feito um GET em /tipoacessoid para obter os tipos de ID Acesso)
  • Sequência do Veículo (deverá ser feito um GET em /veiculo para obter os veículos)
  • Sequência da Pessoa
  • Usuário Operação (invisível para o usuário)