Como Gerenciar Usuários e Equipes

Sobre a função

As integrações desse grupo proporcionam um controle abrangente sobre os recursos relacionados aos usuários e equipes da plataforma. Essas integrações permitem a inclusão, edição e exclusão de usuários e equipes de forma eficiente. Recomendamos a criação de equipes como uma estratégia para uma melhor organização e gerenciamento das permissões dos usuários.

Veja como fazer

01.10 - Criando um Novo Usuário

Utilize essa integração para criar um novo usuário na plataforma.

XML de Envio Completo

**<main>
  <functrans="01.10">
   <dados_usuario>
    <email>[E-MAIL]</email>
    <nome>[NOME]</nome>
    <senha>[SENHA]</senha>
    <confirma_senha>[SENHA]</confirma_senha>
    <equipe codigo=[99]>[NOME_EQUIPE]</equipe>
    <documento>[DOCUMENTO]</documento>
    <idioma>[pt-br/es/en]</idioma>
    <telefone>[TELEFONE]</telefone>
    <tel_movel>[TELEFONE]</tel_movel>
    <supervisor>[S/N]</supervisor>
    <acesso_nivel_inferior>[S/N]</acesso_nivel_inferior>
  </dados_usuario>
  <seguranca>
    <restricao_ip>[S/N]</restricao_ip>
    <ip_restrito>[999.999.999.999];(...)</ip_restrito>
    <data_bloqueio>[AAAA-MM-DD]</data_bloqueio>
    <acesso_admin>[S/N]</acesso_admin>
  </seguranca>
 </func>
</main>

XML de Envio Estrutura Básica

<main>
  <functrans="01.10">
   <dados_usuario>
    <email>[E-MAIL]</email>
    <nome>[NOME]</nome>
    <senha>[SENHA]</senha>
    <confirma_senha>[SENHA]</confirma_senha>
    <equipe>[NOME_EQUIPE]</equipe>
    ...

   </dados_usuario>
 </func>
</main>

Equipe: Este campo indica a equipe à qual o novo usuário deve ser vinculado. Para obter uma lista das equipes já criadas na plataforma, consulte a integração 01.22 deste documento. O código da equipe só deve ser fornecido quando o caminho completo da equipe não for utilizado. No caso de equipes "filhas", ou seja, equipes vinculadas a uma equipe principal, é necessário especificar o "caminho" para as equipes. Ao utilizar o código da equipe, não inclua nenhum valor entre chaves; escolha apenas uma opção por vez (informe o nome da equipe com o respectivo caminho, em caso de equipes "filhas", ou utilize o código da equipe).

IP Restrito: É obrigatório fornecer os IPs separados por ponto e vírgula (;). Utilize essa opção quando desejar restringir o acesso dos usuários à plataforma. Dessa forma, o acesso não será permitido caso o usuário esteja em um número de IP diferente do informado.

Data de Bloqueio: Utilize essa opção se desejar que o usuário seja impedido de acessar a plataforma após um determinado período.

Acesso Administrativo: Essa opção concede ao usuário permissão de administrador na plataforma. Os usuários com esse tipo de acesso têm controle total sobre os recursos disponíveis na conta.
XML de retorno

<main>
 <functrans="01.10"key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
   <returnid="00">Ok</return>
 </func>
</main>

01.13 - Editar um Usuário

Utilize essa integração sempre que desejar editar qualquer campo de um usuário na plataforma. Essa alteração pode incluir informações cadastrais, como senha, equipe, documento e telefone, bem como ajustes relacionados à segurança, como restringir o acesso por IP, definir uma data para bloqueio automático do acesso ou alterar o status do usuário para administrador. Para obter mais detalhes sobre os campos disponíveis para edição, consulte a integração "01.10 - criando um novo usuário".

XML de Envio Completo

<main>
  <func trans="01.13">
    <dados_usuario>
      <email>[E-MAIL]</email>
      <nome>[NOME]</nome>
      <senha>[SENHA]</senha>
      <confirma_senha>[SENHA]</confirma_senha>
      <equipe codigo=[99]>[NOME_EQUIPE]</equipe>
      <documento>[DOCUMENTO]</documento>
      <idioma>[pt-br/es/en]</idioma>
      <telefone>[TELEFONE]</telefone>
      <tel_movel>[TELEFONE]</tel_movel>
      <supervisor>[S/N]</supervisor>
      <acesso_nivel_inferior>[S/N]</acesso_nivel_inferior>
    </dados_usuario>
    <seguranca>
      <restricao_ip>[S/N]</restricao_ip>
      <ip_restrito>[999.999.999.999];(...)</ip_restrito>
      <data_bloqueio>[AAAA-MM-DD]</data_bloqueio>
      <acesso_admin>[S/N]</acesso_admin>
    </seguranca>
  </func>
</main> 

XML de Envio Estrutura Básica

<main>
  <func trans="01.13">
    <dados_usuario>
      <email>[E-MAIL]</email>
      <nome>[NOME]</nome>
      <senha>[SENHA]</senha>
      <confirma_senha>[SENHA]</confirma_senha>
      <equipe>[NOME_EQUIPE]</equipe>

  ...
   </dados_usuario>
  </func>
</main> 

XML de retorno

<main>
  <func trans="01.13" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
    <return id="00">Ok</return>
  </func>
</main>

01.15 - Excluir um Usuário

Utilize essa integração para excluir um usuário.

XML de Envio Completo

<main>
  <func trans="01.15">
    <dados_usuario>
      <email>[E-MAIL]</email>
    </dados_usuario>
  </func>
</main>

XML de retorno

<main>
  <func trans="01.15" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
    <return id="00">Ok</return>
  </func>
</main>

01.20 - Criar uma Nova Equipe

Utilize essa integração para criar uma nova equipe na plataforma. As equipes funcionam como grupos com regras de permissões, o que facilita a administração quando há um grande número de usuários. Por exemplo, imagine que você tenha 10 usuários, todos pertencentes à equipe de marketing. Se precisar alterar uma permissão, basta modificá-la na equipe em vez de fazer a alteração individualmente em cada usuário. Isso proporciona maior eficiência e agilidade na gestão das permissões.
** XML de envio completo**

<main>
  <func trans="01.20">
    <equipe>
      <nome>[NOME_EQUIPE]</nome>
      <criar_estrutura>[TRUE]</criar_estrutura>
    </equipe>
  </func>
</main> 
<main>
  <func trans="01.15" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
    <return id="00">Ok</return>
  </func>
</main>

** XML de envio estrutura básica**

<main>
  <func trans="01.20">
    <equipe>
      <nome>[NOME_EQUIPE]</nome>
      
  ...
    </equipe>
  </func>
</main> 
<main>
  <func trans="01.15" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
    <return id="00">Ok</return>
  </func>
</main>

Nome: O valor deste campo deve seguir o formato de retorno conforme a integração "01.22 - Lista de Equipes Cadastradas", adicionando o nome da nova equipe ao final da estrutura. Por exemplo, para criar uma equipe chamada "Treinamento2" abaixo da equipe "Treinamento", o formato seria: Treinamento|Treinamento2.

Criar Estrutura: Se este campo for definido como TRUE, o sistema criará automaticamente toda a estrutura necessária para a criação da equipe.

XML de Retorno:

<main>
  <func trans="01.20" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
    <return id="00">Ok</return>
  </func>
</main>

01.22 - Lista Todas as Equipes Cadastradas

Essa integração retorna uma lista de todas as equipes presentes na plataforma.

XML de envio

<main>
  <func trans="1.22">
  </func>
</main> 

XML de retorno

<main>
  <func trans="1.05" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
    <EQUIPE CODIGO="1">Equipe 1</EQUIPE>
    <EQUIPE CODIGO="2" EQUIPE_SUPERIOR="1">Equipe 1|Equipe 1.1</EQUIPE>
    <EQUIPE CODIGO="3" EQUIPE_SUPERIOR="2">Equipe 1|Equipe 1.1|Equipe 1.1.1</EQUIPE>
    (...)
  </func>
</main>

01.23 - Edita uma equipe

Essa integração permite a edição de uma equipe na plataforma para realizar alterações. As modificações podem ser feitas no nome da equipe ou na estrutura (caminho) da mesma.
** XML de envio**

<main>
  <func trans="01.23">
    <equipe>
      <nome>[NOME_EQUIPE]</nome>
      <novo_nome>[NOVO_NOME_EQUIPE]</novo_nome>
      <criar_estrutura>[TRUE]</criar_estrutura>
    </equipe>
  </func>
</main> 

Nome: O valor deste campo deve seguir o formato de retorno conforme a integração "1.22 - Lista de Equipes Cadastradas", informando o caminho completo da equipe.

Novo Nome: O valor deste campo deve seguir o formato de retorno conforme a integração "01.22 - Lista de Equipes Cadastradas", indicando o novo nome da equipe ao final da estrutura.

Criar Estrutura: Se este campo for definido como TRUE, o sistema criará automaticamente toda a estrutura necessária para a alteração da equipe.

Exemplo:

Se tivermos uma equipe com o seguinte caminho:

Equipe1|Equipe1.1|Equipe1.1.1

E desejarmos alterar a equipe Equipe1.1.1 para:

Equipe2|Equipe2.1

Caso a equipe Equipe2 ainda não exista, o sistema irá criá-la durante o processo.
Então o XML deverá ser como o descrito abaixo:

<main>
  <func trans="01.23">
   <equipe>
    <nome>Equipe1|Equipe1.1|Equipe1.1.1</nome>
    <novo_nome>Equipe2|Equipe2.1</novo_nome>
    <criar_estrutura>TRUE</criar_estrutura>
   </equipe>
  </func>
</main>

Após a operação ser concluída com sucesso, a estrutura ficará conforme descrito abaixo:
Equipe1|Equipe1.1

Equipe2|Equipe2.1

XML de retorno

<main>
  <func trans="01.23" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
    <return id="00">Ok</return>
  </func>
</main>

1.25 - Apaga uma equipe

Utilize essa integração para excluir uma equipe.

XML de envio

<main>
  <func trans="1.25">
    <equipe>
      <nome>[NOME_EQUIPE]</nome>
    </equipe>
  </func>
</main> 

Nome: O valor desse campo deve seguir o formato de retorno conforme a integração "01.22 - Lista de Equipes Cadastradas", passando o caminho completo da equipe.

Para excluir uma equipe, não deve haver equipes ou usuários relacionados a ela. A exclusão será aplicada somente à última equipe fornecida.

Exemplo: Para excluir a equipe "Equipe1.1" do caminho descrito abaixo:

Equipe1|Equipe1.1|Equipe1.1.1

Será necessário primeiro excluir a equipe "Equipe1.1.1" e, em seguida, a equipe "Equipe1.1". Serão necessárias duas operações de integração para obter o resultado esperado.

XML de Retorno:

<main>
  <func trans="01.25" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
    <return id="00">Ok</return>
  </func>
</main>

Pontos de Atenção

1. É importante destacar que não é possível excluir um usuário que possua permissão de administrador. Antes de prosseguir com a exclusão, será necessário remover essa opção, o que pode ser feito por meio da integração "01.13 - Editar um Usuário" ou manualmente acessando a plataforma. Certifique-se de desabilitar a permissão de administrador antes de prosseguir com a exclusão do usuário.