API: O que é e como utilizar

O que é

O Learning Rocks dispõe de uma API com foco principal na atualização dos dados da base de usuários. Por meio desse processo, sua empresa pode enviar informações de colaboradores a partir de um sistema onde esses dados estejam armazenados e sempre atualizados (como o sistema de folha de pagamento) diretamente para nossa plataforma.

Entre as vantagens de construir a API, temos:

• Eficiência: Os dados serão enviados automaticamente, sem necessidade de importações em formato .csv;
• Confiabilidade: Os dados estarão sempre atualizados, sem a necessidade de gestão humana constante.

Como funciona

Trata-se de uma API passiva em REST, ou seja, aguardamos um comando para executar qualquer ação. Seja para armazenar ou enviar informações.

Acesse aqui a documentação da API com os endpoints disponíveis. Com eles, é possível:

• Criar, atualizar e inativar usuários;
• Criar e excluir times, bem como adicionar ou remover usuários desses times;
• Cadastrar informações complementares no perfil dos usuários, como metadados;
• Criar um link que autentique usuários por meio de outra plataforma;
• Gerenciar e acompanhar detalhes de uma missão.

Como configurar a API do LXM Learning.Rocks?

A configuração e a lógica da API são de responsabilidade da sua empresa. Algumas organizações possuem um time de desenvolvimento interno que assume essa demanda, enquanto outras optam por contratar um fornecedor para realizá-la.

Para a configuração, você pode solicitar um ambiente de homologação, que poderá ser utilizado para testes sem impacto no projeto oficial. A validade desse ambiente é de 90 dias, podendo ser solicitada prorrogação, caso necessário.

Além disso, é necessário solicitar um API Token, que é a chave utilizada para enviar e coletar dados do ambiente. Cada ambiente possui um token exclusivo; portanto, se sua empresa contar com um ambiente de produção e um ambiente de homologação, cada um terá seu próprio token — o que permite diferenciar qual ambiente receberá o comando.

Tanto o ambiente de homologação quanto o envio do API Token devem ser solicitados ao seu(a) CSM, e serão entregues em até 7 dias (SLA padrão).

Pontos importantes

• Meu time de TI/fornecedor possui algum suporte do time da UOL EdTech para a construção da API?
  Sim. O time da UOL EdTech realiza encontros iniciais com o seu time de TI ou fornecedor para explicar o funcionamento da API e apresentar a documentação. Além disso, oferece suporte para esclarecimento de dúvidas durante o processo de configuração.
• O Learning Rocks possui algum template de API que possa ser apenas reutilizado?
  Não. Cada cliente possui um uso muito específico do sistema, e cada empresa pode enviar os dados a partir de origens diferentes. Portanto, o desenvolvimento precisa ser feito do zero pelo time responsável do cliente.
• Como posso verificar se a API está funcionando corretamente?
  Você pode validar o funcionamento da API diretamente na plataforma. Checando se o comando enviado realizou a alteração desejada.
• Em média, qual é o tempo necessário para o desenvolvimento de uma API?
  Não existe uma resposta exata, pois cada desenvolvimento é único e depende da disponibilidade do time responsável e da complexidade das ações envolvidas. No entanto, para fins de controle, recomenda-se considerar ao menos 30 dias para o desenvolvimento.
• É necessário desenvolver a API antes de lançar a plataforma ou ela pode ser implementada depois?
  Não é necessário. A plataforma pode ser lançada inicialmente com os usuários carregados via arquivo .csv, e a API pode ser implementada posteriormente, a qualquer momento.
• Meu sistema de folha possui API, mas ela também é em REST. É possível enviar os dados para o LXM?
  Sim. Nesse caso, é necessário utilizar um sistema intermediário que busque ativamente os dados no seu sistema e, em seguida, realize o envio para o LXM.
• É possível coletar dados via API de outros recursos, como consumo de conteúdos, gamificação ou notificações
  Não. As únicas ações possíveis são aquelas descritas na documentação.