Kapcsolja össze rendszereit a Pulsikával, hogy olvashassa és frissíthesse a munkavállalói adatokat, az egységeket, a szabadságokat, a teljesítményt, a képzéseket és a cég további adatait. Az API JSON-t használ HTTPS-en keresztül, minden rendszerhez külön kulccsal és minden erőforráshoz külön jogosultságokkal.
A cég tulajdonosaként vagy adminisztrátoraként nyissa meg a Hozzáférés → API-kulcsok oldalt, és válassza az „Új kulcs” lehetőséget.
Nevezze el a kulcsot az azt használó rendszerről. Csak a szükséges olvasási vagy írási jogosultságokat adja meg, és ahol lehet, korlátozza a hozzáférést a rendszer IP-címeire.
Másolja ki a kulcsot: csak egyszer jelenik meg. A Pulsika csak egy ujjlenyomatot tárol róla.
Hívja a cég címét a kulccsal az Authorization fejlécben.
A kulcsot az Authorization fejlécben, Bearer tokenként küldje. Egy kulcs csak a saját cége címén működik. Lejárhat, és bármikor felfüggeszthető, újraaktiválható vagy visszavonható; IP-címekre vagy -tartományokra is korlátozható. A módosításokat a kulcsot létrehozó személy nevén rögzíti a rendszer. Ha ez a személy elveszíti az API-kulcsok kezeléséhez szükséges jogosultságot, a kulccsal továbbra is lehet olvasni, de adatot írni már nem.
Authorization: Bearer hq_12_••••••••
Hatókörök
Egy kulcs minden erőforráshoz kaphat olvasási ({resource}:read) és írási ({resource}:write) jogosultságot. Ezek a teljes cég adataira vonatkoznak. Két további hatókör érhető el: a sensitive a bizalmasként megjelölt egyéni mezők olvasásához és írásához, a metrics:write pedig a KPI-értékek üzleti hivatkozások szerinti küldéséhez.
Kérések és válaszok
A kérések és a válaszok UTF-8 kódolású JSON-t használnak. Kéréstörzs küldésekor adja meg a Content-Type: application/json fejlécet.
A dátumokhoz az ÉÉÉÉ-HH-NN (YYYY-MM-DD), az időbélyegekhez az ISO 8601 formátumot használja. A válaszok UTC-ben vannak, például 2026-05-01T08:00:00Z.
Egyetlen rekord {"data": {…}} formában érkezik; egy lista {"data": […], "meta": {page, per_page, total, last_page}, "links": {next, prev}} formában.
Listák: page (1-től), per_page (alapértelmezés szerint 25, legfeljebb 100), sort (id, created_at, updated_at; csökkenő sorrendhez mínuszjel elé), updated_since (egy adott időpont után módosított rekordok, szinkronizáláshoz), valamint az egyes erőforrások szűrői.
Rekordot POST kéréssel hozhat létre, és PATCH kéréssel frissíthet, csak a módosított mezőket küldve. A DELETE 204-et ad vissza. A nem írható mezőket tartalmazó kéréseket a rendszer elutasítja.
Az írási műveletek atomiak: vagy minden módosítás együtt mentésre kerül, vagy egyik sem.
GET https://compania-mea.pulsika.eu/api/v1/employees?status=active&updated_since=2026-05-01T00:00:00Z&page=2
Hibák
A hibák {"error": "<code>", "message": "<text>"} formában érkeznek. Érvénytelen adatok esetén a válasz állapotkódja 422, a részletek pedig az "errors" alatt találhatók minden érintett mezőhöz.
Állapot
Kód
Jelentés
401
invalid_token
A kulcs hiányzik, ismeretlen, vagy egy másik céghez tartozik.
403
token_inactive
A kulcs fel van függesztve, vagy lejárt.
403
not_in_plan
A cég előfizetése nem tartalmazza ezt a fajta kulcsot (automatizálási kulcsok: Professionaltól; a teljes API: Enterprise).
403
insufficient_scope
A kulcsból hiányzik a művelethez szükséges hatókör.
403
ip_not_allowed
A kulcs nem fogad hívásokat erről a címről.
403
token_owner_inactive
A kulcsot létrehozó személy már nem kezelhet kulcsokat, ezért a kulccsal olvasni lehet, írni nem.
404
—
Nincs ilyen erőforrás vagy rekord az Ön cégénél (vagy nem része a csomagjának).
405
—
Az erőforrás nem kínálja ezt a műveletet.
409
in_use
A rekordot máshol még használják, ezért nem törölhető.
422
—
Érvénytelen adatok; semmi sem került mentésre.
429
—
Túl sok kérés; próbálja újra Retry-After másodperc múlva.
Korlátok
A korlát kulcsonként percenként 120 kérés, IP-címenként 300. Túllépés esetén a válasz állapotkódja 429. A Retry-After fejléc megadja, mennyit kell várni az újabb próbálkozás előtt.
Verziók
A jelenlegi verzió az 1-es (/api/v1). Az új erőforrások, mezők és szűrők ebbe a verzióba kerülnek. A nem kompatibilis változások egy új verzióban jelennek meg, amelyet előre bejelentünk.
Személyes adatok
A CNP (román személyi szám) az API-n keresztül nem olvasható és nem írható.
A bizalmas egyéni mezők eléréséhez a sensitive hatókör szükséges.
A névtelen felmérések eredményei csak összesítésként érhetők el. Nem érhetők el, amíg a válaszok le vannak zárva, vagy túl kevés van belőlük ahhoz, hogy a résztvevők névtelensége megmaradjon.
Az API-napló 30 napig őrzi meg a kulcsot, a végpontot, a válasz állapotát és az időtartamot, a kérés és a válasz tartalma nélkül. A legutóbbi hívások a Hozzáférés → API-kulcsok oldalon láthatók.
KPI-értékek küldése
Azok a rendszerek, amelyek csak KPI-értékeket küldenek (eladások, értékelések, darabszámok), azonosítók helyett üzleti hivatkozás alapján is küldhetik őket: POST /api/v1/metrics/{key}/values egy időszakkal és az értékekkel a munkavállalókra (törzsszám szerint), az egységekre vagy az osztályokra (kód szerint). Ehhez a metrics:write hatókör szükséges; a GET /api/v1/metrics felsorolja az értékeket fogadó mutatókat.
Az országok, régiók és körzetek fája, amelyekhez az egységek tartoznak; ez határozza meg a területi vezetők hatáskörét is. A nevek az azonos szülő alatti területek között egyediek. A törlés el lesz utasítva, amíg egységek vagy alterületek használják a területet.
Hatókörök: geo_areas:read, geo_areas:write
Végpontok
GET/api/v1/geo-areasLista
GET/api/v1/geo-areas/{id}Egy rekord
POST/api/v1/geo-areasLétrehozás
PATCH/api/v1/geo-areas/{id}Frissítés
DELETE/api/v1/geo-areas/{id}Törlés
Mezők
Név
Típus
Leírás
id
integercsak olvasható
Azonosító.
name
stringkötelező
Név, az azonos szülőterülethez tartozó területek között egyedi.
level_label
string | null
Ennek a szintnek a megnevezése (ország, régió, körzet).
parent_id
integer | null
A terület, amelyen belül elhelyezkedik; legfelső szintű területnél null. Soha nem önmaga vagy valamelyik saját alterülete.
A cég egységei: üzletek, gyógyszertárak, irodák, szállodák. A törlés el lesz utasítva, amíg személyek, dokumentumok vagy eredmények hivatkoznak az egységre.
Hatókörök: work_units:read, work_units:write
Végpontok
GET/api/v1/work-unitsLista
GET/api/v1/work-units/{id}Egy rekord
POST/api/v1/work-unitsLétrehozás
PATCH/api/v1/work-units/{id}Frissítés
DELETE/api/v1/work-units/{id}Törlés
Mezők
Név
Típus
Leírás
id
integercsak olvasható
Azonosító.
name
stringkötelező
Név, a cégen belül egyedi.
code
string | null
Saját kód, a cégen belül egyedi (a KPI-értékek párosításához).
geo_area_id
integer | null
A földrajzi terület (régió, ország), amelyhez tartozik.
address
string | null
Utca, házszám.
city
string | nullcsak olvasható
Település (romániai egységeknél a hivatalos listából).
county
string | nullcsak olvasható
Megye vagy régió.
phone
string | null
Telefonszám.
email
string | null
E-mail-cím.
opened_on
date | null
Nyitás dátuma.
closed_on
date | null
Bezárás dátuma.
is_active
boolean
Használatban van-e.
custom_fields
object
A cég saját mezői, mezőazonosító szerint (lásd: /custom-fields).
Cégszintű funkciók (Értékesítés, Logisztika…), amelyek egymásba ágyazhatók. A törlés el lesz utasítva, amíg beosztások vagy alosztályok használják az osztályt.
Hatókörök: departments:read, departments:write
Végpontok
GET/api/v1/departmentsLista
GET/api/v1/departments/{id}Egy rekord
POST/api/v1/departmentsLétrehozás
PATCH/api/v1/departments/{id}Frissítés
DELETE/api/v1/departments/{id}Törlés
Mezők
Név
Típus
Leírás
id
integercsak olvasható
Azonosító.
name
stringkötelező
Név, a cégen belül egyedi.
code
string | null
Saját kód, a cégen belül egyedi (a KPI-értékek párosításához).
parent_id
integer | null
Az osztály, amelyhez tartozik; soha nem önmaga vagy valamelyik saját alosztálya.
is_active
boolean
Használatban van-e.
custom_fields
object
A cég saját mezői, mezőazonosító szerint (lásd: /custom-fields).
A mezők, amelyeket a cég a saját rekordjaihoz adott, csak olvasható formában: mit jelent egy rekord custom_fields értékében az egyes azonosító, milyen típusú, és milyen választási lehetőségei vannak. Az érzékeny munkavállalói mezők csak sensitive hatókörű kulcs esetén jelennek meg. A mezőket az alkalmazásban kell meghatározni.
Hatókörök: custom_fields:read
Végpontok
GET/api/v1/custom-fieldsLista
GET/api/v1/custom-fields/{id}Egy rekord
Mezők
Név
Típus
Leírás
id
integercsak olvasható
Azonosító; a kulcs egy rekord custom_fields értékében.
entity
employee | work_unit | department | position | team | companycsak olvasható
A rekord fajtája, amelyhez tartozik.
label
stringcsak olvasható
A neve, a kérés nyelvén (Accept-Language).
type
text | textarea | number | date | boolean | select | multiselect | urlcsak olvasható
Mit tartalmaz: text, textarea, number, date (Y-m-d), boolean, select, multiselect vagy url.
options
array | nullcsak olvasható
A select vagy multiselect választási lehetőségei: id és label; a tárolt érték az id.
is_required
booleancsak olvasható
Kötelező-e értéket megadni.
visibility
reach | sensitivecsak olvasható
reach (mindenki, aki látja a munkavállalót) vagy sensitive.
is_active
booleancsak olvasható
Használatban van-e.
created_at
datetimecsak olvasható
Létrehozva.
updated_at
datetimecsak olvasható
Utolsó módosítás.
Szűrők
entity
employee | work_unit | department | position | team | company
A cég munkavállalói. Létrehozáskor az első beosztásuk is létrejön; a későbbi áthelyezések a /placements végponton keresztül történnek. A személyi azonosítókat (például a román CNP-t) az API soha nem olvassa és nem írja. A felhasználói fiókokat az alkalmazásban kell létrehozni.
Hatókörök: employees:read, employees:write
Végpontok
GET/api/v1/employeesLista
GET/api/v1/employees/{id}Egy rekord
POST/api/v1/employeesLétrehozás
PATCH/api/v1/employees/{id}Frissítés
DELETE/api/v1/employees/{id}Törlés
Mezők
Név
Típus
Leírás
id
integercsak olvasható
Azonosító.
employee_number
string | null
Az Ön által adott törzsszám, a cégen belül egyedi (ez alapján párosítjuk a KPI-értékeket).
first_name
stringkötelező
Utónév.
last_name
stringkötelező
Vezetéknév.
email
string | null
Munkahelyi e-mail-cím.
phone
string | null
Telefonszám.
birth_date
date | null
Születési dátum.
hire_date
date | null
Belépés dátuma (ezen a napon kezdődik az első beosztás).
termination_date
date | null
Kilépés dátuma.
status
active | inactive | terminated
active, inactive vagy terminated.
work_unit_id
integerkötelező
A jelenlegi elsődleges beosztás egysége; létrehozáskor kötelező, utána csak olvasható.
department_id
integer | null
A jelenlegi elsődleges beosztás osztálya (csak létrehozáskor).
position_id
integer | null
A jelenlegi elsődleges beosztás munkaköre (csak létrehozáskor).
has_login
booleancsak olvasható
Be tud-e jelentkezni a személy.
custom_fields
object
A cég saját mezői, mezőazonosító szerint; a bizalmasak csak a sensitive hatókörrel.
created_at
datetimecsak olvasható
Létrehozva.
updated_at
datetimecsak olvasható
Utoljára módosítva.
Szűrők
status
active | inactive | terminated
Csak ezzel az állapottal.
work_unit_id
integer
Jelenleg ebbe az egységbe beosztva.
employee_number
string
Pontos törzsszám.
email
string
Pontos e-mail-cím.
q
string
A név egy része.
hired_since
date
Ettől a naptól (Y-m-d) felvettek: új munkatársak.
leaving_since
date
Ettől a naptól (Y-m-d) távozók: van kilépési dátumuk.
Ki hol dolgozik: egység, osztály és munkakör, mettől meddig. Egy új elsődleges beosztás átveszi az előző helyét, amely jelenlegi másodlagos beosztásként megmarad, amíg le nem zárják.
Hatókörök: placements:read, placements:write
Végpontok
GET/api/v1/placementsLista
GET/api/v1/placements/{id}Egy rekord
POST/api/v1/placementsLétrehozás
DELETE/api/v1/placements/{id}Törlés
POST/api/v1/placements/{id}/endLezárja a beosztást a valid_to napon (a kezdete előtt nem lehet).
POST/api/v1/placements/{id}/make-primaryA személy elsődleges beosztásává teszi; az addigi elsődleges másodlagos lesz.
Mezők
Név
Típus
Leírás
id
integercsak olvasható
Azonosító.
employee_id
integerkötelező
A személy.
work_unit_id
integerkötelező
Az egység.
department_id
integer | null
Az osztály.
position_id
integer | null
A munkakör.
is_primary
boolean
A személy elsődleges beosztása-e.
valid_from
datekötelező
Első nap.
valid_to
date | null
Utolsó nap (üres: még érvényes).
created_at
datetimecsak olvasható
Létrehozva.
updated_at
datetimecsak olvasható
Utoljára módosítva.
Szűrők
employee_id
integer
Csak ennek a személynek a beosztásai.
work_unit_id
integer
Csak ebben az egységben.
current
boolean
true: csak a ma érvényes beosztások.
/api/v1/placements/{id}/end: valid_to (date) — A beosztás utolsó napja (Y-m-d).
Távollétkérelmek, az alkalmazással azonos szabályok szerint: a rendszer megszámolja a munkanapokat, ellenőrzi az egyenleget és az átfedő kérelmeket, és elindítja a cég jóváhagyási folyamatát. A jóváhagyás és az elutasítás a kérelem folyamatát követi: a kulcsot létrehozó személynek az aktuális lépés jóváhagyójának kell lennie.
Minden személy éves egyenlege minden olyan távolléttípusra, amely napokat számol. Egy év lekérdezése minden aktív személynél megnyitja az egyenleget, időarányosan és az áthozott napokkal, ahogyan az alkalmazás is; a felhasznált, a függőben lévő és a rendelkezésre álló napokat a rendszer számolja. Az éves keret, a korrekció és az áthozott napok módosíthatók – a kulcsot létrehozó személy saját egyenlegénél soha.
A cég naptára. A résztvevők (vagy az egység) értesítést kapnak egy új eseményről, új időpontról vagy új helyszínről. Egy új esemény ismétlődhet: minden alkalom egy sorozat önálló eseménye lesz, amely külön módosítható, lemondható vagy törölhető.
Amit a cég mér: az egyes mutatók kulcsa és mértékegysége, hogy kikre vonatkozóan mérik (grain), és milyen gyakran (period). Csak olvasható; a mutatókat az alkalmazásban kell meghatározni. Az API-n keresztül csak olyan mutatókhoz küldhetők értékek, amelyek forrása „api”.
Hatókörök: kpi_metrics:read
Végpontok
GET/api/v1/kpi-metricsLista
GET/api/v1/kpi-metrics/{id}Egy rekord
Mezők
Név
Típus
Leírás
id
integercsak olvasható
Azonosító.
key
stringcsak olvasható
A mutató kulcsa, amelyet a képletek és az értékek küldése használ.
Egy mutató értéke egy alanyra egy időszakban. Létrehozáskor a rendszer beírja (vagy lecseréli az adott alanyra és időszakra már meglévő értéket); csak az „api” forrású mutatók fogadnak értékeket. A hiányzó érték (null) azt jelenti: „nincs adat”, soha nem nullát. Sok érték üzleti hivatkozás (törzsszám, egységkód) szerinti küldéséhez használja a POST /metrics/{key}/values végpontot.
A KPI-értékelőlapok és minden változatuk (piszkozat, közzétett, archivált): az összetevők, amelyekből a pontszám áll, a súlyozásuk és a szintek, amelyekbe egy pontszám eshet. Csak olvasható; a KPI-értékelőlapokat az alkalmazásban kell összeállítani, és egy közzétett változat soha nem változik.
Hatókörök: kpi_scorecards:read
Végpontok
GET/api/v1/kpi-scorecardsLista
GET/api/v1/kpi-scorecards/{id}Egy rekord
Mezők
Név
Típus
Leírás
id
integercsak olvasható
Ennek a változatnak az azonosítója.
family
stringcsak olvasható
A KPI-értékelőlap az összes változatán át.
version
integercsak olvasható
Változatszám.
name
stringcsak olvasható
Név.
description
string | nullcsak olvasható
Leírás.
grain
employee | team | department | work_unit | geo_area | companycsak olvasható
Kit értékel.
period
day | week | month | quarter | yearcsak olvasható
Milyen gyakran értékel.
status
draft | published | archivedcsak olvasható
draft, published vagy archived.
effective_from
date | nullcsak olvasható
Érvényesség kezdete.
effective_to
date | nullcsak olvasható
Érvényesség vége.
published_at
datetime | nullcsak olvasható
Mikor tették közzé ezt a változatot.
components
arraycsak olvasható
Az összetevői: kulcs, címke, súlyozás (0–1), célérték, megjelenítési formátum, és hogy a munkavállaló látja-e.
levels
arraycsak olvasható
A szintjei: név, a szint eléréséhez szükséges legkisebb pontszám, szín.
A KPI-értékelőlapok pontszámai: minden alany és időszak aktuális eredménye, az elért szint, valamint az egyes összetevők értéke és pontjai. Az adat nélküli összesítés vagy összetevő null, soha nem nulla. Csak olvasható; az eredmények egy időszak lezárásakor jönnek létre.
Hatókörök: kpi_results:read
Végpontok
GET/api/v1/kpi-resultsLista
GET/api/v1/kpi-results/{id}Egy rekord
Mezők
Név
Típus
Leírás
id
integercsak olvasható
Azonosító.
scorecard_id
integercsak olvasható
A KPI-értékelőlap változata, amely értékelte.
scorecard
stringcsak olvasható
A neve.
subject_type
employee | team | department | work_unit | geo_area | companycsak olvasható
Az alany fajtája.
subject_id
integercsak olvasható
Az alany azonosítója.
subject
string | nullcsak olvasható
Az alany neve.
period
datecsak olvasható
Az időszak első napja.
total
string | nullcsak olvasható
A pontszám tizedes karakterláncként; null, ha nincs adat.
level
string | nullcsak olvasható
Az elért szint.
level_color
string | nullcsak olvasható
A szint színe.
bonus
string | nullcsak olvasható
A bónusz, ha a KPI-értékelőlap számol ilyet.
parts
arraycsak olvasható
Minden összetevő: kulcs, címke, érték és az általa hozott pontok (tizedes karakterláncok; nincs adat esetén null).
created_at
datetimecsak olvasható
Mikor számolták ki.
Szűrők
scorecard_id
integer
Csak ez a KPI-értékelőlap-változat.
period
date
Az időszak első napja (Y-m-d).
subject_type
employee | team | department | work_unit | geo_area | company
Merre tart egy időszakban a cég, egy terület, egy egység, egy osztály vagy egy munkatárs, és mely kulcseredmények mérik ezt, mindegyik állásával (haladás százalékban, és hol kellene tartania ma). Csak olvasás, valamint a move művelet a kézzel követett kulcseredményekhez; a KPI-mutatót olvasó kulcseredmény az adataival együtt mozdul. A piszkozatok nem jelennek meg.
Hatókörök: priorities:read, priorities:write
Végpontok
GET/api/v1/prioritiesLista
GET/api/v1/priorities/{id}Egy rekord
POST/api/v1/priorities/{id}/moveKézzel követett kulcseredmény mozgatása: új érték egy számnál, elérve vagy sem egy lépésnél, nem kötelező megjegyzéssel.
Mezők
Név
Típus
Leírás
id
integercsak olvasható
Azonosító.
parent_id
integer | nullcsak olvasható
A prioritás, amelyhez igazodik.
level
company | geo_area | work_unit | department | personcsak olvasható
company, geo_area, work_unit, department vagy person.
subject_id
integercsak olvasható
Kinek szól: a terület, az egység, az osztály vagy a munkatárs (0 a cégnél).
owner_id
integer | nullcsak olvasható
A felelős fiók.
title
stringcsak olvasható
Mit kell elérni.
description
text | nullcsak olvasható
Miért fontos.
period_type
month | quarter | yearcsak olvasható
month, quarter vagy year.
period_start
datecsak olvasható
Az időszak első napja.
period_end
datecsak olvasható
Utolsó nap.
status
active | closed | cancelledcsak olvasható
active, closed vagy cancelled.
progress
number | nullcsak olvasható
Az állás százalékban (null = még nincs adat).
expected
numbercsak olvasható
Hol kellene tartania ma, százalékban.
key_results
arraycsak olvasható
Minden kulcseredmény: típus (manual, milestone, metric), cím, mértékegység, kiinduló és célérték, jelenlegi érték, haladás és az olvasott KPI-mutató.
created_at
datetimecsak olvasható
Létrehozva.
updated_at
datetimecsak olvasható
Utoljára módosítva.
Szűrők
level
company | geo_area | work_unit | department | person
Csak ez a szint.
status
active | closed | cancelled
Csak ez az állapot.
on
date
Csak az ezen a napon futó prioritások (Y-m-d).
/api/v1/priorities/{id}/move: key_result_id (integer) — A prioritás kulcseredménye.; value (number) — Az új érték (számos kulcseredmény).; done (boolean) — Elérve vagy sem (egy lépés).; note (string) — Miért mozdult.
Egy szabályhoz tartozó célok (például „kiemelt termékek”): az időszakuk, a paramétereik és az egységenkénti célértékek. A szabály és az időszak a létrehozás után nem változtatható. A record művelet rögzíti, mit értek el a személyek vagy az egységek; az értékelés az időszak értékelésekor történik. Egy már értékelt cél nem törölhető.
Hatókörök: objectives:read, objectives:write
Végpontok
GET/api/v1/objectivesLista
GET/api/v1/objectives/{id}Egy rekord
POST/api/v1/objectivesLétrehozás
PATCH/api/v1/objectives/{id}Frissítés
DELETE/api/v1/objectives/{id}Törlés
POST/api/v1/objectives/{id}/recordRögzíti, mit értek el az alanyok: a mérőszámaik felülírják a korábban rögzítetteket; az üres mérőszámok törlik azt (ismét nincs adat).
Mezők
Név
Típus
Leírás
id
integercsak olvasható
Azonosító.
rule_id
integerkötelező
A szabály, amely értékeli (csak létrehozáskor).
rule
stringcsak olvasható
A szabály neve.
name
stringkötelező
Név.
description
text | null
Leírás.
period
stringkötelező
Az időszak kulcsa a szabály időszakában (csak létrehozáskor), például 2026-09.
period_start
datecsak olvasható
Első nap.
period_end
datecsak olvasható
Utolsó nap.
params
object
A szabály paramétereinek értékei, név szerint (a többit figyelmen kívül hagyja); ha elhagyja: a szabály alapértékei.
targets
array
Egységenkénti célértékek: {work_unit_id, target} elemek listája. Ha vannak célértékek, a cél csak ezekre az egységekre vonatkozik.
external_ref
string | null
Az Ön saját hivatkozása (csak létrehozáskor).
created_at
datetimecsak olvasható
Létrehozva.
updated_at
datetimecsak olvasható
Utoljára módosítva.
Szűrők
rule_id
integer
Csak ehhez a szabályhoz tartozók.
period_start
date
Az időszak első napja (Y-m-d).
external_ref
string
Az Ön pontos hivatkozása.
/api/v1/objectives/{id}/record: achievements (array) — {subject_id, measures: {mérőszám neve: szám}} elemek listája; az alanyok a szabály szintjén, a célértékkel rendelkező egységekben.
Az értékelési szempontrendszerek alapján adott értékelések: kit, ki, melyik időszakra értékelt, a pontok és az eredmény, valamint az egyes szempontokra adott válaszok. Csak olvasható; az értékeléseket az alkalmazásban kell elvégezni. A piszkozatok az értékelő folyamatban lévő munkái, és soha nem jelennek meg a listában.
Hatókörök: reviews:read
Végpontok
GET/api/v1/reviewsLista
GET/api/v1/reviews/{id}Egy rekord
Mezők
Név
Típus
Leírás
id
integercsak olvasható
Azonosító.
form_id
integercsak olvasható
A szempontrendszer változata.
form
stringcsak olvasható
A szempontrendszer neve.
employee_id
integercsak olvasható
Az értékelt személy.
evaluator_id
integer | nullcsak olvasható
Az értékelő felhasználói fiókja.
period_start
datecsak olvasható
Az időszak első napja.
period_end
datecsak olvasható
Utolsó nap.
status
submitted | cancelledcsak olvasható
submitted vagy cancelled.
total_points
string | nullcsak olvasható
Elért pontok.
max_points
string | nullcsak olvasható
Elérhető pontok.
result
string | nullcsak olvasható
Az eredmény (pontok, vagy százalék, ha a szempontrendszer azt ad).
comment
text | nullcsak olvasható
Az értékelő megjegyzése, egyszerű szövegként.
submitted_at
datetime | nullcsak olvasható
Mikor nyújtották be.
cancelled_at
datetime | nullcsak olvasható
Mikor vonták vissza.
answers
arraycsak olvasható
Minden szempont: kulcs, a választott lehetőségek, egy érték, a pontjai és egy megjegyzés.
A vállalat elindított versenyei (a piszkozatok nem jelennek meg): mit mérünk, ki versenyez, mely időszakokon és hogyan lehet nyerni. Csak olvasható — a versenyeket az alkalmazásban hozzák létre és vezetik.
A jóváhagyott eredmények, résztvevőnként egy — a jóváhagyás után nem változnak. A NULL azt jelenti: nincs adat, sosem nulla. Egy személy eredményét API-n keresztüli olvasásként naplózzuk.
Hatókörök: contest_results:read
Végpontok
GET/api/v1/contest-resultsLista
GET/api/v1/contest-results/{id}Egy rekord
Mezők
Név
Típus
Leírás
id
integercsak olvasható
Azonosító.
contest_id
integercsak olvasható
A verseny.
subject_type
employee | team | work_unit | department | geo_areacsak olvasható
employee, team, work_unit, department vagy geo_area.
subject_id
integer | nullcsak olvasható
A résztvevő (anonimizálás után üres).
value
number | nullcsak olvasható
A szempont értéke a versenyben.
baseline
number | nullcsak olvasható
A korábbi időszakok átlaga (fejlődési versenyek).
measure
number | nullcsak olvasható
Mit vetettünk össze: az értéket vagy a fejlődést.
place
integer | nullcsak olvasható
A helyezés (holtverseny esetén közös).
tier_key
string | nullcsak olvasható
Az elért szint (szintes versenyek).
wins
booleancsak olvasható
Nyert-e.
eligible
booleancsak olvasható
Jogosult volt-e.
ineligible_reason
string | nullcsak olvasható
Miért nem: excluded, inactive, not_placed, not_present, not_employed_long_enough, no_data vagy no_baseline.
A megnyert nyeremények, címzettenként egy. Egy bónusz összege csak a sensitive hatókörrel; adóról semmi. A deliver művelet átadottként jelöli a nyereményt, a kulcs létrehozójának nevében (akinek az alkalmazásban át kell tudnia adni nyereményeket).
Amit a versenyek kioszthatnak: termékek, utalványok, bónuszok, szabadnapok, élmények vagy csak elismerés. Minden típus csak azt tartja meg, amit használ (a bónusz értéke az összege; az elismerésnek nincs értéke és készlete). A kulcs létrehozójának nevében íródik, akinek az alkalmazásban kezelnie kell a nyereményeket.
A tanfolyamkatalógus. A cím és a leírás a cég nyelvén készül (a többi nyelvre az alkalmazásban fordítható); a fejezetek és a borítóképek az alkalmazásban készülnek. Egy tanfolyam csak addig törölhető, amíg még senkinek sem osztották ki – egyébként archiválja.
Hatókörök: courses:read, courses:write
Végpontok
GET/api/v1/coursesLista
GET/api/v1/courses/{id}Egy rekord
POST/api/v1/coursesLétrehozás
PATCH/api/v1/courses/{id}Frissítés
DELETE/api/v1/courses/{id}Törlés
Mezők
Név
Típus
Leírás
id
integercsak olvasható
Azonosító.
title
stringkötelező
Cím.
description
text | null
Rövid leírás, egyszerű szöveg.
category_id
integer | null
Kategória.
category
string | nullcsak olvasható
A kategória neve.
author
string | null
Szerző.
status
draft | published | archivedkötelező
draft, published vagy archived; csak közzétett tanfolyam osztható ki.
estimated_minutes
integer | null
Becsült időtartam percben.
validity_months
integer | null
Hány hónapig érvényes a tanúsítvány; üres: nem jár le.
issues_certificate
boolean
Kiállít-e tanúsítványt a teljesítéskor.
recertifies
boolean
Újra beiratkoztatja-e a személyeket a tanúsítvány lejárta előtt.
points
integerkötelező
A teljesítésért járó pontok.
chapters_count
integercsak olvasható
Fejezetek száma.
created_at
datetimecsak olvasható
Létrehozva.
updated_at
datetimecsak olvasható
Utoljára módosítva.
Szűrők
status
draft | published | archived
Csak ezzel az állapottal.
category_id
integer
Csak ebben a kategóriában.
q
string
A cím egy része.
Példakérés
POST https://compania-mea.pulsika.eu/api/v1/courses
{
"title": "Siguranța la incendiu",
"status": "published",
"estimated_minutes": 20,
"validity_months": 12,
"issues_certificate": true,
"recertifies": false,
"points": 10
}
Egy közzétett tanfolyam (vagy önálló teszt), amelyet személyeknek osztanak ki: mindenkinek, egy egységnek, egy területnek, egy osztálynak, egy munkakörnek vagy megnevezett munkavállalóknak. A személyek beiratkozása azonnal megtörténik. Csak addig törölhető, amíg senki sem kezdte el.
Ki melyik tanfolyamra vagy tesztre van beiratkozva, és meddig jutott. Műveletek: későbbi határidő, még egy próbálkozás, felmentés valakinek, aki még nem kezdte el.
Ellenőrzési intézkedési tervek /audit-action-plans
Ellenőrzések után előírt javító intézkedések. Ugyanúgy haladnak, mint az ellenőrzés oldalán: megjegyzéssel elvégzettnek jelölik, igazolják, indoklással újranyitják vagy visszavonják őket.
Engedélyek, szerződések és szabályzatok, a lejáratukkal. Az API egy dokumentum adatait, valamint aktuális fájljának nevét, méretét és típusát olvassa; magát a fájlt az alkalmazásban lehet letölteni. A fájlt {"name", "content_base64"} formában kell küldeni (ugyanazok a típusok, mint az alkalmazásban – PDF, Office, képek, ZIP –, legfeljebb 50 MB); ha egy meglévő dokumentumhoz fájlt küld, új verzió jön létre. A törlés a lomtárba helyezi a dokumentumot, ahonnan az alkalmazásban visszaállítható.
Hatókörök: documents:read, documents:write
Végpontok
GET/api/v1/documentsLista
GET/api/v1/documents/{id}Egy rekord
POST/api/v1/documentsLétrehozás
PATCH/api/v1/documents/{id}Frissítés
DELETE/api/v1/documents/{id}Törlés
Mezők
Név
Típus
Leírás
id
integercsak olvasható
Azonosító.
title
stringkötelező
Cím.
description
text | null
Leírás.
category_id
integer | null
Kategória (lásd /document-categories).
work_unit_id
integer | null
Az egység, amelyhez tartozik; céges dokumentumnál üres. Csak létrehozáskor adható meg.
is_internal
boolean
Csak a dokumentumokat kezelők látják.
expires_on
date | null
Lejárati dátum.
expiry_state
valid | expiring | expired | nullcsak olvasható
valid, expiring vagy expired (lejárati dátum nélkül üres).
repeat_months
integer | null
Ennyi havonta megújítandó.
alert_days
array | null
Hány nappal a lejárat előtt mennek ki emlékeztetők (legfeljebb 6).
versions
integercsak olvasható
Hány verziója van a fájlnak.
file_name
string | nullcsak olvasható
Az aktuális fájl neve.
file_size
integer | nullcsak olvasható
A mérete bájtban.
file_mime
string | nullcsak olvasható
A típusa.
file
filekötelező
A fájl: {"name": "…", "content_base64": "…"}. Létrehozáskor kötelező; módosításkor új verziót ad hozzá.
version_note
string | null
Megjegyzés a fájl verziójához (megjelenítve: az aktuális verzióé).
created_at
datetimecsak olvasható
Létrehozva.
updated_at
datetimecsak olvasható
Utoljára módosítva.
Szűrők
work_unit_id
integer
Csak ennek az egységnek a dokumentumai.
category_id
integer
Csak ez a kategória.
company
boolean
true: csak céges dokumentumok; false: csak egységdokumentumok.
Igénylések valaminek a javítására vagy biztosítására egy egységben, az előzményeikkel. A requested_by mezőben megadott személy nevében nyújtjuk be (akinek az adott egységre igénylést kell tudnia benyújtani), vagy a kulcs létrehozójának nevében; a kategória jóváhagyási folyamata érvényes. A move művelettel léptethető tovább, ahogyan a kulcs létrehozója a képernyőn teheti.
POST/api/v1/service-requests/{id}/moveAz igénylést másik állapotba helyezi (in_progress, resolved, unresolved, open, cancelled), ahogyan a kulcs létrehozója teheti. A megoldatlanként lezáráshoz és az újranyitáshoz megjegyzés szükséges.
Mezők
Név
Típus
Leírás
id
integercsak olvasható
Azonosító.
category_id
integerkötelező
Kategória (lásd /service-categories).
work_unit_id
integerkötelező
Az egység, amelyre vonatkozik.
title
stringkötelező
Rövid cím.
description
textkötelező
Mi a hiba, vagy mire van szükség.
requested_by
integer
A felhasználó, akinek a nevében benyújtják (a cég egy személye); ha elmarad, a kulcs létrehozója.
/api/v1/service-requests/{id}/move: status (awaiting_approval | open | in_progress | resolved | unresolved | rejected | cancelled) — Az új állapot.; comment (text) — Indoklás (unresolved esetén és újranyitáskor kötelező).
Példakérés
POST https://compania-mea.pulsika.eu/api/v1/service-requests
{
"category_id": 2,
"work_unit_id": 12,
"title": "Frigiderul de vaccinuri nu mai răcește",
"description": "text",
"requested_by": 17
}
Anyagigénylések a tételeikkel. A requested_by mezőben megadott személy (vagy a kulcs létrehozója) nevében nyújtjuk be, aktív anyagra és olyan egységre, amelyre igényelhet; ezután elvállalható, teljesíthető (ez levonja a készletet) vagy visszavonható, ahogyan a kulcs létrehozója a képernyőn teheti.
Közzétett és lezárt felmérések a kérdéseikkel, az eredményeik pedig csak összesítve: hányan választották az egyes válaszokat, egy skála átlaga, és hányan válaszoltak egy szabad szöveges kérdésre – azt soha, hogy mit írtak. Egy névtelen felmérés eredményei rejtve maradnak, amíg a válaszai lepecsételtek, és amíg 5-nél kevesebb válasz érkezett.
Hatókörök: surveys:read
Végpontok
GET/api/v1/surveysLista
GET/api/v1/surveys/{id}Egy rekord
Mezők
Név
Típus
Leírás
id
integercsak olvasható
Azonosító.
title
stringcsak olvasható
Cím.
description
text | nullcsak olvasható
Leírás.
is_anonymous
booleancsak olvasható
Névtelenek-e a válaszok.
is_mandatory
booleancsak olvasható
Kötelező-e a kitöltés.
status
published | closedcsak olvasható
published vagy closed.
opens_at
datetime | nullcsak olvasható
Mikor nyílik meg.
closes_at
datetime | nullcsak olvasható
Mikor zárul.
published_at
datetime | nullcsak olvasható
Mikor tették közzé.
series_id
integer | nullcsak olvasható
A kérdőívsorozat, amelynek kiadása; egyszeri kérdőívnél üres.
edition
integer | nullcsak olvasható
A kiadás sorszáma a sorozatban.
questions
arraycsak olvasható
A kérdések: id, type (single, multiple, scale, text), text, required, options.
results
objectcsak olvasható
Összesítések: hidden, sealed, responses, assigned, completed, valamint kérdésenként hányan válaszoltak, a válaszlehetőségenkénti vagy skálaértékenkénti darabszám és az átlag.
Névvel kitöltött felmérések válaszai, személyenként egy kitöltés a válaszaival. Egy névtelen felmérés válaszait soha nem adjuk ki egyenként – csak az összesítéseit, a /surveys végponton.
Hatókörök: survey_responses:read
Végpontok
GET/api/v1/survey-responsesLista
GET/api/v1/survey-responses/{id}Egy rekord
Mezők
Név
Típus
Leírás
id
stringcsak olvasható
Azonosító (UUID).
survey_id
integercsak olvasható
A felmérés.
employee_id
integercsak olvasható
Ki válaszolt.
submitted_at
datetime | nullcsak olvasható
Mikor.
answers
arraycsak olvasható
A válaszok: kérdés, választott lehetőség, érték (skála) vagy szöveg.
Az egész cégnek szóló (nem csoportban lévő), közzétett közösségi bejegyzések. A kulcs létrehozója hozza létre: bejegyzést, illetve hírt, közleményt, promóciót vagy versenyt, ha jogosult közleményeket kiadni; a szöveg egyszerű szöveg, a bekezdések között üres sorral.
Hatókörök: posts:read, posts:write
Végpontok
GET/api/v1/postsLista
GET/api/v1/posts/{id}Egy rekord
POST/api/v1/postsLétrehozás
Mezők
Név
Típus
Leírás
id
integercsak olvasható
Azonosító.
type
post | news | announcement | promotion | contestkötelező
post, news, announcement, promotion vagy contest.
title
string | null
Cím (nem kötelező).
body
textkötelező
A szöveg (olvasáskor egyszerű szövegként).
author
string | nullcsak olvasható
Ki írta.
comments_enabled
boolean
Lehet-e hozzászólni.
comments_count
integercsak olvasható
Hány hozzászólás van.
published_at
datetime | null
Mikor jelenik meg; egy jövőbeli időpont ütemezi.
created_at
datetimecsak olvasható
Létrehozva.
updated_at
datetimecsak olvasható
Utoljára módosítva.
Szűrők
type
post | news | announcement | promotion | contest
Csak ez a típus.
Példakérés
POST https://compania-mea.pulsika.eu/api/v1/posts
{
"type": "announcement",
"title": "Program de sărbători",
"body": "Între 24 și 26 decembrie programul este 9–14.",
"comments_enabled": true
}
Példaválasz
{
"data": {
"id": 120,
"type": "announcement",
"title": "Program de sărbători",
"body": "Între 24 și 26 decembrie programul este 9–14.",
"author": "Maria Matei",
"comments_enabled": true,
"comments_count": 3,
"published_at": "2026-05-01T08:00:00Z",
"created_at": "2026-05-01T08:00:00Z",
"updated_at": "2026-05-01T08:00:00Z"
}
}
Tudásbázis-cikkek /knowledge-articles
A tudásbázis közzétett cikkei (eljárások, útmutatók), a szöveggel egyszerű szövegként, a kért nyelven (Accept-Language) vagy a cég nyelvén.
Azok a személyek, akiket a cég kiszolgál – ügyfelek és érdeklődők. Egy e-mail-cím a cégen belül egyedi (egy második azonos címet elutasítunk). A marketinghozzájárulás soha nem íródik a rekorddal együtt: csak a consent műveleten keresztül változik, amely megőrzi az előzményeit (megadva vagy visszavonva, hogyan, mikor, ki által). Az erase művelet a személy kérésére törli az adatait, és nem vonható vissza: a név, az e-mail-cím, a telefonszám, a megjegyzések és mindaz, amit róla írtak, törlődik, a számadatok (vásárlások, üzleti lehetőségek értéke, pontszámok) megmaradnak, és a rekord többé nem módosítható.
Hatókörök: crm_contacts:read, crm_contacts:write
Végpontok
GET/api/v1/crm-contactsLista
GET/api/v1/crm-contacts/{id}Egy rekord
POST/api/v1/crm-contactsLétrehozás
PATCH/api/v1/crm-contacts/{id}Frissítés
DELETE/api/v1/crm-contacts/{id}Törlés
POST/api/v1/crm-contacts/{id}/consentRögzíti, hogy a személy megadta vagy visszavonta a marketinghozzájárulását, és hogyan.
POST/api/v1/crm-contacts/{id}/eraseTörli a személy adatait a kérésére (GDPR). Nem vonható vissza.
Mezők
Név
Típus
Leírás
id
integercsak olvasható
Azonosító.
first_name
string | null
Utónév.
last_name
string | null
Vezetéknév.
email
string | null
E-mail-cím (a cégen belül egyedi, kisbetűvel tárolva).
phone
string | null
Telefonszám, ahogyan megadták.
account_id
integer | null
Az ügyfélcég, amelyhez tartozik (lásd /crm-accounts).
job_title
string | null
A szerepe ott.
city
string | null
Település.
country
string | null
Ország, kétbetűs ISO-kóddal.
locale
string | null
A nyelv, amelyen megszólítjuk (ro, en…).
status
lead | customer | inactive
lead, customer vagy inactive. Egy vásárlás vagy egy megnyert üzleti lehetőség az érdeklődőt ügyféllé teszi.
A cégek és intézmények, amelyeknek a vállalkozás értékesít. A név a cégen belül egyedi. Törléskor a kapcsolattartói és üzleti lehetőségei megmaradnak, a kapcsolat nélkül.
Hatókörök: crm_accounts:read, crm_accounts:write
Végpontok
GET/api/v1/crm-accountsLista
GET/api/v1/crm-accounts/{id}Egy rekord
POST/api/v1/crm-accountsLétrehozás
PATCH/api/v1/crm-accounts/{id}Frissítés
DELETE/api/v1/crm-accounts/{id}Törlés
Mezők
Név
Típus
Leírás
id
integercsak olvasható
Azonosító.
name
stringkötelező
Név (a cégen belül egyedi).
registration_number
string | null
Cégjegyzékszám.
vat_number
string | null
Adószám.
industry
string | null
Iparág.
email
string | null
E-mail-cím.
phone
string | null
Telefonszám.
website
string | null
Weboldal.
address
string | null
Cím.
city
string | null
Település.
country
string | null
Ország, kétbetűs ISO-kóddal.
work_unit_id
integer | null
Az egység (üzlet, szálloda, iroda), amely kiszolgálja; üres, ha nincs.
owner_id
integer | null
A felelős felhasználó; ha létrehozáskor elmarad, a kulcs létrehozója.
A pipeline-ok, amelyeken az üzleti lehetőségek végighaladnak, a szakaszaikkal (az alkalmazásban beállítva). Minden cégnek van egy alapértelmezett pipeline-ja. Egy szakasz nyitott (azzal az eséllyel, hogy az ott lévő üzleti lehetőség megnyerhető), vagy megnyertként, illetve elvesztettként lezárja az üzleti lehetőséget.
Hatókörök: crm_pipelines:read
Végpontok
GET/api/v1/crm-pipelinesLista
GET/api/v1/crm-pipelines/{id}Egy rekord
Mezők
Név
Típus
Leírás
id
integercsak olvasható
Azonosító.
name
stringcsak olvasható
Név.
is_default
booleancsak olvasható
Ide kerülnek-e az új üzleti lehetőségek, ha nincs megadva pipeline.
sort
integercsak olvasható
Hely a listákban.
stages
arraycsak olvasható
A szakaszai sorrendben: id, name, kind (open, won vagy lost), probability (0–100) és sort.
Értékesítések, foglalások vagy szerződések, amelyek egy pipeline-on haladnak végig. A pipeline és a szakasz létrehozáskor választható (ha elmarad, az alapértelmezett pipeline első nyitott szakasza); utána az üzleti lehetőség csak a move, win, lose és reopen műveletekkel vált szakaszt. Az állapota mindig a szakaszát követi, a closed_at pedig megnyeréskor vagy elvesztéskor kap értéket. Egy üzleti lehetőség megnyerése a kapcsolattartóját ügyféllé teszi.
Hatókörök: crm_deals:read, crm_deals:write
Végpontok
GET/api/v1/crm-dealsLista
GET/api/v1/crm-deals/{id}Egy rekord
POST/api/v1/crm-dealsLétrehozás
PATCH/api/v1/crm-deals/{id}Frissítés
DELETE/api/v1/crm-deals/{id}Törlés
POST/api/v1/crm-deals/{id}/moveAz üzleti lehetőséget másik szakaszba helyezi (a saját pipeline-jában vagy egy másikban – ekkor az üzleti lehetőség is átkerül).
POST/api/v1/crm-deals/{id}/winMegnyertként jelöli az üzleti lehetőséget (a pipeline megnyert szakasza).
POST/api/v1/crm-deals/{id}/loseElvesztettként jelöli az üzleti lehetőséget (a pipeline elvesztett szakasza), az okával.
POST/api/v1/crm-deals/{id}/reopenEgy lezárt üzleti lehetőséget visszavisz a pipeline utolsó nyitott szakaszába.
Mezők
Név
Típus
Leírás
id
integercsak olvasható
Azonosító.
title
stringkötelező
Mit értékesítenek.
pipeline_id
integer
A pipeline (lásd /crm-pipelines). Csak létrehozáskor adható meg.
stage_id
integer
A szakasz. Csak létrehozáskor adható meg; utána a műveletekkel.
status
open | won | lostcsak olvasható
open, won vagy lost – a szakasza típusa.
contact_id
integer | null
Az ügyfél (lásd /crm-contacts).
account_id
integer | null
Az ügyfélcég (lásd /crm-accounts).
value
number | null
Az értéke.
currency
string
Az érték pénzneme (ISO-kód); ha elmarad, a cég CRM-pénzneme.
Ami az ügyfelekkel történt vagy történni fog: hívás, megbeszélés, látogatás, e-mail, megjegyzés, feladat és vásárlás. Egy feladat a teljesítéséig várakozik; minden más a rögzítéskor elvégzettnek számít (a done_at időpontban, ha meg van adva). Egy vásárláshoz meg kell adni az összegét, és a kapcsolattartóját ügyféllé teszi. Egy üzleti lehetőséghez tartozó tevékenység átveszi az üzleti lehetőség ügyfelét, ügyfélcégét és egységét, ha ezek nincsenek megadva.
Amit az ügyfelek mondtak: visszajelzések (0–10-es pontszám – mennyire valószínű, hogy ajánlanák a vállalkozást – és/vagy megjegyzés) és panaszok. Egy visszajelzéshez pontszám vagy megjegyzés szükséges. Egy panasz nyitott marad, amíg meg nem oldják, rögzítve, mi történt; újra megnyitható. A típus létrehozáskor dől el.
Hatókörök: crm_feedback:read, crm_feedback:write
Végpontok
GET/api/v1/crm-feedbackLista
GET/api/v1/crm-feedback/{id}Egy rekord
POST/api/v1/crm-feedbackLétrehozás
PATCH/api/v1/crm-feedback/{id}Frissítés
DELETE/api/v1/crm-feedback/{id}Törlés
POST/api/v1/crm-feedback/{id}/resolveMegold egy panaszt, megadva, mi történt.
POST/api/v1/crm-feedback/{id}/reopenÚjra megnyit egy megoldott panaszt.
Mezők
Név
Típus
Leírás
id
integercsak olvasható
Azonosító.
kind
feedback | complaintkötelező
feedback vagy complaint. Csak létrehozáskor adható meg.
A gyártók és márkák, amelyek kampányai a cég bemutatófelületeire és polcaira kerülnek: egy lista mindkét modulhoz. A név a cégen belül egyedi. Az íráshoz a kulcs létrehozójának „Partnerek kezelése” jogosultsággal kell rendelkeznie.
Üzletterek: a cég sok egységében előforduló zónafajták (kattanókeret, pultdisplay, totem) a szokásos méreteikkel és kapacitásukkal. A havi díjat csak az írhatja, aki látja a pénzügyi adatokat.
Üzletterek: az egyes egységek zónái (hol, mekkora, oldalanként mennyi fér el), csak azokban az egységekben, amelyek elrendezését a kulcs létrehozója kezeli. Egy zóna az egységében marad. Egy típus új zónája a hiányzó adatokhoz a típus méreteit veszi át. Ha kevesebb oldalt vagy helyet adna meg, mint amennyit a futó kampányai igényelnek, a kérés elutasításra kerül; kampányokat tartalmazó zóna nem törölhető.
Hatókörök: space_zones:read, space_zones:write
Végpontok
GET/api/v1/space-zonesLista
GET/api/v1/space-zones/{id}Egy rekord
POST/api/v1/space-zonesLétrehozás
PATCH/api/v1/space-zones/{id}Frissítés
DELETE/api/v1/space-zones/{id}Törlés
Mezők
Név
Típus
Leírás
id
integercsak olvasható
Azonosító.
work_unit_id
integerkötelező
Az egység – csak létrehozáskor.
zone_type_id
integer | null
A zónatípus (lásd /space-zone-types), ha van.
name
stringkötelező
Név (pl. „Totem az ajtótól jobbra”).
description
text | null
Leírás.
width_cm
number | null
Szélesség, centiméterben.
height_cm
number | null
Magasság, centiméterben.
depth_cm
number | null
Mélység, centiméterben.
area_m2
number | null
Terület, négyzetméterben.
faces
integer
Oldalak száma (1 vagy 2).
capacity
integer
Hány darab fér el egy oldalon.
capacity_label
string | null
Mit számol a kapacitás.
is_display
boolean
Bemutatófelület-e.
monthly_price
number | null
Havi díj (csak az írhatja, aki látja a pénzügyi adatokat).
status
active | unavailable
active vagy unavailable (átmenetileg).
pin_x
number | nullcsak olvasható
Hely az egység vázlatán, százalékban balról (az alkalmazásban helyezik el).
Polcfelületek: a berendezések fajtái (gondola, gondolavég, hűtő) a díjtáblázattal – facingenként vagy polcméterenként, havonta. A díjakat csak a polcárakra vonatkozó jogosultsággal rendelkezők írhatják.
Polcfelületek: egyszer leírt planogramok – a berendezés, a méretek, a polcok fentről lefelé, azzal, hogy mi fér el mindegyiken (facingek vagy centiméterek), és az árszorzójukkal. A polcok elküldése lecseréli a polcok listáját; kampányt tartalmazó polc nem vehető el. A név egyedi.
faces: a polc kapacitása facingekben; cm: centiméterben.
instructions
text | null
Hogyan kell kialakítani (formázott szöveg, megtisztítva).
is_active
boolean
Felállítják-e még.
shelves
arraykötelező
A polcok fentről lefelé: [{label, capacity, price_factor}] (a pozíció a lista sorrendjét követi; a price_factor értéket csak az írhatja, aki látja az árakat).
Polcfelületek: egy egységben felállított planogram saját címkével, megjegyzéssel és költségekkel, csak azokban az egységekben, amelyek elrendezését a kulcs létrehozója kezeli. A törlés kiveszi az egységből: a kampányai előzményei miatt megmarad, vagy véglegesen törlődik, ha nem volt kampánya; futó kampány alatt soha. A költségeket csak az írhatja, aki látja az árakat.
Mindkét modul kampányai (module: spaces – bemutatózónák; shelf – planogramok polcai), a kulcs létrehozójaként írva. A kampány piszkozatként indul: az egységei (units) és az azokon belüli helyeket megnevező szabályok (rules) adják a helyeit. A launch művelet ellenőrzi a helyet, és elküldi a kampányt minden egységnek; a cancel leállítja. Az elindított kampány megtartja a dátumait és a helyeit; csak a szövege, a partnere, a pénzügyi adatai és a fotókövetelmény változhat. Az értéket és a költséget csak az írhatja, aki látja a pénzügyi adatokat.
POST/api/v1/merch-campaigns/{id}/launchA piszkozat elindítása: a hely ellenőrzése és elküldés minden egységnek.
POST/api/v1/merch-campaigns/{id}/cancelElindított kampány visszavonása: ahol még nincs kihelyezve, el sem indul, ahol már ki van helyezve, ott leszerelik.
Mezők
Név
Típus
Leírás
id
integercsak olvasható
Azonosító.
module
spaces | shelfkötelező
spaces vagy shelf – csak létrehozáskor.
title
stringkötelező
A kampány címe.
partner_id
integer | null
A fizető partner (lásd /merch-partners); üres: a cég saját kampánya.
Az egységek (egységazonosítók), a rules mezővel együtt.
rules
array
A helyeket megnevező szabályok, a units mezővel együtt. spaces: [{zone_type_id vagy zone_id, face (A/B), quantity}]; shelf: [{planogram_id vagy placement_id, position (polc, felülről), quantity, products}].
targets
arraycsak olvasható
Az eredményül kapott helyek: egységenként a zóna és az oldal, vagy a felállítás és a polc, a mennyiséggel.
Egy elindított kampány egy egységben: ki helyezi ki és mikorra, ki van-e helyezve, elutasították-e (indoklással), leszerelés alatt áll-e, vagy lezárult. A műveletek a kulcs létrehozójaként történnek (aki ott a megvalósító, illetve a reopen esetén, aki a kampányt vezeti). A fotókat base64-képként kell küldeni; a fotókat kérő kampány nélkülük nem igazolható vissza.
Ez a webhely csak a működéséhez szükséges sütiket használja. Az oldallátogatásokat sütik nélkül és az Ön azonosítása nélkül számoljuk. Sütikre vonatkozó tájékoztató