Fluxo de integração de Usuários

A partir desse cadastro, é criado um "pré-registro", uma conta de marcação que só será ativada no momento do primeiro login no aplicativo, após a definição da senha. É possível enviar até 100 pessoas por requisição nesse endpoint.

Cadastrando usuários:

Para cadastrar um usuário temos os seguintes campos disponíveis para envio:

Início do Fluxo

1. Acesse o endpoint Cadastrar/Atualizar Usuários e preencha os dados obrigatórios: nome completo, lang (linguagem definida), nin (CPF) ou e-mail.
2. Envie o CPF ou e-mail para cadastro, pois não é possível enviar os dois juntos na requisição. Caso haja algum registro com o e-mail ou CPF, o usuário não será criado, mas sim, atualizado; Caso tenha sido cadastrado o e-mail, o link para o primeiro acesso será enviado para este endereço.
3. Passe o token de acesso no parâmetro secret e clique em “Try it!”

Exemplo de requisição:

curl --request POST \
     --url 'https://auth.api.niduu.com/integrate/users?secret=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
[
  {
    "metadata": {
      "Profissão": "Analista de Recursos Humanos"
    },
    "nin": 17221511020,
    "name": "Maria",
    "id_number": 480364217,
    "lang": "pt",
    "birth_date": "1990-01-01",
    "mobile_internet_allowed": false,
    "group": 123456
  }
]
'

Exemplo de response:

Após recebido, o lote será processado em segundo plano e a estimativa do tempo de conclusão é retornada como resposta dessa requisição.

{
  "ends_in": "2023-07-10 19:23:29",
  "ends_in_i18n": "10/07/2023 19:23"
}

🚧

Campos que não podem ser alterados

Os campos birth_date (data de nascimento) e id_number (RG), uma vez definidos para um usuário ativo, não poderão mais ser alterados.

Atualizando cadastros de usuários:

1. Recupere o id dos usuários através do endpoint Listar Usuários, é possível procurar seu id passando no parâmetro q seu nome, cpf ou e-mail;
2. Acessar o endpoint Cadastrar/Atualizar Usuários e preencha os dados obrigatórios do usuário e suas permissões na plataforma;
3. Coloque o id no parâmetro correspondente;
4. Preencha os parâmetros obrigatórios;
5. Preencha os parâmetros referentes aos campos que necessitam da alteração, lembrando que os campos birth_date e id_number não podem ser atualizados.
6. Passe o token de acesso no parâmetro secret e clique em “Try it!”

Deletando o cadastro de usuários:

1. Recupere o id dos usuários através do endpoint Listar Usuários, é possível procurar seu id passando no parâmetro q seu nome, cpf ou e-mail;
2. Coloque o id no parâmetro do endpoint Desativar Usuário.
3. Passe o token de acesso no parâmetro secret e clique em “Try it!”

🚧

Deletar x Desativar

Caso o id seja de um pré-registro (usuário ainda não criou sua conta no aplicativo) essa rota exclui o usuário.

Caso o id seja de um registro efetivado (usuário já entrou no aplicativo) essa rota desativa o usuário.