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.

Principais dúvidas:

1. O campo id_number seria algum número interno nosso, como matrícula? Ou algum id específico da Gupy? R: Não é possível enviar a matrícula pois isso causará falhas em outros processos, por ex, redefinição de senha, onde a tela pede RG, induz a usuária ao erro. Também há fluxos que validam a quantidade de dígitos. Se deseja ter a matrícula, a recomendação é criar um campo personalizado no sistema.
2. Na hora de fazer integração dos cadastros com a Gupy, a gente pode subir eles todos como pessoas individuais só ou somos obrigados a fazer integração por grupo também? R: É possível subir como pessoas individuais através do endpoint Criar colaboradores
3. Podemos fazer a carga dos colaboradores assim e depois dentro da Gupy ajustar os grupos como for melhor? R: Sim, a nossa API permite. Seria via adição de um membro a um grupo. Essa adição ela acontece de forma individual.
   Também é possível fazer essa gestão via interface https://niduu.com/admin/groups/list
4. Podemos fazer a carga por grupos de diretoria e depois dentro da Gupy criar outros grupos também?
   R: Sim, é possível, também é possível fazer a criação/gestão de grupos via interface https://niduu.com/admin/groups/list
5. Mesmo quando subimos por grupos, estes colaboradores continuam sendo usuários individuais? Dentro da plataforma, eu posso buscar eles sozinhos, não estarão somente vinculados ao grupo de diretoria que fizemos. E depois dessa carga, ainda conseguimos criar mais grupos dentro da plataforma?
   R: Sim, continuam sendo usuários individuais e é possível gerir grupos dentro da plataforma através da URL https://niduu.com/admin/groups/list