Informio fejlesztőknek

Chat, Search vagy saját felület beillesztése

Adja a weboldalhoz a kész chatwidgetet vagy az Informio Search-öt. Saját felülethez használja a nyilvános API-t engedélyezett domainekkel, lokalizációval és az asszisztens meglévő adataival.

Egyszerűsített telepítés

Teljes értékű widget egyetlen szkripttel

Először engedélyezze a webhely domainjét az asszisztens beállításaiban. Ezután cserélje le az ASSISTANT_ID értéket a nyilvános asszisztens-azonosítóra, és illessze be a kódot az oldalba. A widget automatikusan betölti a megjelenését, a címkéket és a beszélgetés előzményeit.

HTML
<script src="https://informio.eu/widget.js" data-assistant="ASSISTANT_ID" defer></script>

Helyezze a kódot a záró </body> tag elé. A defer attribútum biztosítja, hogy az oldal betöltése ne blokkolódjon, és a widget asztali és mobil eszközökön is működik.

Engedélyezett domain

A kérés Origin értékének meg kell egyeznie az asszisztens beállításaiban engedélyezett domainnel. A böngészők ezt automatikusan küldik.

Állandó munkamenet

Az Ön véletlenszerű session_id értéke megőrzi a beszélgetés előzményeit az üzenetek között és amikor az ügyfél ismét megnyílik.

Nyilvános asszisztens-azonosító

Az asszisztens-azonosító nem titkos API-kulcs. Soha ne tegyen titkokat vagy AI-szolgáltatói hitelesítő adatokat az ügyféloldalra.

Informio Search

Kész kereső beillesztése szkripttel

A szkript megjeleníti a mezőt, a javaslatokat és a találatokat, és maga hívja az Informio API-t. A befogadó weboldalon nem kell saját keresési backend.

  1. 1.Engedélyezze a weboldal domainjét az asszisztens beállításaiban. A Search lapon kapcsolja be a keresést, válasszon nyilvános webes/XML-forrásokat, majd mentse.
  2. 2.Másolja ki a generált kódot az adminisztrációból. A példában cserélje le az ASSISTANT_ID értékét az asszisztens nyilvános azonosítójára.
  3. 3.Illessze a kódot HTML-sablonba vagy szkripteket engedélyező egyéni HTML-blokkba. A kereső az oldal betöltésekor elindul.
Az Informio Search megismerése
HTML
<div id="informio-search"></div>
<script src="https://informio.eu/search.js"
  data-assistant="ASSISTANT_ID"
  data-target="#informio-search" defer></script>

A data-target egy meglévő tároló CSS-szelektora; elhagyásakor a mező a szkript helyén jelenik meg. A tárolók azonosítói legyenek egyediek. Minden keresőmezőhöz külön szkriptet és tárolót használjon.

React/Vue vagy más SPA esetén helyezze a tárolót állandó elrendezésbe, majd egyszer töltse be a szkriptet a document.createElement('script') segítségével. Az innerHTML-en át beillesztett szkriptek nem futnak le. Gyakran fel- és lecsatolt komponenshez használja az alábbi API-t.

Megjelenés és a találatok helye

A szín, téma, lekerekítés és nyelv az asszisztenstől származik. Válasszon inline vagy modal megjelenítést és opcionális AI-összefoglalót. A Shadow DOM elkülöníti a felületet az oldal CSS-étől.

Források és hivatkozások

A kiválasztott webes/XML-forrásokhoz nyilvános HTTP(S)-URL szükséges. Önálló MD- és dokumentumforrások nem támogatottak. A találatok a legutóbb szinkronizált adatokat használják.

Csomaghasználat

Az automatikus javaslatok nem hívják az AI-t. Egy sikeres, elküldött AI-keresés az opcionális összefoglalóval együtt egy szervezeti választ használ fel.

Saját felület a Search API-val

Ez az API saját felülethez szükséges. A kész search.js már minden kérést kezel. A Search nem igényel session_id-t vagy titkos API-kulcsot.

GET/api/search/{assistant}

Visszaadja a megjelenést, nyelvet, megjelenítési módot, márkajelzést és lokalizált feliratokat.

GET/api/search/{assistant}/suggest?q=wellness

Szöveges javaslatok AI nélkül, legfeljebb 6 találattal. A kötelező q paraméter 3–300 karakteres lehet.

POST/api/search/{assistant}/results

A JSON-törzs 3–300 karakteres q mezőt tartalmaz. Legfeljebb 24 találatot, valamint summary, mode és notice mezőket ad vissza.

Küldjön Accept: application/json, POST esetén Content-Type: application/json fejlécet is. Az Origin fejlécet a böngésző küldi; a domaint engedélyezni kell. Automatikus nyelvnél az Accept-Language választ nyelvet. A javaslatok előtt várjon 300 ms-ot, és szakítsa meg az elavult kéréseket.

JavaScript
const assistantId = 'ASSISTANT_ID';
const query = 'wellness';
const response = await fetch(
  `https://informio.eu/api/search/${assistantId}/results`,
  {
    method: 'POST',
    credentials: 'omit',
    headers: {
      Accept: 'application/json',
      'Content-Type': 'application/json',
      'Accept-Language': document.documentElement.lang || 'en',
    },
    body: JSON.stringify({ q: query }),
  },
);
if (!response.ok) throw new Error(String(response.status));
const { results, summary, mode, notice } = await response.json();
const container = document.querySelector('#custom-search-results');
container.replaceChildren();
for (const item of results) {
  const url = new URL(item.url);
  if (!['https:', 'http:'].includes(url.protocol)
    || url.username || url.password) continue;
  const link = document.createElement('a');
  link.href = url.href;
  link.textContent = item.title;
  container.append(link);
}
JSON
{
  "results": [
    {
      "title": "Wellness és nyitvatartás",
      "url": "https://example.com/wellness",
      "type": "page",
      "excerpt": "Medence, szaunák és hasznos tudnivalók a látogatás előtt.",
      "image_url": null,
      "price": null,
      "currency": null,
      "in_stock": null
    }
  ],
  "summary": null,
  "mode": "ai",
  "notice": null
}

A results kártyákat tartalmaz; a type értéke page, article, product, event vagy profile. A kép, ár, pénznem és készlet lehet null. A summary szöveg vagy null; a mode ai vagy text, a notice lokalizált üzenet vagy null. Legfeljebb 24 találat, lapozás nélkül.

A JavaScript-példa saját #custom-search-results tárolót vár, és hivatkozásokat jelenít meg. A részleteket, summary és notice mezőket textContent segítségével írja ki, ne innerHTML-lel. Ellenőrizze a HTTP(S)-URL-eket; képet csak image_url esetén töltsön be.

Korlátok és szöveges mód

A konfiguráció és a javaslatok közös korlátja 120 kérés/perc asszisztensenként és IP-címenként. A találatoké 20 kérés/perc. 429 esetén tartsa be a Retry-After értékét.

AI-hiba vagy kimerült csomag esetén HTTP 200 érkezhet mode: text értékkel és szöveges találatokkal, válasz felhasználása nélkül. Ha csak az összefoglaló hibázik, a mode ai marad, a summary null, és a keresés egy választ fogyaszt.

OpenAPI letöltése

Hibaválaszok

403
A domain nincs engedélyezve.
404
Az asszisztens nem létezik, piszkozat, vagy a Search ki van kapcsolva.
422
Hiányzó vagy érvénytelen q paraméter.
423
Az asszisztens szünetel, vagy a minőségellenőrzés blokkolja.
429
A kérési korlát túllépve; próbálja újra a Retry-After letelte után.

Gyors kezdés

Szerezze meg az első API-választ

Cserélje le az ASSISTANT_ID értéket az asszisztens beállításaiban megadott nyilvános azonosítóra. A beszélgetés során végig ugyanazt a session_id értéket használja.

Alap URL

https://informio.eu/api
curl --request POST \
  --url https://informio.eu/api/widget/ASSISTANT_ID/messages \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Origin: https://example.com' \
  --data '{
    "session_id": "visitor-session-01JEXAMPLE1234567890",
    "message": "When are you open?"
  }'

API referencia

Nyilvános Widget API

Az Informio hivatalos widgetje által használt stabil végpontok.

GET/widget/{assistant}

Asszisztens konfiguráció

Visszaadja a nevet, a megjelenést, a címkéket, az operátor elérhetőségét és a munkamenet meglévő előzményeit.

POST/widget/{assistant}/messages

Üzenet küldése

Elküldi a látogató kérdését, és választ, termékeket vagy az aktuális emberi átadás állapotát adja vissza.

GET/widget/{assistant}/sync

Csevegés szinkronizálása

Betölti az új operátori üzeneteket, az átvétel állapotát és a beszélgetés befejezését a teljes felület frissítése nélkül.

POST/widget/{assistant}/handoff

Operátor kérése

Megkéri az elérhető csapatot, hogy vegye át a beszélgetést, amikor az asszisztensnél engedélyezve van az emberi átadás.

POST/widget/{assistant}/page-view

Látogatói navigáció követése

Összekapcsolja a meglátogatott URL-t és oldalcímet a beszélgetéssel, űrlaptartalom vagy lekérdezési paraméterek nélkül.

POST/widget/{assistant}/end

Befejezés és értékelés

Befejezi az aktuális beszélgetést, és opcionálisan ment egy pozitív vagy negatív látogatói értékelést.

Ajánlott folyamat

Egy munkamenet a megnyitástól a befejezésig

Az ügyfélnek csak egy nyilvános asszisztens-azonosítóra, egy engedélyezett Origin értékre és egy állandó session_id értékre van szüksége.

1

Konfiguráció betöltése

A csevegés megnyitásakor kérje le a megjelenést, a címkéket és a munkamenet meglévő előzményeit.

2

Üzenetek küldése

Minden kérdést ugyanazzal a session_id értékkel küldjön el, és weben adja meg az aktuális oldalt.

3

Szinkronban tartás

Miután személyt kért, rendszeresen töltse be az új üzeneteket és az operátor állapotát.

Géppel olvasható szerződés

Importálja az OpenAPI YAML-t Postmanbe vagy Insomniába, vagy használja kliens generálására az Ön által preferált nyelven.

OpenAPI letöltése

Asszisztenseket API-n keresztül szeretne kezelni?

A nyilvános leírás a chatet, a widgetet és a Search-öt fedi le. Az asszisztens- és tudáskezelési API-k nem nyilvánosak; írjon az info@informio.eu címre.

Alakítsa a szaktudását egy olyan asszisztenssé, amely 24/7 válaszol.

Kezdés fizetési kártya vagy API-kulcs nélkül. Az alapértelmezett Informio AI automatikusan készen áll, miközben a saját OpenAI-fiókja vagy AI-szervere továbbra is opcionális.

INGYENES csomag · 100 válasz · nincs szükség fizetési kártyára