Com nossa API simples, você pode adicionar automaticamente participantes à sua prova e à sua academia e enviar um convite a eles.
Linguagem da API
Nossa API aceita os formatos application/x-www-form-urlencoded, multipart/form-data e JSON.
API de provas
Adicionar participante
Essa chamada de API só funciona se o acesso à sua prova estiver definido como “Um grupo predefinido de usuários”.
Método HTTP: POST
Resposta de sucesso
{ "success":true }
Resposta de erro
{ "success":false, "error":"Exemplo de erro" }
Campo - Tipo - Descrição
- String - A chave de API gerada para sua conta. email - String - O endereço de e-mail do participante que você deseja adicionar. name - String - O nome do participante que você deseja adicionar. examId - Inteiro - O ID da Prova.
Adicionar participante sem notificação
Adicione um participante à sua prova sem enviar um convite a ele. As credenciais de login serão retornadas na resposta.
Método HTTP: POST
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 de erro
{ "success":false, "error":"Exemplo de erro"}
- Tipo - Descrição apikey - String - A chave de API gerada para sua conta. email - String - O endereço de e-mail do participante que você deseja adicionar. name - String - O nome do participante que você deseja adicionar. examId - Inteiro - O ID da Prova. identifier - String - O identificador do participante.
API da Academia
Adicionar participante
Esta chamada de API adiciona um participante a uma academia e aciona o envio do e-mail de convite da academia para ele. Você também pode usar esta chamada de API para adicionar o participante a um ou mais grupos imediatamente.
O ID da academia e o ID do grupo podem ser encontrados no final da URL:
Neste exemplo, o ID da academia é 123 e o ID do grupo é 45678.
Se nenhum ID de grupo for especificado, o participante será adicionado apenas à página de visão geral dos participantes da academia e ao grupo “Todos ”. Ao fazer login na academia, ele verá apenas o grupo “Todos”, caso haja conteúdo adicionado a ele.
Se nenhum ID da academia for fornecido, será utilizada a primeira academia.
Método HTTP: POST
Resposta de sucesso
{ "success":true}
Resposta de erro
{ "success":false, "error":"Exemplo de erro"}
Campo - Tipo - Descrição
apikey - String - A chave de API gerada para sua conta. email - String - O endereço de e-mail do participante que você deseja adicionar. name - String - O nome do participante que você deseja adicionar. groups - String - Os IDs dos grupos aos quais você deseja adicionar o participante. Separe os IDs dos grupos com uma vírgula. academia - String - O ID da academia à qual você deseja adicionar o participante. O padrão é a primeira academia, caso nenhum ID seja fornecido.
Adicionar participante sem notificação
Esta chamada de API adiciona um participante à sua academia, mas não envia um convite. O link de convite será retornado na resposta. Você também pode usar esta chamada de API para adicionar um participante a um ou mais grupos da sua academia.
O ID da academia e o ID do grupo podem ser encontrados na URL:
Neste exemplo, o ID da academia é 123 e o ID do grupo é 45678.
Se nenhum ID de grupo for especificado, o participante será adicionado apenas à página de visão geral dos participantes da academia e ao grupo “Todos ”. Ao fazer login na academia, ele verá apenas o grupo “Todos”, caso haja conteúdo adicionado a ele.
Se nenhum ID da academia for fornecido, será utilizada a primeira academia.
Método HTTP: POST
Ponto de extremidade: 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-academia/set-new-password?..." } }``
Resposta de erro
{ "success":false, "error":"Exemplo de erro" }
Campo - Tipo - Descrição
- String - A chave de API gerada para sua conta. email - String - O endereço de e-mail do participante que você deseja adicionar. name - String - O nome do participante que você deseja adicionar. identifier - String - O identificador do participante em seu sistema. groups - String - Os IDs dos grupos aos quais você deseja adicionar o participante. Separe os IDs dos grupos com uma vírgula.academy - String - O ID da academia à qual você deseja adicionar o participante. O padrão é a primeira academia, caso nenhum ID seja fornecido.
Se um participante já tiver sido adicionado à prova ou à academia, a API não apresentará erro, mas atualizará os dados do participante caso o identificador seja o mesmo.