API: Como matricular usuários em uma missão

A API do Learning.Rocks permite gerenciar diversas informações sobre Missões – entre elas, é possível matricular usuários em missões.

Clicando aqui você pode acessar a collection completa de Missões.

Por meio da API, é possível forçar a matrícula de um usuário específico ou de todos os usuários que fazem parte do público-alvo da missão. Em ambos os casos, é importante observar as regras de funcionamento:

• O pedido de matrícula funcionará apenas se a missão já estiver criada e com o status de “publicada”;
• A matrícula só é permitida para usuários que ainda não estejam matriculados na missão. Trata-se de uma ação única por missão; portanto, se o usuário já estiver matriculado, a ação não será executada;
• A matrícula é permitida apenas para usuários que estiverem na audiência da missão. Se a missão for pública, todos os usuários poderão ser matriculados;
• Caso a missão possua um pré-requisito, a matrícula só será permitida se o pré-requisito já estiver concluído pelo usuário;
• A data de matrícula será registrada conforme a data em que o comando for enviado pela API. A missão continuará respeitando as configurações de vencimento, caso elas tenham sido definidas.
• Para enviar as requisições, é necessário saber o ID da missão, que pode ser obtido nos relatórios da plataforma.
• Para lidar com um grande volume de solicitações simultâneas, recomendamos que as requisições sejam realizadas de forma paginada, garantindo que o desempenho não seja comprometido.

Matricular um usuário na missão

Esse endpoint permite matricular um usuário de forma individual. Para isso, é necessário enviar um comando POST para a URL: https://mission.learningrocks.io/enrollment_requests.

O body da requisição deve ser preenchido com os seguintes campos:

• "mission_id": "id" – substituindo "id" pelo ID da missão;
• "user_id": id – substituindo "id" pelo ID do usuário.

Exemplo de request e response:

Matricular toda a audiência na missão

Esse endpoint permite matricular na missão todos os usuários que estiverem em sua audiência, independentemente de ela ser pública ou possuir filtros de times ou audiências inteligentes.

Para isso, é necessário enviar um comando POST para a URL: https://mission.learningrocks.io/bulk_enrollment_requests.

O body da requisição deve ser preenchido com o seguinte campo:

• "mission_id": "id" – substituindo "id" pelo ID da missão.

Exemplo de request e response: