Integrációs útmutató
Események és webhook
A vizsgabejárat validálása
Érvényesítheti egy olyan válaszadót, aki hamarosan vizsga lesz, és metaadatokat is hozzáadhat erről a felhasználóról.
Amikor egy válaszadó kérést kér egy vizsga elindításához, szerverünk webhook kérést készít a szerver URL -jéhez, hogy érvényesítse, ha a válaszadó hitelesítő adatait (pl. E -mail, jelszó vagy matrica) érvényes -e érvényben..
A szerver választható lehet válaszolni néhány metaadattal erről a válaszadóról, például name, email, photo, about and data.
Az alábbiakban a példa utánozza a szerverre tett kérelmet és a várható válasz, ha az ellenőrzés sikeres volt
Amikor egy válaszadó kérést kér egy vizsga elindításához, szerverünk webhook kérést készít a szerver URL -jéhez, hogy érvényesítse, ha a válaszadó hitelesítő adatait (pl. E -mail, jelszó vagy matrica) érvényes -e érvényben..
A szerver választható lehet válaszolni néhány metaadattal erről a válaszadóról, például name, email, photo, about and data.
Az alábbiakban a példa utánozza a szerverre tett kérelmet és a várható válasz, ha az ellenőrzés sikeres volt
Felhívjuk figyelmét, hogy várhatóan 60 másodpercen belül válaszol, vagy a szerverünk megszünteti a kérést.
Ha a válaszadót a szerver nem tudta érvényesíteni, akkor várhatóan megadja errorMessage Az okkal, különben elvárják, hogy kihagyja.Opcionálisan megadhatja a metadata Ha az érvényesítés sikeres volt.
Szintén ha a válaszadó arcfelismerését szándékozik elvégezni, akkor várhatóan megadja a metadata.photo linkkel a válaszadó éles képéhez. Az ajánlott képfelbontás egy 1500x1500 pixelnél nagyobb kép.
Ha a válaszadót a szerver nem tudta érvényesíteni, akkor várhatóan megadja errorMessage Az okkal, különben elvárják, hogy kihagyja.Opcionálisan megadhatja a metadata Ha az érvényesítés sikeres volt.
Szintén ha a válaszadó arcfelismerését szándékozik elvégezni, akkor várhatóan megadja a metadata.photo linkkel a válaszadó éles képéhez. Az ajánlott képfelbontás egy 1500x1500 pixelnél nagyobb kép.
Győződjön meg arról, hogy ellenőrizze az összes bejövő kérést az Ön szerverének x-client-id and x-client-secret A kérési fejlécen
{
"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"
}A példa alatt utánozza a szerverre tett kérelmet és a várható választ, ha az ellenőrzés sikertelen
{
"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"
}Gondoskodjon arról, hogy engedélyezve legyen validate fields via webhook A vizsga létrehozási oldalán
Vagy ha a Developer API -t használja, ellenőrizze welcomePage.validate igaz
Vagy ha a Developer API -t használja, ellenőrizze welcomePage.validate igaz
A webhook URL beállítása
Beállíthatja és megváltoztathatja a szerver webhook URL -jét, a következő
Keresse meg a beállításokat.
Lépjen a Fejlesztő szakaszba.
Edit and copy your webhook url
Befogadni a válaszadó eseményt
Szerverünk értesíti a szerverét, amikor a válaszadót felvették a vizsga elvégzésére. Az alábbiakban bemutatja ezt a forgatókönyvet
respondent_id További információk keresése erről a válaszadóról
{
"event": "admitted_respondent",
"respondent_id": "some unique id given to the respondent",
"exam_id": "some unique exam_id",
"admittedOn": 1719221380326
}Eredmény kész esemény
Szerverünk értesíti a szerverét, amikor a válaszadó eredménye készen áll. Az alábbiakban bemutatja ezt a forgatókönyvet
respondent_id A válaszadó eredményadatainak megkereséséhez
{
"event": "result_ready",
"respondent_id": "some unique id given to the respondent",
"exam_id": "some unique exam_id"
}Vizsgálat teljes esemény
Szerverünk értesíti a szerverét, amikor a válaszadó vizsgálata befejeződik. Az alábbiakban bemutatja ezt a forgatókönyvet
respondent_id További információk keresése erről a válaszadóról
{
"event": "investigation_complete",
"respondent_id": "some unique id given to the respondent",
"exam_id": "some unique exam_id"
}Visszajelzési megjegyzések (0)
