Com nossa API simples você pode automaticamente adicionar participantes ao seu Exame ou Academia e enviar-lhes um convite.

Linguagem API

Nossa API aceita aplicações/x-www-form-urlencoded ou multipart/form-data e json.

Examinar API

Adicionar participante

Esta chamada API só funciona se o acesso do seu Exame estiver definido para . Um grupo predefinido de usuários.

Método HTTP: POST

Endpoint: https://www.onlinequizcreator.com/?r=api/exam/addParticipant

Resposta de sucesso
{
"sucesso":true
}

Resposta de erro
{
"sucesso":falso,
"erro": "Exemplo de erro".
}

Campo - Tipo - Descrição

apikey - String - A chave API gerada para a sua conta.
email - String - O endereço de email do participante que você deseja adicionar.
nome - String - O nome do participante que você deseja adicionar.
examId - Integer - O ID do exame.

Adicionar participante sem notificar

Adicione um participante ao seu Exame sem lhe enviar um convite. As credenciais de login serão devolvidas na resposta.

Método HTTP: POST

Endpoint: https://www.onlinequizcreator.com/?r=api/exam/addParticipantWithoutNotifying

Resposta de sucesso
{
"sucesso":true,
"dados":
{
"playUrl":"[https://the.url/to/your/exam](https://the.url/to/your/exam)",
"email":"[john@doe.com](mailto:john@doe.com)",
"authenticationCode":"ExampleAuthenticationCode":"Código de autenticação".
}
}

Resposta a erros

{"sucesso":falso, "erro":"erro de exemplo"}

Campo - Tipo - Descrição
apikey - String - A chave API gerada para a sua conta.
email - String - O endereço de email do participante que você deseja adicionar.
nome - String - O nome do participante que você deseja adicionar.
examId - Integer - O ID do exame.
identificador - String - O identificador para o participante.

API da Academia

Adicionar participante

Adicione um participante à sua Academia. Você pode adicionar um participante a um ou mais grupos em sua Academia (IDs de grupos podem ser encontrados na página Visão geral do grupo ).

Método HTTP: POST

Endpoint: https://www.onlinequizcreator.com/?r=api/academy/addParticipant

Resposta de sucesso

{"sucesso":true}

Resposta de erro

{"sucesso":falso, "erro":"erro de exemplo"}

Campo - Tipo - Descrição

apikey - String - A chave API gerada para a sua conta.
email - String - O endereço de email do participante que você deseja adicionar.
nome - String - O nome do participante que você deseja adicionar.
grupos - String - Os grupos aos quais você quer adicionar o participante. Separe os IDs dos grupos com uma vírgula.

Adicionar participante sem notificar

Adicione um participante à sua Academia, mas não envie um convite. As credenciais de login serão devolvidas na resposta. Você pode adicionar um participante a um ou mais grupos em sua Academia (IDs de grupos podem ser encontrados na página Visão geral do grupo ).

Método HTTP: POST

Endpoint: https://www.onlinequizcreator.com/?r=api/academy/addParticipantWithoutNotifying

Resposta de sucesso
{
"sucesso":true,
"dados":
{
"playUrl":"[https://the.url/to/your/academy](https://the.url/to/your/academy)",
"email":"[john@doe.com](mailto:john@doe.com)",
"authenticationCode":"ExampleAuthenticationCode":"Código de autenticação".
}
}

Resposta a erros

{"sucesso":falso, "erro":"erro de exemplo"}

Campo - Tipo - Descrição

apikey - String - A chave API gerada para a sua conta.
email - String - O endereço de email do participante que você deseja adicionar.
nome - String - O nome do participante que você deseja adicionar.
identificador - String - O identificador para o participante em seu sistema.
grupos - String - Os grupos aos quais você quer adicionar o participante. Separe os IDs dos grupos com uma vírgula.

Publicado em: 22 / 12 / 2020