Minden, amire szükséged van a chatbotod elindításához
Közérthető útmutató Obdal AI chatbotod felépítéséhez, testreszabásához és beágyazásához — az első alkalmazástól egészen a weboldaladon való élesítésig.
Mi az Obdal, közérthetően
Az Obdal a saját tartalmadat alakítja 24/7 elérhető AI chatbottá, amelyet bármely weboldalra elhelyezhetsz. Ez az oldal végigvezet a teljes folyamaton. A lépések előtt érdemes ismerni öt szót, amelyekkel mindenhol találkozni fogsz: az alkalmazás egyetlen chatbot; a tudásbázisa azok a fájlok és GYIK-ek, amelyek alapján válaszol; a widget az a csevegőbuborék, amelyet a látogatók látnak; a Tervező az, ahol ezt a widgetet formázod; a beszélgetések pedig azok a csevegések, amelyeket kezel. Ha ezek a helyükre kerülnek, a dokumentáció többi része gyorsan olvasható.
Alkalmazás (chatbot)
Egy chatbot egy alkalmazás. Minden más — a tudása, a kinézete, a beszélgetései — ehhez az alkalmazáshoz tartozik.
Tudásbázis
A feltöltött fájlok és az általad megírt GYIK-ek. A chatbotod kizárólag ebből a tartalomból válaszol, így pontos marad a vállalkozásodra nézve.
Widget
Az a csevegőbuborék, amelyre a látogatóid kattintanak egy beszélgetés megnyitásához. A beágyazási kód beillesztése után jelenik meg a weboldaladon.
Tervező
A kódmentes stúdió, ahol a widgetet formázod — színeit, témáját, pozícióját és üdvözlő üzenetét — élő előnézettel.
Beszélgetések
Minden csevegés, amelyet a widgeted kezel. A beszélgetések alapján mérjük a használatot, és a csomagod határozza meg, hányat kapsz havonta.
Hogyan illeszkednek össze a részek
A tartalmad működteti az alkalmazást, az alkalmazás vezérli a widgetet, a widget pedig a weboldaladon él.
- Alkalmazás
- Tudás
- Widget
- A weboldalad
Egy fiók több alkalmazást is tartalmazhat, és mindegyik teljesen különálló — saját tudása, saját API-kulcsa, saját widgetdizájnja és saját beszélgetései vannak. Semmi sem szivárog át egyik chatbotból a másikba.
Az üres vezérlőpulttól az élő chatbotig
Négy lépésben élő chatbotot indíthatsz. Először hozz létre egy alkalmazást a vezérlőpultodon. Másodszor adj hozzá tudást fájlok feltöltésével vagy GYIK-ek megírásával, hogy a botnak legyen miből válaszolnia. Harmadszor nyisd meg a Tervezőt, és szabd testre, hogyan néz ki és hová kerül a widget. Negyedszer tedd közzé a beágyazási kód weboldalra másolásával. Az alábbi lépések mindegyike a saját, részletesebb szakaszára hivatkozik, de ez a teljes, ideális út az üres vezérlőpulttól az élő chatbotig.
- 1
Hozz létre egy alkalmazást
Az Alkalmazások vezérlőpultodon hozz létre egy új alkalmazást, és adj neki nevet. Az elnevezés automatikusan létrehozza az API-kulcsát, így a chatbot készen áll a beállításra.
- 2
Add hozzá a tudásodat
Tölts fel fájlokat, és írj GYIK-eket, hogy a botnak legyen miből válaszolnia. A feltöltött fájlok a háttérben dolgozódnak fel, és kis idő múlva válnak kereshetővé.
- 3
Szabd testre a widgetet
Nyisd meg a Tervezőt a botnév, az avatar, az üdvözlő üzenet, a téma és a színek beállításához. Az élő előnézet azonnal frissül, ahogy bármit megváltoztatsz.
- 4
Tedd közzé a weboldaladon
Másold ki a beágyazási kódot a Tervező Közzététel füléről, és illeszd be a weboldaladra. Az ingyenes csomag elegendő az élesítéshez.
Állítsd be az engedélyezett eredeteket, különben a widget rejtve marad
Nem angol válaszokhoz magad állítsd be a nyelvet
A widget elhelyezése a weboldaladon
A közzététel azt jelenti, hogy egyetlen kódrészletet illesztesz be a weboldaladra. Nyisd meg az alkalmazásodat, lépj a Tervező Közzététel füljére, és másold ki a beágyazási kódot. Illeszd be közvetlenül a záró címke elé minden olyan oldalon, ahol a widgetnek meg kell jelennie — a legtöbb weboldalszerkesztőben van hely az egyéni HTML-nek vagy a lábléc-szkripteknek. Ahhoz, hogy a widget betöltődjön, a weboldalad címét fel kell venni az engedélyezett eredetek közé, különben a csevegés rejtve marad. Ha a weboldalad egyoldalas alkalmazás, a kódrészlet akkor is működik, ha a fő elrendezésedben van. A közvetlen WordPress- és Shopify-integrációk úton vannak; egyelőre a beágyazási kód minden platformon működik.
A beágyazási kódrészlet
Ezt a Tervező Közzététel füléről másold ki — a valódi kódrészleted a saját API-kulcsodat tartalmazza.
<script> window.obdalConfig = { apiKey: "your-app-api-key", baseUrl: "https://obdal.com" };</script><script async src="https://obdal.com/widget-loader.js"></script>Hová illeszd be
Add a kódrészletet közvetlenül a záró </body> címke elé minden olyan oldalon, ahol a widgetnek meg kell jelennie. Magától inicializálódik — nincs más teendő. A legtöbb weboldalszerkesztő kínál egyéni HTML- vagy lábléc-szkriptek területet, amely tökéletes erre.
Add hozzá a weboldaladat az engedélyezett eredetekhez
Egyoldalas alkalmazások
Ha a weboldalad kliensoldali útválasztást használ, illeszd be a kódrészletet egyszer a fő elrendezésedbe. A betöltő az oldal betöltésekor inicializálódik, és a widget elérhető marad, ahogy a látogatók a nézetek között mozognak.
Platformbővítmények
A dedikált WordPress- és Shopify-bővítmények hamarosan érkeznek. Amíg meg nem jelennek, a fenti szkriptes beágyazás minden platformon működik, beleértve ezt a kettőt is.
Magát frissíti
A widgeted formázása, mezőről mezőre
A Tervező az, ahol a chatbotod megkapja a kinézetét, és egy élő előnézet frissül, ahogy bármit megváltoztatsz. Négy füle van. Az Általános a botnevet, az avatart és az üdvözlő üzenetet fedi le. A Megjelenés a legnagyobb fül: téma és színek, fejléc- és üzenetstílusok, betűtípusok, ablakméret, sarokrádiusz, animációk és a csevegés indítógomb. A Pozíció állítja be, melyik sarokban ül a buborék, külön elhelyezéssel mobilra. A Közzététel adja a beágyazási kódot és az engedélyezett eredetekre vonatkozó emlékeztetőt. Ez a szakasz közérthető referencia minden mezőhöz, így mindig tudod, mit csinál az egyes vezérlők, mielőtt hozzájuk nyúlnál.
Minden változtatás azonnal megjelenik az élő előnézetben, így pontosan láthatod, mit fognak látni a látogatók, mielőtt közzéteszed.
Az alapok, amelyeket a látogatóid először vesznek észre.
| Mező | Lehetőségek | Mit csinál |
|---|---|---|
| Botnév | Szöveg | A csevegőablak tetején megjelenő név, például a márkád vagy az asszisztens neve. |
| Avatar | SVG / PNG / JPG | A bot üzenetei melletti kép. Tölts fel SVG-, PNG- vagy JPG-fájlt, a hosszabb oldalán legfeljebb 1500px méretben. |
| Üdvözlő üzenet | Szöveg | Az első üzenet, amelyet a látogatók látnak a csevegés megnyitásakor. Használd a hangnem megadására és egy kérdés ösztönzésére. |
Chatbot futtatása más nyelven
A chatbot más nyelven való futtatásához két különálló beállításra van szükség, és a kettő közötti különbség ismerete sok zavartól megóv. A widget felületszövege (gombok, helykitöltők) angolul és magyarul érkezik; azt, hogy melyik, a beágyazási kódban a nyelvi kód beállításával választod ki — erre nincs kapcsoló a Tervezőben. Külön szabályozza a rendszerprompt, hogy a bot milyen nyelven válaszol, nem pedig az automatikus felismerés: magyar válaszokhoz mondd meg a botnak, hogy magyarul válaszoljon. Egy őszinte megjegyzés előre: a látogatók nem tudják maguk átváltani a csevegés nyelvét, ezért minden beágyazáshoz te állítod be a nyelvet, ahelyett hogy választót kínálnál.
Igen, a widget magyar felületszöveggel érkezik, és a bot is tud magyarul válaszolni. Csak épp nem a Tervezőben lévő kapcsoló, ezért feltételezik gyakran a tulajdonosok, hogy nem lehetséges. Két különálló kar van, és mindkettőt magad állítod be.
1. kar — A widget felületnyelve
A widget gombjai és helykitöltői angolul (az alapértelmezett) és magyarul érkeznek. Azt, hogy melyik, a beágyazási kódban a window.obdalConfig.locale beállításával választod ki. Add hozzá az alábbi kiemelt sort; a kimásolt kódrészlet nem tartalmazza, így ez kézi hozzáadás.
A widget nyelvi kódjának beállítása
Add hozzá a nyelvi kód sorát a beágyazási kódrészletedhez — alapból nincs ott.
<script> window.obdalConfig = { apiKey: "your-app-api-key", baseUrl: "https://obdal.com", locale: "hu" };</script><script async src="https://obdal.com/widget-loader.js"></script>2. kar — A nyelv, amelyen a bot válaszol
Azt, hogy a bot milyen nyelven válaszol, az App-beállításokban lévő rendszerprompt szabályozza, nem az automatikus felismerés. Magyar válaszokhoz adj hozzá egy utasítást, például: „Mindig magyarul válaszolj.” A bot a promptot követi; nem találgat a látogató üzenetéből.
Egy teljesen magyar chatbot
Nincs végfelhasználói nyelvi kapcsoló
Támogatott felületnyelvek: angol (en, az alapértelmezett) és magyar (hu).
A chatbot más nyelven való futtatása minden csomagban elérhető. Soha nem fizetős bővítmény.
Sötét, világos és a márkaszíneid
Az Obdalnak két teljesen különálló témája van, és ezek összekeverése a leggyakoribb zavarforrás. A vezérlőpult témája — a Világos, Sötét vagy Rendszer kapcsoló a vezérlőpultod jobb felső sarkában — csak azt változtatja meg, amit te látsz a chatbotod kezelése közben. A widgetre nincs hatással. A widget témáját a Tervező Megjelenés fülén, a Téma és szín részben állítod be, ahol Világosat vagy Sötétet választasz, és módonként hat színt finomhangolsz: háttér, szöveg, szegély, a felhasználói buborék, a botbuborék és az elsődleges kiemelőszín. A látogatóid az általad választott widgettémát látják; ők maguk nem tudják átváltani.
Két különálló téma
Az egyik megváltoztatása soha nem változtatja meg a másikat. A vezérlőpult témája a tiéd a munka közben; a widget témája az, amit a látogatók látnak a weboldaladon.
A Világos / Sötét / Rendszer kapcsoló a vezérlőpultod jobb felső sarkában. Csak azt érinti, amit a chatbotod kezelése közben látsz.
A Tervező Megjelenés fülén állítod be. Ezt látják ténylegesen a látogatóid a weboldaladon.
Téma és szín a Megjelenés fülön
A Tervező Megjelenés fülén válassz Világos vagy Sötét widgettémát, majd finomhangold a hat színt arra a módra.
Háttér
A csevegőablak fő felületszíne.
Szöveg
Az üzenet- és címkeszöveg színe.
Szegély
Az elválasztók és az ablakperem színe.
Felhasználói buborék
A látogatód által küldött üzenetek háttere.
Botbuborék
A bot által küldött üzenetek háttere.
Elsődleges
A gomboknál és kiemeléseknél használt kiemelőszín.
Válaszd ki a márkaszínedet a hat előbeállítás közül, vagy állíts be egyedit. Az általad választott elsődleges szín átöröklődik a felhasználói buborék színére, így a widget extra finomhangolás nélkül is márkahű marad.
A látogatók nem tudják átváltani a widget témáját
Alkalmazás- és profilbeállítások
Az App-beállítások a chatbotod viselkedésének vezérlőpultja, elkülönülve attól, hogyan néz ki. Itt kezeled az API-kulcsot (újragenerálhatod, de ezzel tönkreteszed a régit használó beágyazásokat), beállítod a személyiséget és a hangnemet, megírod a rendszerpromptot, amely minden választ és annak nyelvét alakítja, kiválasztasz egy pénznemet, és bekapcsolod az Élő csevegést az élő ügynöki átadáshoz. A saját fiókadataid — név, e-mail és jelszó — külön, a Profilbeállításokban találhatók. Ez a szakasz minden mezőt elmagyaráz, és hogy mikor változtatnád meg.
App-beállítások
Chatbotonkénti konfiguráció arra, hogyan viselkedik ez az alkalmazás.
| Mező | Lehetőségek | Mit csinál |
|---|---|---|
| API-kulcs | Maszkolt · Újragenerálás | Hitelesíti az alkalmazásodat. Csak az utolsó néhány karakterrel jelenik meg. Újragenerálhatod, de minden, a régi kulcsot használó beágyazás leáll. |
| Személyiség / Hangnem | Hangnem legördülő | Beállítja a hangot, amelyen a bot ír, egy Hangnem stílus legördülőből — például barátságos, hivatalos vagy tömör. |
| Rendszerprompt | Max. 2000 karakter | A fő utasítások, amelyek minden választ alakítanak, beleértve azt is, milyen nyelven válaszol a bot. A viselkedés legfontosabb beállítása. |
| Pénznem | 100+ kereshető | A pénznem, amelyet a bot az árakról beszélve használ. Válassz egy több mint száz elemű, kereshető listából. |
| Élő csevegés | Be / Ki | Bekapcsolja az élő ügynöki átadást, hogy egy élő ügynök átvehesse a beszélgetést, amikor a látogatónak emberre van szüksége. |
Az API-kulcs újragenerálása tönkreteszi a meglévő beágyazásokat
Profilbeállítások
A személyes fiókadataid — név, e-mail és jelszó — a Profilbeállításokban találhatók, bármely alkalmazástól elkülönülve. Megváltoztatásuk nem érinti a chatbotjaidat.
Az App-beállítások egy chatbotról szólnak; a Profilbeállítások rólad. Ha egy botvezérlőt keresel a fiókprofilod alatt, helyette az App-beállításokban nézd.
GYIK és a tudásbázisod
A GYIK-ek gyors, pontos válaszokat adnak a chatbotodnak azokra a kérdésekre, amelyekről már tudod, hogy a látogatók felteszik, a tudásbázisod fájljai mellett. Létrehozhatsz, szerkeszthetsz és törölhetsz GYIK-eket, kategóriákba csoportosíthatod őket, kitűzhetsz akár ötöt, hogy elsőként jelenjenek meg, átrendezheted őket, és bármelyiket aktívra vagy inaktívra kapcsolhatod. A GYIK-ek minden fizetős csomag részei, így ha az ingyenes csomagon vagy, frissítened kell a feloldásukhoz. Ez a szakasz a tudásbázisod kezeléséről szól, és arról, hogyan hozd ki a legtöbbet a kitűzött, jól kategorizált válaszokból.
Létrehozás, szerkesztés és törlés
Írj meg egy kérdést és a válaszát, frissítsd őket bármikor, és távolítsd el azokat, amelyekre már nincs szükséged.
Kategóriákba csoportosítás
Rendezd a GYIK-eket kategóriákba, hogy a kapcsolódó kérdések együtt maradjanak, és könnyebben kezelhetők legyenek.
Akár öt kitűzése
Tűzd ki a legfontosabb válaszaidat — akár ötöt —, hogy elsőként jelenjenek meg a látogatók számára.
Szabad átrendezés
Rendezd a GYIK-eket a kívánt sorrendbe, a leghasznosabb válaszokat a tetejéhez közel helyezve.
Aktívra vagy inaktívra állítás
Kapcsolj be vagy ki bármely GYIK-et törlés nélkül, így ideiglenesen visszavonhatsz egy választ.
A GYIK-ek fizetős csomag funkciója
Használj GYIK-eket a rövid, gyakran feltett kérdésekhez pontos válaszokkal, a feltöltött fájlokat pedig a hosszabb referenciaanyaghoz. Mindkettő ugyanazt a csevegést táplálja, így a bot azt használja, amelyik a kérdéshez a legjobban illik.
Egy csevegés átadása egy valódi személynek
Néha a látogatónak valódi személyre van szüksége, és az élő ügynöki átadás lehetővé teszi, hogy valaki közbelépjen. Kapcsold be az Élő csevegést az App-beállításokban, és a chatbotod átadhat egy beszélgetést egy élő ügynöknek, aki átveszi a csevegést. Minden csomag tartalmaz egy bizonyos számú ügynöki helyet — a te oldaladon lévő emberek, akik válaszolhatnak —, amely a nagyobb csomagokra lépve növekszik. Ez a szakasz elmagyarázza, hogyan engedélyezd az átadást, mi történik egy átvétel során, és hogyan illeszkednek a helyek a csomagodhoz.
Kapcsold be az Élő csevegést
Nyisd meg az App-beállításokat, és kapcsold be az Élő csevegést (élő ügynöki átadás). Ha be van kapcsolva, egy ügynök bármely beszélgetésbe beléphet, és átveheti a bottól. Beállíthatsz egy offline üzenetet is arra az esetre, ha nincs elérhető ügynök.
Az ügynöki helyek a csomagoddal együtt nőnek
Minden csomag tartalmaz egy bizonyos számú ügynöki helyet — a csapattagok, akik élő csevegésekre válaszolhatnak. A beállítások kártya megmutatja, hány hely van használatban a korlátodhoz képest, és a szám a nagyobb csomagokon nő. A pontos számokért lásd a Csomagok szakaszt.
Amikor nincs elérhető ügynök
Ha egy ügynök sincs online, a látogatók a beállított offline üzenetet látják — például egy e-mail-címet, ahol elérhetnek. A beszélgetés soha nem marad némán.
Az élő ügynöki átadás fizetős csomag funkciója
Csomagok és amit mindegyik felold
A csomagod dönti el, mit tudnak a chatbotjaid, és ez a szakasz minden képességet ahhoz köt, ahol feloldódik. A csomagoddal együtt skálázódó korlátokra érdemes figyelni: havi beszélgetések, a fájljaid tárhelye, hány widgetet futtathatsz, elérhetők-e a GYIK-ek, az élő ügynöki átadás és hány ügynöki helyet kapsz, a „Powered by” márkajelzés eltávolítása, az AI-modell szintje, valamint a támogatási és SLA-szinted. Az itt szereplő adatok közvetlenül az élő csomagadatokból származnak, így mindig naprakészek. Amikor készen állsz az egymás melletti összehasonlításra, irány az árazási oldal.
| Képesség | Free Ingyenes | Starter 15/hó | Growth 39/hóNépszerű | Pro 89/hó | Business 179/hó |
|---|---|---|---|---|---|
| Havi beszélgetésekA widgetjeid által havonta kezelt csevegések. | 50 | 500 | 1,500 | 4,000 | 10,000 |
| Tudás tárhelyHely a tudásbázisod fájljainak. | 100 MB | 1 GB | 5 GB | 20 GB | 50 GB |
| WidgetekHány külön chatbotot futtathatsz. | 1 | 1 | 3 | 10 | Unlimited |
| GYIK-ekGondozott kérdés-válasz bejegyzések. | |||||
| Élő ügynöki átadásHagyd, hogy egy élő ügynök átvegyen egy csevegést. | |||||
| Ügynöki helyekCsapattagok, akik élő csevegésekre válaszolhatnak. | 0 | 2 | 5 | 15 | Unlimited |
| „Powered by” márkajelzés eltávolításaRejtsd el az Obdal jelvényt a widgeten. | |||||
| AI-modell szintjeA válaszaid mögötti modell minősége. | Gyors | Gyors | Haladó | Prémium | Prémium |
- Havi beszélgetések
- 50
- Tudás tárhely
- 100 MB
- Widgetek
- 1
- GYIK-ek
- Élő ügynöki átadás
- Ügynöki helyek
- 0
- „Powered by” márkajelzés eltávolítása
- AI-modell szintje
- Gyors
- Havi beszélgetések
- 500
- Tudás tárhely
- 1 GB
- Widgetek
- 1
- GYIK-ek
- Élő ügynöki átadás
- Ügynöki helyek
- 2
- „Powered by” márkajelzés eltávolítása
- AI-modell szintje
- Gyors
- Havi beszélgetések
- 1,500
- Tudás tárhely
- 5 GB
- Widgetek
- 3
- GYIK-ek
- Élő ügynöki átadás
- Ügynöki helyek
- 5
- „Powered by” márkajelzés eltávolítása
- AI-modell szintje
- Haladó
- Havi beszélgetések
- 4,000
- Tudás tárhely
- 20 GB
- Widgetek
- 10
- GYIK-ek
- Élő ügynöki átadás
- Ügynöki helyek
- 15
- „Powered by” márkajelzés eltávolítása
- AI-modell szintje
- Prémium
- Havi beszélgetések
- 10,000
- Tudás tárhely
- 50 GB
- Widgetek
- Unlimited
- GYIK-ek
- Élő ügynöki átadás
- Ügynöki helyek
- Unlimited
- „Powered by” márkajelzés eltávolítása
- AI-modell szintje
- Prémium
Ezek minden csomagban elérhetők
A REST API fejlesztőknek
A Fejlesztői API-val a saját szoftvered megteheti azt, amit az irányítópult: csevegés az asszisztenssel, beszélgetések olvasása, tudásbázis-fájlok feltöltése, termékkatalógus küldése, amely termékkártyaként jelenik meg, és az élő átadás kezelése. Minden kérést két, ugyanahhoz a fiókhoz tartozó hitelesítő adat azonosít: az alkalmazás API-kulcsa az App-beállításokból és a bejelentkezési e-mail-címed. Mindkettőt a szervereden tartsd. Ha csak a widgetre van szükséged egy weboldalon, ugord át ezt a szakaszt; a beágyazási kódhoz nem kell programozni.
A szokásos akadályok megoldása
A legtöbb probléma néhány előre látható okra vezethető vissza, és mindegyikre van gyors megoldás. Ha a widget még mindig „Powered by Obdal” felirattal jelenik meg, a márkajelzés eltávolítása fizetős csomag funkció — frissíts az elrejtéséhez. Ha a bot rossz nyelven válaszol, a megoldás a rendszerpromptodban van, nem egy rejtett nyelvi beállításban: mondd meg neki, milyen nyelven válaszoljon. Ha pedig a widget egyáltalán nem jelenik meg, az ok szinte mindig az engedélyezett eredetek — add meg a weboldalad pontos címét a Közzététel fülön, hogy a widget betöltődhessen. Ez a szakasz végigveszi ezeket és a többi valós zavart, amelybe a tulajdonosok beleütköznek.
Miért jelenik meg a „Powered by Obdal”?
Ennek a jelvénynek az eltávolítása fizetős csomag funkció. Az ingyenes csomagon megjelenik, a Starter csomagtól felfelé eltávolítható. Frissíts, és a márkajelzés eltűnik. Lásd a Csomagok szakaszt.
Lásd: CsomagokMiért nem válaszol magyarul?
A bot nem ismeri fel automatikusan a nyelvet. A válasz nyelvét a rendszerpromptodban állítsd be (például „Mindig magyarul válaszolj”), a widget felületnyelvét pedig a beágyazási kódban lévő nyelvi kóddal. Lásd a Többnyelvű chatbot szakaszt.
Lásd: Többnyelvű chatbotA widget egyáltalán nem jelenik meg.
Ez szinte mindig az engedélyezett eredetek — a betöltő nem fut le egy fel nem sorolt domainen, és naplózza az origin_not_allowed üzenetet. További blokkolók, amelyeket naplóz: subscription_required, conversation_limit_reached, trial_limit_reached, owner_not_found, app_not_found és egy hibás API-kulcs. Nézd meg a Beágyazás szakaszt.
Lásd: BeágyazásA vezérlőpultom sötét, de a widget világos (vagy fordítva).
Ez így van rendjén. A vezérlőpult témája és a widget témája független beállítások, és az egyik megváltoztatása soha nem változtatja meg a másikat. Lásd a Témák szakaszt.
Lásd: TémákÚjrageneráltam az API-kulcsomat, és a widget elromlott.
A közzétett beágyazásodban lévő régi kulcs már nem működik. Másold ki a friss kódrészletet a Közzététel fülről, és illeszd be újra mindenhová, ahol a widget megjelenik. Lásd az Alkalmazás-beállítások szakaszt.
Lásd: BeállításokMég mindig blokkolva van valamilyen más okból.
Nyisd meg a böngésződ fejlesztői konzolját azon az oldalon, ahol a widget van. A betöltő naplózza a pontos okot, amiért nem jelent meg, ami egyenesen a megoldáshoz vezet.
Lásd: BeágyazásElőször a böngészőkonzolt nézd meg
Három lépés az első hitelesített kérésig.
A Fejlesztői API szerverek közötti felület. Minden hívás az alkalmazás API-kulcsát és a fiókod e-mail-címét viszi, ezért mindkettőt a backendeden tartsd, és soha ne add ki böngészőoldali kódban.
Másold ki az alkalmazás API-kulcsát
Nyisd meg az App-beállításokat, és másold ki annak az alkalmazásnak a kulcsát, amelyet meg szeretnél szólítani. A kulcs újragenerálása mindenhol érvényteleníti a régit.
Küldd mindkét hitelesítő adatot fejlécben
Add hozzá az X-Api-Key fejlécet a kulccsal és az X-Account-Email fejlécet a bejelentkezési e-mail-címeddel. Ha bármelyik nem egyezik, 401 invalid_credentials választ kapsz.
Hívd meg a végpontokat
Kezdd a GET /developer/app hívással a kapcsolat ellenőrzéséhez, majd csevegj, tölts fel tudásbázis-fájlokat, küldj termékeket vagy kezeld az élő átadást.
-H "X-Api-Key: $API_KEY" \
-H "X-Account-Email: $ACCOUNT_EMAIL" \
-H "Content-Type: application/json" \
-d '{
"message": "Do you ship to Canada?"
}'
const res = await fetch('https://obdal.com/api/v1/developer/chat', {
method: 'POST',
headers: {
'X-Api-Key': process.env.OBDAL_API_KEY,
'X-Account-Email': process.env.OBDAL_ACCOUNT_EMAIL,
'Content-Type': 'application/json'
},
body: JSON.stringify({ message: 'Do you ship to Canada?', session_id })
});
const { message, products } = await res.json();
Minden Fejlesztői API-végpont, kéréssel és válasszal.
Minden végpont az /api/v1/developer alatt él, a két hitelesítő fejlécet igényli, és JSON-nal válaszol. A sikeres válaszok success: true értéket, a hibák success: false értéket, hibaüzenetet és géppel olvasható code mezőt tartalmaznak.
Hitelesítés minden kérésnél
Kapcsolat
Ellenőrizd a hitelesítő adatokat, és tudd meg, mit fogad el az alkalmazás.
/api/v1/developer/app
Visszaadja az alkalmazás profilját, a csomag korlátait és az elfogadott feltöltési formátumokat. Használd kapcsolatellenőrzésre.
Kérés
GET /api/v1/developer/app X-Api-Key: your_app_api_key X-Account-Email: you@example.com
Válasz
{
"success": true,
"app": { "id": 12, "name": "Support bot", "locale": "en", "human_handoff_enabled": true },
"account": { "email": "you@example.com" },
"limits": { "plan": { "name": "Growth" }, "usage": { "conversations": {...}, "storage": {...} } },
"upload": { "extensions": [".pdf", ".txt", ".md", ".docx", ".xlsx", ".csv", ".html", ".json", ".jsonl", ".xml"], "max_size_kb": 10240 }
}Csevegés, munkamenetek és használat
Beszélgess az asszisztenssel a saját backendedről, olvasd az átiratokat, zárd le a beszélgetéseket és kövesd a tokenhasználatot. Az itt indított munkamenetek az api csatornacímkét kapják az irányítópulton.
/api/v1/developer/chat
Elküld egy látogatói üzenetet, és visszaadja az asszisztens válaszát. Hagyd el a session_id mezőt új beszélgetés indításához; a stream: true értékkel server-sent eseményeket kapsz. Amíg a munkamenet élő ügynöknél van, az üzenet az ügynökhöz kerül, és a válasz 202 handoff_active: true értékkel.
Kérés
{
"message": "Do you ship to Canada?",
"session_id": "3f7c1a9e-6d2b-4c58-9c0e-7b1f2d3e4a55",
"stream": false
}Válasz
{
"success": true,
"message": "Yes, we ship to Canada within 5 business days.",
"session_id": "3f7c1a9e-6d2b-4c58-9c0e-7b1f2d3e4a55",
"products": [ { "type": "product", "title": "Alpine Snowboard", "url": "https://...", "price_min": "49.99", "currency": "USD" } ],
"suggest_handoff": false
}/api/v1/developer/sessions
Az alkalmazás beszélgetéseit listázza, a legújabbtól kezdve, lapozással.
Kérés
GET /api/v1/developer/sessions?page=1&per_page=20 X-Api-Key: your_app_api_key X-Account-Email: you@example.com
Válasz
{
"success": true,
"sessions": [
{ "session_id": "3f7c1a9e-...", "title": "Shipping to Canada", "last_at": "2026-09-13T10:30:00Z", "status": "active", "preview": "Yes, we ship..." }
],
"meta": { "current_page": 1, "per_page": 20, "total": 1, "has_more": false }
}/api/v1/developer/sessions/{session_id}/messages
Visszaadja a munkamenet teljes átiratát az állapotával és az átadási állapotával együtt.
Kérés
GET /api/v1/developer/sessions/3f7c1a9e-.../messages?limit=100 X-Api-Key: your_app_api_key X-Account-Email: you@example.com
Válasz
{
"success": true,
"session": { "session_id": "3f7c1a9e-...", "channel": "api", "status": "active", "is_closed": false, "handoff_status": "none", "message_count": 2 },
"messages": [
{ "role": "user", "content": "Do you ship to Canada?", "sequence": 1, "timestamp": 1757757000000 },
{ "role": "assistant", "content": "Yes, we ship to Canada...", "sequence": 2, "timestamp": 1757757003000 }
]
}/api/v1/developer/sessions/{session_id}/close
Lezár egy munkamenetet. A lezárt munkamenetek 410-zel utasítják el az új üzeneteket.
Kérés
POST /api/v1/developer/sessions/3f7c1a9e-.../close X-Api-Key: your_app_api_key X-Account-Email: you@example.com
Válasz
{ "success": true, "closed": true }/api/v1/developer/usage
Összesíti a kéréseket, tokeneket és költséget, opcionálisan session_id, start_date és end_date szerint szűrve.
Kérés
GET /api/v1/developer/usage?start_date=2026-09-01&end_date=2026-09-30 X-Api-Key: your_app_api_key X-Account-Email: you@example.com
Válasz
{
"success": true,
"usage": { "total_requests": 1842, "total_input_tokens": 205401, "total_output_tokens": 216529, "total_tokens": 421930, "total_cost": 12.45 },
"by_model": [ { "model": "gpt-5.6", "provider": "OpenAI", "requests": 1842, "total_tokens": 421930, "cost": 12.45 } ]
}Tudásbázis-fájlok
Töltsd fel ugyanazokat a dokumentumtípusokat, amelyeket az irányítópult elfogad. A fájlok a háttérben darabolódnak, beágyazódnak és indexelődnek; kérdezd le az állapotot, amíg completed nem lesz.
/api/v1/developer/files
Kérésenként legfeljebb 20 fájlt tölt fel multipart/form-data formában a files[] mező alatt (vagy egyetlen fájlt a file mező alatt). Engedélyezett típusok: pdf, txt, md, docx, xlsx, csv, html, json, jsonl, xml; egyenként 10 MB.
Kérés
curl -X POST /api/v1/developer/files \ -H "X-Api-Key: $API_KEY" -H "X-Account-Email: $EMAIL" \ -F "files[]=@./faq.pdf" -F "files[]=@./returns-policy.md"
Válasz
{
"success": true,
"files": [
{ "id": 91, "name": "faq.pdf", "size": 48213, "mime_type": "application/pdf", "status": "pending", "stage": "queued", "progress": 0, "uploaded_at": "2026-09-13T10:31:00Z" }
]
}/api/v1/developer/files
Listázza a tudásbázis-fájlokat a feldolgozási állapotukkal.
Kérés
GET /api/v1/developer/files X-Api-Key: your_app_api_key X-Account-Email: you@example.com
Válasz
{
"success": true,
"files": [ { "id": 91, "name": "faq.pdf", "status": "completed", "progress": 100, "chunk_count": 14, "indexed_at": "2026-09-13T10:32:10Z" } ]
}/api/v1/developer/files/{id}
Visszaad egy fájlt a feldolgozási előrehaladásával.
Kérés
GET /api/v1/developer/files/91 X-Api-Key: your_app_api_key X-Account-Email: you@example.com
Válasz
{ "success": true, "file": { "id": 91, "name": "faq.pdf", "status": "completed", "progress": 100, "error": null } }/api/v1/developer/files/{id}
Eltávolít egy fájlt, a darabjait és a vektorait a tudásbázisból.
Kérés
DELETE /api/v1/developer/files/91 X-Api-Key: your_app_api_key X-Account-Email: you@example.com
Válasz
{ "success": true, "deleted": true }Termékek
Küldd el a katalógusodat, hogy az asszisztens termékkérdésekre válaszoljon és termékkártyákat mutasson a csevegésben, pontosan úgy, mint a Shopify-integráció. A termékazonosítók a tiéid: frissítéshez vagy törléshez használd őket újra.
/api/v1/developer/products
Egy hívásban legfeljebb 100 terméket hoz létre vagy frissít. A változatlan termékek kimaradnak; a megváltozottak helyben újraindexelődnek. Csak az id, a title és egy https url kötelező. Minden termék a saját állapotát jelenti (created, updated, skipped vagy failed), így egy hibás tétel sosem takarja el a többit.
Kérés
{
"products": [
{
"id": "sku-100",
"title": "Alpine Snowboard",
"url": "https://shop.example.com/products/alpine-snowboard",
"description": "All-mountain board for powder and park.",
"image_url": "https://cdn.example.com/alpine.jpg",
"price": "49.99",
"currency": "USD",
"vendor": "Obdal",
"product_type": "Snowboard",
"in_stock": true,
"collections": ["Winter Gear"],
"tags": ["snow", "board"],
"attributes": { "Length": "156 cm" },
"variants": [ { "id": "v1", "title": "156 cm", "price": "49.99", "sku": "ALP-156", "available": true } ]
}
]
}Válasz
{
"success": true,
"summary": { "created": 1, "updated": 0, "skipped": 0, "failed": 0 },
"results": [ { "id": "sku-100", "status": "created" } ]
}/api/v1/developer/products
Listázza az elküldött termékeket az indexelési állapotukkal.
Kérés
GET /api/v1/developer/products?page=1&per_page=50 X-Api-Key: your_app_api_key X-Account-Email: you@example.com
Válasz
{
"success": true,
"products": [ { "id": "sku-100", "title": "Alpine Snowboard", "url": "https://...", "price_min": "49.99", "status": "completed", "updated_at": "2026-09-13T10:40:00Z" } ],
"meta": { "current_page": 1, "per_page": 50, "total": 1, "has_more": false }
}/api/v1/developer/products/{id}
Visszaad egy terméket az általad adott azonosító alapján.
Kérés
GET /api/v1/developer/products/sku-100 X-Api-Key: your_app_api_key X-Account-Email: you@example.com
Válasz
{ "success": true, "product": { "id": "sku-100", "title": "Alpine Snowboard", "in_stock": true, "variants": [...], "status": "completed" } }/api/v1/developer/products/{id}
Eltávolít egy terméket és a vektorait.
Kérés
DELETE /api/v1/developer/products/sku-100 X-Api-Key: your_app_api_key X-Account-Email: you@example.com
Válasz
{ "success": true, "deleted": true }Emberi átadás
Kezeld az élő csevegést a saját eszközeidből. A fióktulajdonos az ügynök: jelentkezz be elérhetőként, figyeld a sort, vedd át a várakozó beszélgetést, válaszolj, és zárd le. Legalább 60 másodpercenként küldj életjelet, hogy online maradj.
/api/v1/developer/handoff/settings
Megmutatja, hogy az élő csevegés be van-e kapcsolva, az offline üzenetet, a helyek használatát, és hogy hány ügynök van online.
Kérés
GET /api/v1/developer/handoff/settings X-Api-Key: your_app_api_key X-Account-Email: you@example.com
Válasz
{
"success": true,
"settings": { "human_handoff_enabled": true, "handoff_offline_message": "Email help@example.com", "can_use_handoff": true, "handoff_available": true, "seats": { "limit": 3, "used": 1 }, "available_agents": 1, "my_availability": true }
}/api/v1/developer/handoff/settings
Be- vagy kikapcsolja az élő csevegést, és beállítja az offline üzenetet. Emberi átadást tartalmazó csomag szükséges hozzá.
Kérés
{ "human_handoff_enabled": true, "handoff_offline_message": "Email help@example.com" }Válasz
{ "success": true, "settings": { "human_handoff_enabled": true, "handoff_offline_message": "Email help@example.com", ... } }/api/v1/developer/handoff/availability
Elérhetőnek (vagy távollévőnek) jelöli a fióktulajdonost az élő csevegésekhez.
Kérés
{ "is_available": true }Válasz
{ "success": true, "is_available": true, "ttl_seconds": 60 }/api/v1/developer/handoff/heartbeat
Életben tartja a tulajdonos jelenlétét. A jelenlét az utolsó életjel vagy elérhetőségi hívás után 60 másodperccel lejár.
Kérés
POST /api/v1/developer/handoff/heartbeat X-Api-Key: your_app_api_key X-Account-Email: you@example.com
Válasz
{ "success": true, "is_available": true, "ttl_seconds": 60 }/api/v1/developer/handoff/queue
Listázza az ügynökre váró beszélgetéseket, az általad kezelteket és a nemrég lezártakat.
Kérés
GET /api/v1/developer/handoff/queue X-Api-Key: your_app_api_key X-Account-Email: you@example.com
Válasz
{
"success": true,
"waiting": [ { "session_id": "3f7c1a9e-...", "preview": "I need a human", "requested_at": "2026-09-13T10:45:00Z" } ],
"mine": [],
"ended": [],
"available_agents": 1
}/api/v1/developer/handoff/sessions/{session_id}/request
Élő ügynökhöz eszkalál egy munkamenetet. requested értéket ad vissza, ha van online ügynök, egyébként no_agents értéket az offline üzenettel.
Kérés
POST /api/v1/developer/handoff/sessions/3f7c1a9e-.../request X-Api-Key: your_app_api_key X-Account-Email: you@example.com
Válasz
{ "success": true, "session_id": "3f7c1a9e-...", "handoff_status": "requested", "queue_timeout_seconds": 180 }/api/v1/developer/handoff/sessions/{session_id}/claim
Ügynökként átveszi a várakozó beszélgetést. 409 not_claimable választ ad, ha már nem várakozik.
Kérés
POST /api/v1/developer/handoff/sessions/3f7c1a9e-.../claim X-Api-Key: your_app_api_key X-Account-Email: you@example.com
Válasz
{ "success": true, "claimed": true, "handoff_status": "active" }/api/v1/developer/handoff/sessions/{session_id}/messages
Ügynöki választ küld egy általad átvett beszélgetésbe.
Kérés
{ "message": "Hi, this is Anna. How can I help?" }Válasz
{ "success": true, "message": { "id": 501, "role": "agent", "content": "Hi, this is Anna. How can I help?", "sequence": 7, "created_at": "2026-09-13T10:46:00Z" } }/api/v1/developer/handoff/sessions/{session_id}/messages
Lekérdezi az átiratot; add meg az after_sequence értéket, hogy csak az újabb üzeneteket kapd.
Kérés
GET /api/v1/developer/handoff/sessions/3f7c1a9e-.../messages?after_sequence=7 X-Api-Key: your_app_api_key X-Account-Email: you@example.com
Válasz
{
"success": true,
"handoff_status": "active",
"agent": { "name": "Anna" },
"ended_reason": null,
"messages": [ { "role": "user", "content": "Where is my order?", "sequence": 8, "created_at": "2026-09-13T10:46:30Z" } ]
}/api/v1/developer/handoff/sessions/{session_id}/end
Lezárja az élő csevegést, és visszaadja a beszélgetést az asszisztensnek.
Kérés
POST /api/v1/developer/handoff/sessions/3f7c1a9e-.../end X-Api-Key: your_app_api_key X-Account-Email: you@example.com
Válasz
{ "success": true, "handoff_status": "ended" }Hibák és sebességkorlátok
A hibák JSON-ok success: false értékkel, olvasható error üzenettel és stabil code mezővel. Az érvényesítési hibák a szokásos 422 formát használják message mezővel és errors térképpel.
| Státusz | Kód | Jelentés |
|---|---|---|
| 401 | invalid_credentials | Az API-kulcs vagy a fiók e-mail-címe hiányzik, vagy nem egyezik az alkalmazás tulajdonosával. |
| 422 | validation | Egy kötelező mező hiányzik vagy hibás; lásd az errors térképet. |
| 403 | subscription_required / conversation_limit_reached | A tulajdonosnak nincs használható előfizetése (minden végpont), vagy elérte a csomag beszélgetési korlátját (csak csevegés). |
| 403 | storage_limit_exceeded | A feltöltés túllépné a csomag tárhelykorlátját. A termékkötegek ezt tételenként, failed állapottal jelentik. |
| 403 | handoff_unavailable | Az élő csevegés ki van kapcsolva az alkalmazásnál, vagy nem része a csomagnak. Az eszkalálás, az átvétel és a válasz is újra ellenőrzi. |
| 409 | not_claimable | A munkamenet nem vár ügynökre. |
| 409 | handoff_not_active | A munkamenet jelenleg nincs hozzád rendelve. |
| 410 | session_closed | A munkamenet le lett zárva, és már nem fogad üzeneteket. |
| 404 | — | A munkamenet, fájl vagy termék nem ehhez az alkalmazáshoz tartozik. |
| 429 | — | Túl sok kérés; várd meg a Retry-After fejlécet. |
Widget-végpontok
Készen áll AI chatbotja építésére?
Töltse fel dokumentumait, ágyazza be a widgetet, és ügyfelei a nap 24 órájában azonnal választ kapnak. Kezdje ingyen, és csak akkor váltson nagyobb csomagra, ha a forgalma megnő.