OkosMunkalap REST API
Az OkosMunkalap REST API segítségével bármilyen külső rendszerből programozottan kezelheted az ügyfeleidet és a munkalapjaidat. Az API univerzális: nem egyetlen partnerre szabott, hanem szabványos REST végpontokat ad, amelyeket bármilyen nyelvből (PHP, Python, Node.js, C#, no-code platform stb.) meghívhatsz egy API kulccsal.
Tipikus felhasználási esetek:
- diszpécser, távfelügyeleti vagy ügyfélszolgálati szoftver, amely az ügyfélkártyáról indít munkalapot,
- CRM rendszer, amely szinkronizálja az ügyféltörzset,
- call center szoftver, amely a hívó telefonszáma alapján keres ügyfelet,
- saját szkript vagy automatizálás (Zapier, Make, n8n).
Alap URL
Szekció neve “Alap URL”Minden végpont a következő alap URL alatt érhető el:
https://api.okosmunkalap.huA verziót az útvonal /v1 előtagja jelöli (pl. https://api.okosmunkalap.hu/v1/customers). Lásd a verziózás szakaszt.
Mit tud az API
Szekció neve “Mit tud az API”| Terület | Műveletek |
|---|---|
| Ügyfelek | létrehozás, lekérdezés (azonosító, külső azonosító vagy telefonszám alapján), módosítás |
| Munkalapok | létrehozás (match-or-create ügyféllel), listázás szűréssel és lapozással, lekérdezés, státuszváltás |
| Egyedi mezők | a fiók egyedi mező definícióinak lekérdezése |
| Webhookok | valós idejű értesítés eseményekről (munkalap státuszváltás, ügyfél módosítás) push alapon |
Gyors kezdés
Szekció neve “Gyors kezdés”-
Igényelj API kulcsot. Jelentkezz be az alkalmazásba, majd nyisd meg a Beállítások → Integrációk → Kulcsok oldalt, és hozz létre egy új kulcsot a megfelelő jogosultságokkal. A nyers kulcs csak egyszer jelenik meg, ezért azonnal mentsd el biztonságos helyre. Részletek: Hitelesítés és kulcsok.
-
Hívd meg a teszt végpontot. A
GET /v1/pingvégponttal ellenőrizheted, hogy a kulcsod működik:Terminál curl https://api.okosmunkalap.hu/v1/ping \-H "Authorization: Bearer omk_live_a1b2c3d..."Sikeres válasz:
{"data": {"pong": true,"keyPrefix": "omk_live_a1b2c3d","permissions": ["customers:read", "worksheets:create"],"apiVersion": "2026-06-15","requestId": "req_a1b2c3d4e5f6a7b8"}} -
Olvasd el az API referenciát, és nézd meg az integrációs példát egy teljes folyamathoz.
Válaszformátum
Szekció neve “Válaszformátum”Az API minden válasza JSON. A formátum egységes:
- Sikeres válasz egyetlen erőforrásnál:
{ "data": { ... } } - Sikeres válasz listánál:
{ "data": [ ... ], "pagination": { ... } } - Hiba esetén:
{ "error": { "code": ..., "message": ..., "status": ..., "requestId": ... } }
A nem kitöltött mezők egyszerűen kimaradnak a válaszból (a JSON nem tartalmaz null értékeket az opcionális mezőkre). A hibakezelés részleteit és a teljes hibakód katalógust az API referencia hibakezelés szakasza tartalmazza.
Csomagok és limitek
Szekció neve “Csomagok és limitek”Az API minden előfizetési csomagban elérhető. A csomagok a percenkénti kéréskorlátban, a havi keretben és az egyidejű kulcsok számában különböznek:
| Csomag | Kéréskorlát (perc) | Havi keret | Max. kulcs |
|---|---|---|---|
| Ingyenes | 5 | 500 | 1 |
| Basic | 15 | 3 000 | 2 |
| Pro | 60 | 30 000 | 5 |
| Business | 120 | 150 000 | 15 |
A kéréskorlát és a havi keret feleződik, ha a kulcs AI célú felhasználásra van jelölve. A korlátok kezelését (válasz fejlécek, 429 viselkedés) az API referencia írja le.
Verziózás
Szekció neve “Verziózás”Az API verziója dátum alapú azonosító (a legutóbbi kiadás dátuma, Stripe-stílusú verziózás). A támogatott verzió:
2026-06-15Minden kulcshoz tartozik egy alapértelmezett API verzió. Egy adott kérésnél felülírhatod az X-API-Version kérés fejléccel. A sikeres hitelesítés utáni válasz tartalmazza az X-API-Version-Used fejlécet, amely a ténylegesen alkalmazott verziót jelzi. Nem támogatott verzió megadása 400 hibát ad.
Hova tovább
Szekció neve “Hova tovább”- Hitelesítés és kulcsok: Bearer hitelesítés, kulcs formátum, jogosultságok, adat hatókör.
- API referencia: minden végpont kéréssel, válasszal és példákkal.
- Webhookok: valós idejű értesítések és az aláírás ellenőrzése.
- Hibakódok: a teljes hibakód lista okokkal és teendőkkel.
- Integrációs példa: külső rendszerből munkalap indítása lépésről lépésre.
- TypeScript kliens: másolható kód típusokkal, újrapróbálással és webhook ellenőrzéssel.
- AI-kapcsolat (MCP): a Claude vagy a ChatGPT összekötése a fiókkal, kód írása nélkül.
- API változásnapló: új végpontok, új mezők és viselkedés-változások időrendben.