Vecton fejlesztői dokumentáció
A Vecton többbérlős (multi-tenant) kereskedelmi platform: webshop, bolt, raktár, CRM, szerviz és bérlés egy rendszerben, egyetlen adatforrásból. Ez a dokumentáció azoknak szól, akik a Vecton API-jára integrációt, saját scriptet vagy marketplace-appot építenek.
Fogalmak
| Fogalom | Jelentés |
|---|---|
| Szervezet (tenant) | Egy Vecton-ügyfél saját, elkülönített környezete. Minden adata saját adatbázisban él, más szervezet adatához egy kérés sem fér hozzá. |
| Tenant-host | A szervezet API-címe, jellemzően https://<szervezet>.app.vecton.hu (saját domain is lehet). Minden modul API-ja ezen a hoston érhető el. |
| Modul | Egy funkcióterület (webshop, raktár, CRM, …). A szervezetnél csak a bekapcsolt modulok érhetők el. |
| Identity | A központi hitelesítés: https://identity.vecton.hu. Itt történik a belépés, itt adnak ki tokent, és itt élnek a szerepkörök és a jogok. |
| Vecton-fiók | A felhasználó személyes fiókja. Egy fiók több szervezetnek is tagja lehet, szervezetenként más-más szerepkörrel. |
Hogyan épül fel egy hívás
kliens ──(1) token──► identity.vecton.hu
│
└──(2) Authorization: Bearer <token>──► https://<szervezet>.app.vecton.hu/api/<modul>/...
│
├─ a token érvényes, és a szervezet tagjáé?
├─ a jogosultság megvan? (tenant.<szervezet>.<modul>.<jog>)
└─ a modul válaszol
- A kliens tokent szerez az identitytől: emberi felhasználó nevében OAuth-tal, scriptből személyes hozzáférési tokennel, gépi integrációból a szervezet API-kulcsával. Lásd: Hitelesítés.
- A tokennel a tenant-hostot hívja. A host ellenőrzi a tokent, a tagságot és a kért művelet jogát. Lásd: Jogosultságok és A tenant API.
Modulok
| Modul | API-előtag | Mire való |
|---|---|---|
| Webshop | /api/webshop | Webshopok, boltok, termékek, kategóriák, rendelések, vevők, árajánlatok, pénztár, fizetési és szállítási módok, marketplace-appok kezelése |
| Raktár | /api/warehouse | Raktárak, készlet, bevételezés, kiszedés, csomagolás, szállítás, beszerzés, szállítók, átrakás |
| CRM | /api/crm | Projektek, feladatok, munkaidő, cégek, kapcsolattartók, chat, blog és oldalak, SMS |
/api/email | Levelezőfiókok, beérkező és kimenő levelek, sablonok | |
| Webhook | /api/webhook | Kimenő webhookok és kézbesítési napló |
| Analitika | /api/analytics | Statisztikák és riportok |
| Automatizáció | /api/automation | Eseményekre induló folyamatok (flow-k) |
| Szerviz | /api/repair | Szervizmunkalapok, árajánlatok, átadás |
| Bérlés | /api/rental | Bérleti eszközök, foglalások, szerződések, kauciók |
| Segéd | /api/copilot | A felületbe épített AI-segéd |
A valós idejű értesítések nem modulként, hanem külön szolgáltatásként futnak
ugyanazon a hoston (/api/ws-proxy), lásd: Valós idejű csatornák.
Bővítési lehetőségek
- Integráció az API-n át — saját rendszer, ami olvas és ír: Hitelesítés, A tenant API.
- Értesülés változásokról — webhook a saját szerveredre: Webhookok.
- Marketplace-app — a Vecton felületébe beépülő, a saját szervereden futó alkalmazás, amit több szervezet is telepíthet: Marketplace-app fejlesztése.
- Plugin — számlázó, fizetési, fuvarozó és pénztári bekötés a Vecton kódjában: Pluginok.