Regisztráció Belépés

Vizsga API

Vizsgák, kérdések, megválaszolások és kísérletek kezelése — lekérés, létrehozás, módosítás, törlés

Végpontok

Authentikáció

Minden API kéréshez szükséges az X-API-KEY header küldése.

X-API-KEY: {az_api_kulcsod}

Maradt még kérdésed?

Írj ticketet nekünk, vagy nézz körbe a keresőnkben.

Ha tetszett, oszd meg másokkal

Alap URL

https://{tenant}.logzi.com/api/exam/

Minden kérés JSON választ ad vissza. Sikeres válasz esetén result.code == 1, hiba esetén result.code == 0.

GET /api/exam/get

Egyetlen vizsga lekérése azonosító alapján.

Query paraméterek

Paraméter Típus Kötelező Leírás
id int A vizsga egyedi azonosítója

Példa kérés

GET /api/exam/get?id=1
X-API-KEY: {az_api_kulcsod}

Példa válasz

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 1,
    "title": "Termékismeret vizsga",
    "description": "Alapozó teszt új belépők számára.",
    "company_id": 1,
    "date_create": "2024-01-10 09:00:00",
    "date_update": "2024-05-20 14:30:00"
  }
}
GET /api/exam/list

Vizsgák lapozható listájának lekérése.

Query paraméterek

Paraméter Típus Kötelező Leírás
list_offset int Lapozás eltolása (alapértelmezett: 0)
list_count int Rekordok száma oldalanként (alapértelmezett: 20)
company_id int Szűrés cég azonosítóra

Példa kérés

GET /api/exam/list?list_offset=0&company_id=1
X-API-KEY: {az_api_kulcsod}

Példa válasz

{
  "result": { "code": 1, "message": "success" },
  "data": [
    {
      "id": 1,
      "title": "Termékismeret vizsga",
      "description": "Alapozó teszt új belépők számára.",
      "date_create": "2024-01-10 09:00:00",
      "date_update": "2024-05-20 14:30:00"
    }
  ],
  "params": {
    "list_all": 5,
    "list_offset": 0,
    "list_count": 20
  }
}
POST /api/exam/save

Vizsga létrehozása vagy módosítása. Új vizsgához data[id] = 0, módosításhoz a meglévő ID-t add meg.

POST mezők — data objektum

Mező Típus Kötelező Leírás
id int 0 = új vizsga, >0 = módosítás
company_id int Cég azonosítója (csak új vizsgánál kötelező)
title string A vizsga neve
description string Leírás / utasítás a kitöltőnek

Példa kérés

POST /api/exam/save
X-API-KEY: {az_api_kulcsod}
Content-Type: application/json

{
  "data": {
    "id": 0,
    "company_id": 1,
    "title": "Termékismeret vizsga",
    "description": "Alapozó teszt új belépők számára."
  }
}

Példa válasz

{
  "result": { "code": 1, "message": "Saved" },
  "data": { "id": 3 }
}
POST /api/exam/delete

Vizsga logikai törlése.

POST mezők — data objektum

Mező Típus Kötelező Leírás
id int A törlendő vizsga azonosítója

Példa kérés

POST /api/exam/delete
X-API-KEY: {az_api_kulcsod}
Content-Type: application/json

{
  "data": { "id": 3 }
}

Példa válasz

{
  "result": { "code": 1, "message": "Deleted" },
  "data": { "id": 3 }
}
GET /api/exam/question-list

Egy vizsgához tartozó összes kérdés lekérése a hozzájuk tartozó válaszlehetőségekkel.

Query paraméterek

Paraméter Típus Kötelező Leírás
exam_id int A vizsga azonosítója

Példa kérés

GET /api/exam/question-list?exam_id=1
X-API-KEY: {az_api_kulcsod}

Példa válasz

{
  "result": { "code": 1, "message": "success" },
  "data": [
    {
      "id": 10,
      "exam_id": 1,
      "question_text": "Mi a Logzi fő funkciója?",
      "question_type": "radio",
      "explanation_text": "A Logzi egy ERP rendszer.",
      "sort_order": 1,
      "answers": [
        { "id": 101, "answer_text": "Számlázás és készletkezelés", "is_correct": 1, "sort_order": 0 },
        { "id": 102, "answer_text": "Videóstream", "is_correct": 0, "sort_order": 1 }
      ]
    }
  ]
}
GET /api/exam/question

Egyetlen kérdés lekérése azonosító alapján, a válaszlehetőségekkel együtt.

Query paraméterek

Paraméter Típus Kötelező Leírás
id int A kérdés azonosítója

Példa kérés

GET /api/exam/question?id=10
X-API-KEY: {az_api_kulcsod}

Példa válasz

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 10,
    "exam_id": 1,
    "question_text": "Mi a Logzi fő funkciója?",
    "question_type": "radio",
    "explanation_text": "A Logzi egy ERP rendszer.",
    "sort_order": 1,
    "answers": [
      { "id": 101, "answer_text": "Számlázás és készletkezelés", "is_correct": 1, "sort_order": 0 },
      { "id": 102, "answer_text": "Videóstream", "is_correct": 0, "sort_order": 1 }
    ]
  }
}
POST /api/exam/save-question

Kérdés létrehozása vagy módosítása a hozzá tartozó válaszlehetőségekkel együtt. Módosításkor a meglévő válaszok törlődnek és újak kerülnek be.

POST mezők — data objektum

Mező Típus Kötelező Leírás
id int 0 = új kérdés, >0 = módosítás
exam_id int Vizsga azonosítója (csak új kérdésnél kötelező)
question_text string A kérdés szövege
question_type string Kérdés típusa: radio, checkbox, true_false, text
explanation_text string Magyarázó szöveg a válasz megjelenítésekor
sort_order int Sorrend (alapértelmezett: 0)
answers array Válaszlehetőségek tömbje (ld. alább) — text típusnál nem szükséges

Válasz mezők — data[answers][]

Mező Típus Kötelező Leírás
answer_text string A válaszlehetőség szövege
is_correct int 1 = helyes válasz, 0 = helytelen válasz

Példa kérés

POST /api/exam/save-question
X-API-KEY: {az_api_kulcsod}
Content-Type: application/json

{
  "data": {
    "id": 0,
    "exam_id": 1,
    "question_text": "Mi a Logzi fő funkciója?",
    "question_type": "radio",
    "explanation_text": "A Logzi egy ERP rendszer.",
    "sort_order": 1,
    "answers": [
      { "answer_text": "Számlázás és készletkezelés", "is_correct": 1 },
      { "answer_text": "Videóstream", "is_correct": 0 }
    ]
  }
}

Példa válasz

{
  "result": { "code": 1, "message": "Saved" },
  "data": { "id": 10 }
}
POST /api/exam/delete-question

Kérdés törlése. A kérdéshez tartozó összes válaszlehetőség is törlésre kerül.

POST mezők — data objektum

Mező Típus Kötelező Leírás
id int A törlendő kérdés azonosítója

Példa kérés

POST /api/exam/delete-question
X-API-KEY: {az_api_kulcsod}
Content-Type: application/json

{
  "data": { "id": 10 }
}

Példa válasz

{
  "result": { "code": 1, "message": "Deleted" },
  "data": { "id": 10 }
}
GET /api/exam/attempt-list

Egy vizsgához tartozó összes kísérlet (kitöltés) listájának lekérése partner-felhasználó adatokkal.

Query paraméterek

Paraméter Típus Kötelező Leírás
exam_id int A vizsga azonosítója

Példa kérés

GET /api/exam/attempt-list?exam_id=1
X-API-KEY: {az_api_kulcsod}

Példa válasz

{
  "result": { "code": 1, "message": "success" },
  "data": [
    {
      "id": 5,
      "exam_id": 1,
      "partner_user_id": 12,
      "partner_user_name": "Kovács Béla",
      "partner_user_email": "kovacs.bela@example.com",
      "status": "completed",
      "score": 8,
      "date_start": "2024-06-01 10:00:00",
      "date_complete": "2024-06-01 10:15:00"
    }
  ]
}
POST /api/exam/save-attempt

Új vizsga-kísérlet (kitöltési munkamenet) indítása egy partner-felhasználó számára. Visszaadja a kísérlet azonosítóját és a kitöltési linket (chk) tartalmazó kulcsot.

POST mezők

Mező Típus Kötelező Leírás
exam_id int A vizsga azonosítója
partner_user_id int A kitöltő partner-felhasználó azonosítója

Példa kérés

POST /api/exam/save-attempt
X-API-KEY: {az_api_kulcsod}
Content-Type: application/json

{
  "exam_id": 1,
  "partner_user_id": 12
}

Példa válasz

{
  "result": { "code": 1, "message": "Created" },
  "data": {
    "id": 5,
    "chk": "a3f9c2e1b07d..."
  }
}
POST /api/exam/save-slide-answer

Egy kérdésre adott válasz mentése egy aktív kísérlethez. Az utolsó kérdés megválaszolásakor a kísérlet automatikusan lezárul és a pontszám kiszámítódik.

POST mezők

Mező Típus Kötelező Leírás
attempt_id int A kísérlet azonosítója
question_id int A megválaszolandó kérdés azonosítója
partner_user_id int A kitöltő partner-felhasználó azonosítója
selected_answer_ids array Kiválasztott válasz-ID-k tömbje (radio, checkbox, true_false típushoz)
text_answer string Szöveges válasz (text típusú kérdéshez)

Példa kérés

POST /api/exam/save-slide-answer
X-API-KEY: {az_api_kulcsod}
Content-Type: application/json

{
  "attempt_id": 5,
  "question_id": 10,
  "partner_user_id": 12,
  "selected_answer_ids": [101]
}

Példa válasz (nem utolsó kérdés)

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "is_correct": 1,
    "correct_answer_ids": [101],
    "explanation_text": "A Logzi egy ERP rendszer.",
    "is_last": false
  }
}

Példa válasz (utolsó kérdés — kísérlet lezárul)

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "is_correct": 1,
    "correct_answer_ids": [101],
    "explanation_text": "A Logzi egy ERP rendszer.",
    "is_last": true,
    "score": 9,
    "total": 10
  }
}

Vedd fel a kapcsolatot velünk

Érdeklődsz a szoftverünkkel kapcsolatban, írj bátran!

Érdeklődés küldése

Segítségre van szükséged?

Ha nem találod a választ és szükséged van segítségre

Nézz körbe a help centerben

Regisztrációdat hozd létre most,
fizess később!

Próbáld ki 3 napig ingyen, kockázatok és kötöttségek nélkül!
Regisztráció készítése
Regisztráció