Carregando...

Controle de Usuários e Equipes

Controle de Usuários e Equipes

As integrações desse grupo permitem o controle de recursos relacionados aos usuários e equipes da plataforma.  É  possível incluir, editar e excluir usuários ou equipes. Recomendamos a criação de equipes para organizar e gerenciar melhor as permissões dos usuários.

 

01.10 - Criando um Novo Usuário

 

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

XML de Envio:

<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>
*Itens em negrito são obrigatórios

Equipe - Esse campo informa a qual equipe o novo usuário deve ser atrelado. Utilize a integração 01.22 desse documento para ter uma lista das equipes já criadas na plataforma. O código da equipe só deverá ser passado quando não for utilizar o caminho completo da equipe (é possível ter equipes "filhas", ou seja, ter uma principal e outras vinculadas, então nesse cenário teríamos um "caminho" para as equipes). Ao utilizá-lo não se deve passar valor algum entre as chaves equipe, ou seja, pode-se utilizar apenas uma opção por vez (informe o nome da equipe com o seu devido caminho, em caso de equipes "filhas", ou o código da equipe).

IP Restrito - Deve-se obrigatoriamente passar os ip’s separados por ';' (ponto e vírgula). Essa opção deve ser utilizada quando desejar restringir o acesso dos usuários a plataforma. Assim o acesso não será feito caso o usuário esteja em outro número de ip que não seja o informado.

Data Bloqueio - Utilize caso deseje que o usuário não tenha mais acesso a plataforma após um determinado período.

Acesso Admin - Para que o usuário tenha permissão de administrador na plataforma. Esse tipo de usuário tem acesso total aos 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 quando desejar editar algum campo de qualquer usuário da plataforma. Essa alteração poderá ser nos campos de dados cadastrais (senha, equipe, documento, telefone,) ou alteração relacionada aos dados de segurança, como definir uma restrição de acesso por ip , definir uma data para o bloqueio automático do acesso ou alterar o usuário para administrador (consulte a integração "01.10 - criando um novo usuário" para mais informações sobre os possíveis campos dos usuários).

XML de Envio:

<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> 
*Itens em negrito são obrigatórios.

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:

<main>
  <func trans="01.15">
    <dados_usuario>
      <email>[E-MAIL]</email>
    </dados_usuario>
  </func>
</main> 
*Itens em negrito são obrigatórios.

XML de Retorno:

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

Atenção: Não é possível excluir um usuário caso ele tenha permissão de administrador. Primeiro será necessário retirar essa opção que poderá ser feita via integração "01.13 Editar um Usuário" ou manualmente acessando a plataforma.

 

01.20 - Criar uma Nova Equipe

 

Utilize essa integração para criar uma nova equipe. As equipes são como um grupo com regras de permissões. Elas facilitam a administração quando se tem muitos usuários, por exemplo, imagine que você tem 10 usuários todos da equipe marketing, se precisar trocar alguma permissão basta alterar a permissão na equipe ao invés de trocar  um a um.

XML de Envio:

<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>
*Itens em negrito são obrigatórios.

Nome: o valor desse campo deverá seguir o formato de retorno conforme a integração "01.22 - Lista Equipes Cadastradas", passando-se o nome da nova equipe ao final da estrutura. Por exemplo: Para criar uma equipe chamada “Treinamento2” abaixo da equipe Treinamento ficaria: Treinamento|Treinamento2.

Criar Estrutura: Se for passado TRUE neste campo o sistema irá criar 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> 

*Itens em negrito são obrigatórios.

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 edita uma equipe na plataforma para alterações. As alterações podem acontecer no nome ou na estrutura (caminho) da equipe.

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> 
*Itens em negrito são obrigatórios.

Nome - O valor desse campo deverá seguir o formato de retorno conforme a integração "1.22 Lista equipes cadastradas", passando-se o caminho completo da equipe.

Novo Nome: O valor desse campo deverá seguir o formato de retorno conforme a integração "01.22 Lista Equipes Cadastradas", passando-se o novo nome da nova equipe no final da estrutura.

Criar Estrutura: Se for passado TRUE neste valor o sistema irá criar toda a estrutura necessária para a alteração da equipe.

 Exemplo:

  Se tivermos uma equipe com o caminho como o descrito a seguir:

  Equipe1|Equipe1.1|Equipe1.1.1

  E quisermos alterar a equipe Equipe1.1.1 para:

  Equipe2|Equipe2.1

  E não existir uma equipe chamada Equipe2 e desejamos criá-la no 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>

*Itens em negrito são obrigatórios.

Após a operação correr com sucesso a estrutura ficará como a descrita 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> 
*Itens em negrito são obrigatórios.

Nome - O valor desse campo deverá seguir o formato de retorno conforme a integração "01.22 Lista equipes cadastradas", passando-se o caminho completo da equipe.

Para excluir a equipe não pode existir nenhuma equipe relacionada a ela, e também nenhum usuário cadastrado nela. Somente será excluída a última equipe passada.

  Exemplo: Se quisermos excluir a equipe Equipe1.1 do caminho descrito a seguir:

Equipe1|Equipe1.1|Equipe1.1.1

Será necessário primeiro a exclusão da Equipe1.1.1 e depois da equipe Equipe1.1, sendo necessário duas integrações para obter o resultado esperado.

XML de Retorno:

<main>
  <func trans="01.25" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
    <return id="00">Ok</return>
  </func>
</main>
Este conteúdo foi útil?31