Integrationshandbuch
Ereignisse und Webhook
Prüfungseingang validieren
Sie können einen Befragten validieren, der eine Prüfung ablegen und auch Metadaten über diesen Benutzer hinzufügen.
Wenn eine Befragte Anfrage zur Start einer Prüfung anfordert, stellt unser Server eine Webhook -Anforderung an Ihre Server -URL zur Überprüfung, ob der Befragte Anmeldeinformationen (z. B. E -Mail, Passwort oder Matric No) gültig ist.
Ihr Server kann optional mit einigen Metadaten über diesen Befragten reagieren, wie z. name, email, photo, about and data.
Nachfolgend nachdenkt die Anforderung an Ihren Server und die erwartete Antwort, wenn die Überprüfung erfolgreich war
Wenn eine Befragte Anfrage zur Start einer Prüfung anfordert, stellt unser Server eine Webhook -Anforderung an Ihre Server -URL zur Überprüfung, ob der Befragte Anmeldeinformationen (z. B. E -Mail, Passwort oder Matric No) gültig ist.
Ihr Server kann optional mit einigen Metadaten über diesen Befragten reagieren, wie z. name, email, photo, about and data.
Nachfolgend nachdenkt die Anforderung an Ihren Server und die erwartete Antwort, wenn die Überprüfung erfolgreich war
Bitte beachten Sie, dass Sie erwartet werden, dass Sie innerhalb von 60 Sekunden antworten oder die Anfrage von unserem Server beendet wird.
Wenn der Befragte nicht von Ihrem Server validiert werden könnte, werden Sie erwartet, dass Sie bereitstellen errorMessage Aus dem Grund wird es sonst erwartet, es wegzulassen.Sie können optional die bereitstellen metadata Wenn die Validierung erfolgreich war.
Auch wenn Sie beabsichtigen, die Gesichtserkennung des Befragten durchzuführen, werden Sie erwartet, dass Sie das zur Verfügung stellen möchten metadata.photo mit Link zu einem scharfen Bild des Befragten. Die empfohlene Bildauflösung ist ein Bild von mehr als 1500 x 1500 Pixel.
Wenn der Befragte nicht von Ihrem Server validiert werden könnte, werden Sie erwartet, dass Sie bereitstellen errorMessage Aus dem Grund wird es sonst erwartet, es wegzulassen.Sie können optional die bereitstellen metadata Wenn die Validierung erfolgreich war.
Auch wenn Sie beabsichtigen, die Gesichtserkennung des Befragten durchzuführen, werden Sie erwartet, dass Sie das zur Verfügung stellen möchten metadata.photo mit Link zu einem scharfen Bild des Befragten. Die empfohlene Bildauflösung ist ein Bild von mehr als 1500 x 1500 Pixel.
Stellen Sie sicher, dass Sie alle eingehenden Anforderungen an Ihren Server untersuchen, x-client-id and x-client-secret auf dem Anfrage -Header
{
"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"
}Nachfolgend nachdenkt die Anforderung an Ihren Server und die erwartete Antwort, wenn die Überprüfung fehlgeschlagen ist
{
"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"
}Stellen Sie sicher, dass Sie aktiviert sind validate fields via webhook Auf der Seite Erstellung von Prüfungen
Oder wenn Sie die Entwickler -API verwenden, stellen Sie sicher welcomePage.validate ist wahr
Oder wenn Sie die Entwickler -API verwenden, stellen Sie sicher welcomePage.validate ist wahr
Festlegen Ihrer Webhook -URL
Sie können Ihre Server -Webhook -URL festlegen und ändern. So wie ist wie
Navigieren Sie zu Einstellungen.
Gehen Sie zum Entwicklerabschnitt.
Edit and copy your webhook url
Befragte Ereignis eingeben
Unser Server benachrichtigt Ihren Server, wenn ein Befragter zugelassen wurde, eine Prüfung abzulegen. Das folgende Beispiel zeigt dieses Szenario
respondent_id Um zusätzliche Informationen zu diesem Befragten zu suchen
{
"event": "admitted_respondent",
"respondent_id": "some unique id given to the respondent",
"exam_id": "some unique exam_id",
"admittedOn": 1719221380326
}Ergebnisbereitete Ereignis
Unser Server benachrichtigt Ihren Server, wenn ein Befragterergebnis für eine Prüfung fertig ist. Das folgende Beispiel zeigt dieses Szenario
respondent_id Um die Ergebnisdaten für diesen Befragten zu suchen
{
"event": "result_ready",
"respondent_id": "some unique id given to the respondent",
"exam_id": "some unique exam_id"
}Untersuchung vollständiger Ereignis
Unser Server benachrichtigt Ihren Server, wenn die Untersuchung eines Befragten abgeschlossen ist. Nachfolgend zeigt das Beispiel dieses Szenario
respondent_id Um zusätzliche Informationen zu diesem Befragten zu suchen
{
"event": "investigation_complete",
"respondent_id": "some unique id given to the respondent",
"exam_id": "some unique exam_id"
}Feedback -Kommentare (0)
