Riferimento API

Riferimento completo per l'API Widget e gli endpoint REST.

API Widget

L'oggetto globale window.LaunchChatWidget fornisce metodi per controllare il widget in modo programmatico.

Metodi

open()

Apre la finestra di chat in modo programmatico.

window.LaunchChatWidget.open();

close()

Chiude la finestra di chat.

window.LaunchChatWidget.close();

destroy()

Rimuove completamente il widget dalla pagina. Utile per le SPA durante la navigazione.

window.LaunchChatWidget.destroy();

init(config)

Reinizializza il widget con una nuova configurazione.

window.LaunchChatWidget.init({ widgetId: "new-widget-id" });

on(event, callback)

Sottoscrive gli eventi del widget.

window.LaunchChatWidget.on('message', (data) => {
  console.log('New message:', data);
});

off(event, callback)

Annulla la sottoscrizione agli eventi del widget.

Eventi

Evento	Payload	Descrizione
`open`	`{ timestamp }`	Finestra di chat aperta
`close`	`{ timestamp }`	Finestra di chat chiusa
`message`	`{ content, role }`	Messaggio inviato o ricevuto
`escalate`	`{ email, message }`	L'utente ha richiesto assistenza umana
`feedback`	`{ messageId, type }`	L'utente ha fornito un feedback (positivo/negativo)

API REST

POST /api/widget/chat

Invia un messaggio e riceve una risposta generata dall'IA.

Corpo della Richiesta

{
  "widgetId": "string",      // Required
  "message": "string",       // Required - user's question
  "conversationId": "string", // Optional - for context
  "visitorId": "string",     // Optional - track visitor
  "pageUrl": "string"        // Optional - current page
}

Risposta

{
  "conversationId": "uuid",
  "messageId": "uuid",
  "answer": "string",
  "citations": [
    {
      "pageId": "string",
      "pageTitle": "string",
      "pageUrl": "string",
      "excerpt": "string"
    }
  ],
  "relatedArticles": [...],
  "confidenceScore": 0.85,
  "wasRefused": false
}

Codici di Errore

Codice	Stato	Descrizione
`400`	Richiesta non valida	Campi obbligatori mancanti
`403`	Accesso negato	Dominio non presente nella lista consentita
`404`	Non trovato	Widget non trovato o inattivo
`429`	Limite di richieste raggiunto	Quota messaggi superata
`500`	Errore del server	Errore interno di elaborazione

Tipi TypeScript

Copi questi tipi nel Suo progetto per una completa sicurezza dei tipi:

interface LaunchChatConfig {
  widgetId: string;
  primaryColor?: string;
  greeting?: string;
  placeholder?: string;
  position?: 'bottom-right' | 'bottom-left';
  theme?: 'light' | 'dark' | 'auto';
}

interface WidgetAPI {
  open(): void;
  close(): void;
  destroy(): void;
  init(config: { widgetId: string }): Promise<void>;
  on<E extends keyof WidgetEvents>(
    event: E,
    callback: (data: WidgetEvents[E]) => void
  ): void;
  off<E extends keyof WidgetEvents>(
    event: E,
    callback: (data: WidgetEvents[E]) => void
  ): void;
}

interface WidgetEvents {
  open: { timestamp: number };
  close: { timestamp: number };
  message: { content: string; role: 'user' | 'assistant' };
  escalate: { email: string; message: string };
  feedback: { messageId: string; type: 'positive' | 'negative' };
}

declare global {
  interface Window {
    LaunchChatConfig?: LaunchChatConfig;
    LaunchChatWidget?: WidgetAPI;
  }
}