{"openapi":"3.0.3","info":{"title":"Erinvia Partner API","version":"1.0","description":"Az Erinvia mérőmotorjának külső, verziózott API-ja: a vállalat saját rendszeréből (például ATS vagy HR-rendszer) listázhatod a kampányokat és a méréseket, résztvevőt vehetsz fel és hívhatsz meg egy beállított mérésbe, követheted az állapotot, és lekérheted az eredményt úgy, ahogy a Manager látja. A kérdésbank tartalma soha nem jön ki az API-n."},"servers":[{"url":"/api/partner/v1"}],"security":[{"bearer":[]}],"paths":{"/me":{"get":{"summary":"A kulcs és a hozzáférés adatai","description":"A vállalat kódja, a hozzáférési szint (full, read), a kreditegyenleg, a kulcs neve, módja és jogosultságai. Jogosultság: read.","operationId":"me","tags":["read"],"parameters":[],"responses":{"200":{"description":"Sikeres válasz"},"default":{"description":"Hiba: a reason mező géppel olvasható, a message a kérés nyelvén szól.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/campaigns":{"get":{"summary":"Kampányok listája","description":"A vállalat kampányai kóddal, névvel és állapottal. Jogosultság: read.","operationId":"campaigns","tags":["read"],"parameters":[],"responses":{"200":{"description":"Sikeres válasz"},"default":{"description":"Hiba: a reason mező géppel olvasható, a message a kérés nyelvén szól.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/campaigns/{campaign}/measurements":{"get":{"summary":"A kampány méréseinek listája","description":"Mérésenként: kód, állapot, cél (fejlesztési vagy kiválasztási), kezdés, határidő, csatlakozási határidő és a résztvevők száma állapot szerint. Jogosultság: read.","operationId":"measurements","tags":["read"],"parameters":[{"name":"campaign","in":"path","required":true,"schema":{"type":"string"},"description":"A kampány kódja"}],"responses":{"200":{"description":"Sikeres válasz"},"default":{"description":"Hiba: a reason mező géppel olvasható, a message a kérés nyelvén szól.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/measurements/{measurement}":{"get":{"summary":"Egy mérés adatai","description":"Ugyanaz, mint a listában, egy mérésre. Jogosultság: read.","operationId":"measurement","tags":["read"],"parameters":[{"name":"measurement","in":"path","required":true,"schema":{"type":"string"},"description":"A mérés kódja"}],"responses":{"200":{"description":"Sikeres válasz"},"default":{"description":"Hiba: a reason mező géppel olvasható, a message a kérés nyelvén szól.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/measurements/{measurement}/participants":{"get":{"summary":"A mérés résztvevői és állapotuk","description":"Résztvevőnként: azonosító, név, e-mail, egység, állapot (not_started, in_progress, completed, removed), a meghívó állapota, kezdés, befejezés és a személyes határidő. Jogosultság: read.","operationId":"participants","tags":["read"],"parameters":[{"name":"measurement","in":"path","required":true,"schema":{"type":"string"},"description":"A mérés kódja"}],"responses":{"200":{"description":"Sikeres válasz"},"default":{"description":"Hiba: a reason mező géppel olvasható, a message a kérés nyelvén szól.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"summary":"Résztvevő felvétele és meghívása","description":"A résztvevő a vállalat névsorába és a megadott alapmérésbe kerül (vázlatba vagy futó mérésbe, a csatlakozási határidőn belül). Futó mérésnél a meghívó azonnal kimegy (send_invite: false esetén nem), és a válasz a személyes meghívó linket is tartalmazza. A kredit ugyanúgy fogy, mint a Manager felületén: a résztvevő első válaszakor. Jogosultság: invite. Írás: teljes hozzáférés kell (van kredit); teszt kulccsal csak ellenőrzés.","operationId":"invite","tags":["invite"],"parameters":[{"name":"measurement","in":"path","required":true,"schema":{"type":"string"},"description":"A mérés kódja"}],"responses":{"201":{"description":"Sikeres válasz"},"default":{"description":"Hiba: a reason mező géppel olvasható, a message a kérés nyelvén szól.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invite"}}}}}},"/measurements/{measurement}/results":{"get":{"summary":"A mérés eredménye","description":"Kiválasztási mérésnél a hozzájáruló jelöltek készségenkénti szintsávja, betűrendben. Fejlesztési mérésnél csak az összesített eredmény, a mérés 5 fő alatti szabályával. Jogosultság: results.","operationId":"results","tags":["results"],"parameters":[{"name":"measurement","in":"path","required":true,"schema":{"type":"string"},"description":"A mérés kódja"}],"responses":{"200":{"description":"Sikeres válasz"},"default":{"description":"Hiba: a reason mező géppel olvasható, a message a kérés nyelvén szól.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/measurements/{measurement}/report.pdf":{"get":{"summary":"Vezetői összefoglaló (PDF)","description":"Fejlesztési mérésnél ugyanaz a PDF, amit a Manager letölt. Jogosultság: results.","operationId":"report_pdf","tags":["results"],"parameters":[{"name":"measurement","in":"path","required":true,"schema":{"type":"string"},"description":"A mérés kódja"},{"name":"lang","in":"query","required":false,"schema":{"type":"string","enum":["hu-HU","en-GB"]},"description":"A PDF nyelve"}],"responses":{"200":{"description":"Sikeres válasz","content":{"application/pdf":{}}},"default":{"description":"Hiba: a reason mező géppel olvasható, a message a kérés nyelvén szól.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/measurements/{measurement}/participants/{participant}/result":{"get":{"summary":"Egy jelölt eredménye","description":"Csak kiválasztási mérésnél, a hozzájáruló jelöltnél: készségenként a szintsáv neve és magyarázata, ahogy a Manager látja. Jogosultság: results.","operationId":"result","tags":["results"],"parameters":[{"name":"measurement","in":"path","required":true,"schema":{"type":"string"},"description":"A mérés kódja"},{"name":"participant","in":"path","required":true,"schema":{"type":"string"},"description":"A résztvevő azonosítója (participant_id)"}],"responses":{"200":{"description":"Sikeres válasz"},"default":{"description":"Hiba: a reason mező géppel olvasható, a message a kérés nyelvén szól.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/measurements/{measurement}/participants/{participant}/result.pdf":{"get":{"summary":"Egy jelölt riportja (PDF)","description":"Ugyanaz a jelöltriport, amit a Manager letölt. Jogosultság: results.","operationId":"result_pdf","tags":["results"],"parameters":[{"name":"measurement","in":"path","required":true,"schema":{"type":"string"},"description":"A mérés kódja"},{"name":"participant","in":"path","required":true,"schema":{"type":"string"},"description":"A résztvevő azonosítója (participant_id)"},{"name":"lang","in":"query","required":false,"schema":{"type":"string","enum":["hu-HU","en-GB"]},"description":"A PDF nyelve"}],"responses":{"200":{"description":"Sikeres válasz","content":{"application/pdf":{}}},"default":{"description":"Hiba: a reason mező géppel olvasható, a message a kérés nyelvén szól.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/webhook/test":{"post":{"summary":"Minta webhook-esemény küldése","description":"Egy test: true jelölésű, aláírt minta-eseményt küld a beállított webhook címre, és visszaadja a kézbesítés eredményét. Jogosultság: read.","operationId":"webhook_test","tags":["read"],"parameters":[],"responses":{"200":{"description":"Sikeres válasz"},"default":{"description":"Hiba: a reason mező géppel olvasható, a message a kérés nyelvén szól.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Minden híváshoz API-kulcs kell az Authorization: Bearer fejlécben (vagy az X-API-Key fejlécben). A kulcsot a vállalat Managere hozza létre a Beállítások → Partner API lapon; a kulcs csak a létrehozáskor látszik, utána csak az eleje. A kulcs visszavonható."}},"schemas":{"Error":{"type":"object","properties":{"detail":{"type":"object","properties":{"reason":{"type":"string","enum":["unauthorized","scope_missing","api_not_available","read_only","rate_limited","not_found","email_invalid","measurement_not_open","remeasure_add","join_closed","already_participant","other_measurement","individual_not_available","result_not_ready"]},"message":{"type":"string"}}}}},"Invite":{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","description":"A résztvevő e-mail-címe (kötelező)"},"name":{"type":"string","description":"A résztvevő neve"},"unit":{"type":"string","description":"Szervezeti egység"},"labels":{"type":"object","additionalProperties":{"type":"string"},"description":"Legfeljebb öt saját címke (név–érték)"},"locale":{"type":"string","enum":["hu-HU","en-GB"],"description":"A meghívó levél nyelve"},"send_invite":{"type":"boolean","default":true,"description":"Futó mérésnél kimenjen-e azonnal a meghívó (alapból igen)"}}},"WebhookEvent":{"type":"object","properties":{"id":{"type":"string"},"event":{"type":"string","enum":["participant.completed","measurement.closed"]},"created_at":{"type":"string"},"api_version":{"type":"string"},"test":{"type":"boolean"},"data":{"type":"object"}},"description":"A Manager a Beállítások → Partner API lapon ad meg egy https:// címet. Események: participant.completed (egy résztvevő befejezte a mérést) és measurement.closed (a mérés lezárult). Az eseményben csak kódok és időpontok vannak, név és eredmény nincs; az eredményt az API-n kérd le. Sikertelen kézbesítésnél a rendszer növekvő időközönként újrapróbálja (1 perc, 5 perc, 30 perc, 2 óra, 6 óra, 24 óra)."}}},"x-erinvia-rules":["Banki adat soha: nincs kérdés, azonosító, súly vagy nyers válasz.","Összesített pontszám és rangsor nincs: készségenként külön szintsáv; a jelöltek betűrendben.","Fejlesztési mérésnél egyéni eredmény nincs, csak összesített, az 5 fő alatti szabállyal.","Kiválasztási mérésnél csak a hozzájáruló jelölt eredménye kérhető le.","Döntés-támogatás: a döntést a HR hozza."]}