Com a nossa API simples, pode adicionar automaticamente participantes à sua prova e academia e enviar-lhes um convite.
Linguagem da API
A nossa API aceita application/x-www-form-urlencoded ou multipart/form-data e json.
API de Provas
Adicionar participante
Esta chamada à API só funciona se o acesso à sua prova estiver definido para um grupo de utilizadores predefinido.
Método HTTP: POST
Ponto final: https: //dashboard.easy-lms.com/?r=api/exam/addParticipant
Resposta de sucesso
{ "success":true }
Resposta de erro
{ "success":false, "error": "Exemplo de erro" }
Campo - Tipo - Descrição
- String - A chave API gerada para a sua conta. email - String - O endereço de correio eletrónico do participante que pretende adicionar. name - String - O nome do participante que pretende adicionar. examId - Integer - O ID da Prova.
Adicionar participante sem notificar
Adicione um participante à sua prova sem lhe enviar um convite. As credenciais de início de sessão serão devolvidas na resposta.
Método HTTP: POST
Ponto final: https: //dashboard.easy-lms.com/?r=api/exam/addParticipantWithoutNotifying
Resposta de sucesso
{ "success":true, "data": { "playUrl":"[https://the.url/to/your/exam]([https://the.url/to/your/exam](https://the.url/to/your/exam))", "email":"[[email protected]](mailto:[email protected])", "authenticationCode": "ExampleAuthenticationCode" } }
Resposta ao erro
{ "success":false, "error": "Exemplo de erro"}
- Tipo - Descrição apikey - String - A chave API gerada para a sua conta. email - String - O endereço de correio eletrónico do participante que pretende adicionar. name - String - O nome do participante que pretende adicionar. examId - Integer - O ID da Prova. identifier - String - O identificador do participante.
API da Academia
Adicionar participante
Esta chamada à API adiciona um participante a uma academia e faz com que o e-mail de convite para a academia seja enviado para ele. Também é possível usar essa chamada da API para adicionar o participante a um ou mais grupos imediatamente.
A ID da academia e a ID do grupo podem ser localizadas no final do URL:
Neste exemplo, o ID da academia é 123 e o ID do grupo é 45678.
Se não for especificado um ID de grupo, o participante só será adicionado à página de visão geral do participante da academia e do grupo Todos. Ao fazer login na academia, ele só verá o grupo Todos se o conteúdo tiver sido adicionado a ele.
Se não for fornecida uma ID de academia, será utilizada a primeira academia.
Método HTTP: POST
Ponto final: https: //dashboard.easy-lms.com/?r=api/academy/addParticipant
Resposta de sucesso
{"success":true}
Resposta de erro
{"success":false, "error": "Exemplo de erro"}
Campo - Tipo - Descrição
apikey - String - A chave API gerada para a sua conta. email - String - O endereço de correio eletrónico do participante que pretende adicionar. name - String - O nome do participante que pretende adicionar. groups - String - Os IDs dos grupos aos quais pretende adicionar o participante. Separe os IDs dos grupos com uma vírgula.academia - String - O ID da academia à qual pretende adicionar o participante. A predefinição é a primeira academia se não for fornecido um ID.
Adicionar participante sem notificar
Esta chamada à API adiciona um participante à sua academia, mas não envia um convite. O link do convite será retornado na resposta. Também é possível usar essa chamada à API para adicionar um participante a um ou mais grupos da academia.
A ID da academia e a ID do grupo podem ser localizadas no URL:
Neste exemplo, o ID da academia é 123 e o ID do grupo é 45678.
Se não for especificado um ID de grupo, o participante só será adicionado à página de visão geral do participante da academia e do grupo Everyone (Todos ). Ao fazer login na academia, ele só verá o grupo Todos se o conteúdo tiver sido adicionado a ele.
Se não for fornecida uma ID de academia, será utilizada a primeira academia.
Método HTTP: POST
Ponto final: https: //dashboard.easy-lms.com/?r=api/academy/addParticipantWithoutNotifying
Resposta de sucesso
`` {
"success":true, "data":{ "playUrl":"https://participant.easy-lms.com/your-academy", "email":"[email protected]", "inviteLink":"https://participant.easy-lms.com/your-academy/set-new-password?..."} }``
Resposta ao erro
{ "success":false, "error": "Exemplo de erro" }
Campo - Tipo - Descrição
- String - A chave API gerada para a sua conta. email - String - O endereço de correio eletrónico do participante que pretende adicionar. name - String - O nome do participante que pretende adicionar. identifier - String - O identificador do participante no seu sistema. groups - String - Os IDs dos grupos aos quais pretende adicionar o participante. Separe os IDs dos grupos com uma vírgula.academia - String - O ID da academia à qual deseja adicionar o participante. A predefinição é a primeira academia se não for fornecido um ID.
Se um participante já tiver sido adicionado à prova ou à academia, a API não falhará, mas actualizará os dados do participante se o identificador for o mesmo.