Beágyazás
A modul beágyazásához az integráló fél weboldalán az alábbi iframe
HTML elemet kell elhelyezni:
<iframetitle=”Kockázatelemzés”src=”DOMAIN?partner-key=PARTNER_KEY&payload=PAYLOAD”>
Az iframe
használatához szükség van a forrás címére, amit a Péntech szolgál ki.
Ez több részből tevődik össze, amiben a használathoz az integráló félnek
minden attribútumot meg kell adnia.
Domain
A Péntech 2 környezetet bocsájt az integráló rendelkezésére, amiket az alábbi címeken érhetőek el:
Demo (tesztkörnyezet)
A partner által tesztelésre használható környezet, ami az éles környezettől teljesen függetlenül fut. Ebben a környezetben a rendszer összes stabil és publikálásra jelölt (release candidate) verziója automatikusan frissül.
Ennek címe: https://quickrisk.module.demo.pentech.hu
Production (éles környezet)
Az ügyfelek által használt weboldalon használt környezet, ami a demo környezettől teljesen függetlenül fut. Ebben a környezetben a rendszer csak a stabil verziókra frissül.
Ennek címe: https://quickrisk.module.pentech.hu
partner-key
Integráló fél azonosítója a Péntech rendszerében.
payload
A végfelhasználó azonosítására szolgáló azonosítókat tartalmazó objektum kódolt formája.
Struktúra
2 elemet tartalmaz, mindkettő értéke szöveg típusú.
A ”session” attribútum a végfelhasználó munkamenetének azonosítója. Ez főleg a nem bejelentkezett felhasználók lekéréseinek limitálására szolgál, de segít a riportálásban összekötni azokat az eseteket, amikor egy felhasználó lekérdez egy vagy több elemzést, majd belép az integráló rendszerébe és további lekérdezéseket futtat.
Ajánlott az integráló rendszer munkamenet azonosítására használt azonosító használata erre a célra is. (Tehát ha van sessionId, akkor azt direktben fel lehet erre is használni)
A ”user” opcionális (elhagyható) attribútum a bejelentkezett felhasználó lekérdezéseinek összekapcsolására, és a bejelentkezett felhasználók lekérdezési limit számolására felhasznált érték.
A fenti attribútumok mentésre kerülnek és a kimutatásokban megjelenhetnek.
Példa
Ebben a szekcióban egy példán keresztül mutatjuk be a payload kódolását.
Eredeti, kódolatlan objektum:
{"session": "93b4","user": "9542"}
Ezt a JSON objektumot AES-256-CBC titkosítással a Péntech által megadott titkosító kulcs segítségével kell kódolni:
Kulcs: "ee9aec3feff3a0496f18327251649aec"
(Előre egyeztetett)
Inicializáló vektor (~salt): "012be27fbbb413d2"
(Kódoláskor generált)
Ezekkel a kulcsokkal, a fenti objektum elkódolva, a vektorral ”:
” (kettőspont) karakterrel összefűzve:
rpeo/GeYN5K6a0Axv/W0fJDdQOWYP5SUDAk/tquuHFYxUhtxAZ/XyeVvZ+KV5NH3:012be27fbbb413d2
Mely ez után RFC 3986 szabvány szerinti URL komponensé alakítva:
rpeo%2FGeYN5K6a0Axv%2FW0fJDdQOWYP5SUDAk%2FtquuHFYxUhtxAZ%2FXyeVvZ%2BKV5NH3%3A012be27fbbb413d2
Az így kapott URL:
https://quickrisk.module.pentech.hu?partner-key=nlo4Xf1dn-nak&payload=rpeo%2FGeYN5K6a0Axv%2FW0fJDdQOWYP5SUDAk%2FtquuHFYxUhtxAZ%2FXyeVvZ%2BKV5NH3%3A012be27fbbb413d2
Az <iframe> elemnek ezt a generált URL-t kell megadni az src
attribútumban.