API: Ações que podem ser automatizadas

Para o bom uso da plataforma, é necessário que alguns dados recebam manutenção constante. Essas ações são geralmente executadas manualmente pelo administrador da plataforma, o que demanda tempo e aumenta a possibilidade de erros.

No entanto, parte dessas ações pode ser automatizada por meio de uma API, proporcionando mais agilidade e confiabilidade ao processo.

Neste artigo, descrevemos as principais ações executadas pelos administradores da plataforma que podem ser contempladas via API, detalhando seus objetivos e impactos no projeto.

Criação de usuários

Para que uma pessoa possa acessar a plataforma, é necessário que ela possua um Perfil. Para a criação de um, algumas informações são mínimas e obrigatórias, sendo elas:

• Name: Nome do usuário;
• E-mail: Campo identificador preenchido com o e-mail do usuário;
• Username: Campo identificador alternativo, que pode ser preenchido com qualquer informação, desde que exclusiva e não repetida entre os usuários (ex.: CPF ou matrícula da empresa);
• Role: Permissão do usuário (caso não seja preenchida, o usuário será criado como estudante).

Observação: É obrigatório o preenchimento de apenas um dos campos identificadores (E-mail ou Username). Se ao menos um deles for informado, o outro pode ser desconsiderado.

Além disso, existem outros campos de perfil que podem ser preenchidos conforme a necessidade do projeto, como:

• Idioma: Define o idioma da plataforma para esse usuário (se não for preenchido, será considerado o idioma padrão do ambiente);
• Líderes: Define quem são as pessoas líderes do usuário, que terão acesso aos relatórios de uso do liderado. Um usuário pode ter múltiplos líderes.

Inativação de usuários

Outro processo crítico executado pelos administradores da plataforma é a inativação de usuários. Esse procedimento é essencial para garantir que usuários desligados percam o acesso às ferramentas internas e para evitar cobranças adicionais, uma vez que a contratação da plataforma envolve a aquisição de licenças de uso para um número específico de usuários.

Para realizar essa gestão, o usuário possui o campo dedicado:

• Active
  • True: O usuário está ativo, pode acessar a plataforma e contará como um uso de licença contratada se continuar acessando.
  • False: O usuário estará inativo e não poderá mais acessar a plataforma.

Gestão de times

Os Times são a principal forma de segmentação e agrupamento de usuários dentro da plataforma. No cotidiano do projeto, é comum precisar designar treinamentos apenas para X pessoas ou criar uma gamificação apenas para Y pessoas. Com os Times, é possível organizar todos os agrupamentos necessários previamente, para que as relações sejam aplicadas de forma prática.

Na prática, utilizando a segmentação de treinamentos como exemplo, X pessoas podem compor um Time, e um Time pode dar acesso a Y treinamentos, conforme a ilustração abaixo:

• Uma pessoa pode estar em vários Times;
• Um Time pode dar acesso a vários treinamentos;
• Um treinamento pode ser acessado a partir de vários Times.

Para construir a API, é fundamental que haja alinhamento entre o time técnico e o time responsável pela gestão de treinamentos, pois são eles que irão definir a lógica de Times utilizada.

Gestão de metadados

Outra informação que pode ser preenchida são os metadados, que nada mais são do que campos adicionais no perfil do usuário. Os metadados podem ser utilizados em relatórios ou para o filtro de treinamentos na estrutura de “missões”, por meio das audiências inteligentes.

Para relatórios, existem cinco campos padrão que podem ser preenchidos: CPF, filial, departamento, cargo & data de admissão.

Para a audiência inteligente, além dos metadados padrões utilizados em relatórios, você pode criar campos que sirvam como critério de segmentação. Nesse tipo de segmentação, diferentes critérios podem ser combinados para formar um grupo. Por exemplo, é possível selecionar apenas pessoas de determinados departamentos, mas restritas a uma filial específica.

Exemplo: Foi criada uma audiência chamada “Novos Admitidos São Paulo”. Estarão presentes nela apenas os usuários que foram admitidos entre 01/10/2025 e 31/10/2025 e que pertençam à localidade “São Paulo”.