Guia de integração
Eventos e webhook
Validar a entrada do exame
Você pode validar um entrevistado que está prestes a fazer um exame e também adicionar metadados sobre este usuário.
Quando um pedido de demandado para iniciar um exame, nosso servidor fará uma solicitação de webhook ao URL do servidor para validar se a credencial do entrevistado (por exemplo, email, senha ou matric não) for válido.
Seu servidor pode responder opcional a alguns metadados sobre esse entrevistado, como name, email, photo, about and data.
Abaixo, o exemplo imita a solicitação feita ao seu servidor e a resposta esperada se a verificação foi bem -sucedida
Quando um pedido de demandado para iniciar um exame, nosso servidor fará uma solicitação de webhook ao URL do servidor para validar se a credencial do entrevistado (por exemplo, email, senha ou matric não) for válido.
Seu servidor pode responder opcional a alguns metadados sobre esse entrevistado, como name, email, photo, about and data.
Abaixo, o exemplo imita a solicitação feita ao seu servidor e a resposta esperada se a verificação foi bem -sucedida
Observe que você deve responder dentro de 60 segundos ou a solicitação será encerrada por nosso servidor.
Se o entrevistado não puder ser validado pelo seu servidor, espera -se que você forneça errorMessage com o motivo, senão você deve omitir.Você pode opcionalmente fornecer o metadata Se a validação foi bem -sucedida.
Além metadata.photo com link para uma imagem nítida do entrevistado. A resolução de imagem recomendada é uma imagem superior a 1500x1500 pixels.
Se o entrevistado não puder ser validado pelo seu servidor, espera -se que você forneça errorMessage com o motivo, senão você deve omitir.Você pode opcionalmente fornecer o metadata Se a validação foi bem -sucedida.
Além metadata.photo com link para uma imagem nítida do entrevistado. A resolução de imagem recomendada é uma imagem superior a 1500x1500 pixels.
Verifique se você verifica toda a solicitação de entrada para o seu servidor x-client-id and x-client-secret No cabeçalho da solicitação
{
"event": "verify_respondent",
"fields": [
{
"position": 0,
"value": "Some valid student id"
},
{
"position": 1,
"value": "Some valid student password"
}
],
"exam_id": "some unique exam_id",
"choosenLang": "ru"
}O exemplo abaixo imita a solicitação feita ao seu servidor e a resposta esperada se a verificação falhou
{
"event": "verify_respondent",
"fields": [
{
"position": 0,
"value": "Some invalid student id"
},
{
"position": 1,
"value": "Some invalid student password"
}
],
"exam_id": "some unique exam_id..",
"choosenLang": "ru"
}Certifique -se de ativar validate fields via webhook Na página de criação do exame
Ou se você estiver usando a API do desenvolvedor, verifique se se welcomePage.validate é verdade
Ou se você estiver usando a API do desenvolvedor, verifique se se welcomePage.validate é verdade
Definindo seu URL da webhook
Você pode definir e alterar o URL do WebHook do servidor, aqui está como
Navegue para configurações.
Vá para a seção do desenvolvedor.
Edit and copy your webhook url
Admita o evento entrevistado
Nosso servidor notificará seu servidor quando um entrevistado for admitido para fazer um exame. O exemplo abaixo demonstra este cenário
respondent_id Para procurar informações adicionais sobre este entrevistado
{
"event": "admitted_respondent",
"respondent_id": "some unique id given to the respondent",
"exam_id": "some unique exam_id",
"admittedOn": 1719221380326
}Evento pronto para resultado
Nosso servidor notificará seu servidor quando um resultado de um entrevistado para um exame estiver pronto. O exemplo abaixo demonstra este cenário
respondent_id Para procurar os dados de resultado para este entrevistado
{
"event": "result_ready",
"respondent_id": "some unique id given to the respondent",
"exam_id": "some unique exam_id"
}Evento completo da investigação
Nosso servidor notificará seu servidor quando a investigação em um entrevistado for concluída. O exemplo abaixo demonstra este cenário
respondent_id Para procurar informações adicionais sobre este entrevistado
{
"event": "investigation_complete",
"respondent_id": "some unique id given to the respondent",
"exam_id": "some unique exam_id"
}Comentários de feedback (0)
