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 application/x-www-form-urlencoded, multipart/form-data e JSON.
API de provas
Adicionar participante
Esta 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. nome - String - O nome do participante que você deseja adicionar. examId - Inteiro - O ID da Prova.
Adicionar participante sem notificá-lo
Adicione um participante à sua prova sem enviar a ele um convite. 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":"[john@doe.com](mailto:john@doe.com)", "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 Visão geral dos participantes da Academia e ao grupo Todos. Ao fazer login na Academia, ele verá apenas o grupo Todos se houver 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 por 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.
Adicionar participante sem notificar
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 em 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 Visão geral dos participantes da Academia e ao grupo Todos. Ao fazer login na academia, ele verá apenas o grupo Todos se houver 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, "data":{ "playUrl":"https://participant.easy-lms.com/your-academy", "email":"john@doe.com", "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. grupos - 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. Se nenhum ID for fornecido, o padrão será a primeira Academia.
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.