Guida all'integrazione per sviluppatori

Panoramica per gli sviluppatori

WebChatAgent offre tre modi per mettere un chatbot a disposizione dei tuoi utenti. Scegline uno in base al livello di controllo desiderato sull'interfaccia.

IntegrazioneCosa ottieniIdeale per
Widget EmbedUna UI di chat predefinita tramite un solo tag scriptSiti web e applicazioni web
REST APIInvia un messaggio, ricevi una risposta (richiesta/risposta)UI personalizzate, app mobili, script server
WebSocket APIFlusso di messaggi in tempo reale con digitazione e presenzaDashboard di chat dal vivo, strumenti per operatori
JavaScript SDKPacchetto npm tipizzato per le REST e WebSocket APIUI di chat personalizzate in JavaScript o TypeScript
WebhookNuovi lead e appuntamenti come richiesta JSON firmata al tuo serverSincronizzazione CRM, automazioni

Tutte e tre le soluzioni comunicano con lo stesso chatbot, condividono la stessa Base di conoscenza e scalano la stessa quota di messaggi. Puoi combinarle, ad esempio incorporando il widget sul tuo sito e creando una dashboard interna per operatori basata sulle WebSocket API.

Widget Embed (il più veloce)

Aggiungi il chatbot a qualsiasi sito web con un singolo tag script e un elemento HTML personalizzato (<web-chat-agent chatbot-id="...">). Nessun framework, nessun passaggio di compilazione. Tutti i colori, i testi e gli strumenti vengono configurati nella dashboard e applicati automaticamente. Questa è la scelta adatta per il 90% dei siti web.

  • Guida al Widget Embed: tag script, elemento personalizzato, tutti gli attributi HTML, CSS personalizzato, modalità Chat integrata e utilizzo con SPA

REST API

Quando hai bisogno di un'interfaccia di chat proprietaria, come un'app mobile, un web component personalizzato o un'automazione backend, chiama direttamente l'endpoint di chat. Invia un message con il tuo chatbotId e ricevi una reply generata dall'IA insieme alle relative origini. Un ID Sessione restituito in un'intestazione di risposta mantiene coerenti le conversazioni con più passaggi.

  • Riferimento REST API: endpoint, autenticazione tramite dominio, campi di richiesta/risposta, codici di errore ed esempi di codice in cURL, JavaScript, Python e PHP

JavaScript SDK

Stai creando una UI di chat personalizzata in JavaScript o TypeScript? Il pacchetto npm webchatagent racchiude le REST e WebSocket API: risposte in streaming, Caricamento file, feedback, Moduli per lead e chat dal vivo con il tuo team, con tipi TypeScript completi e senza dipendenze.

  • JavaScript SDK: installazione, primo messaggio, streaming, trasferimento a un operatore umano. Pacchetto su npm, codice sorgente su GitHub

WebSocket API

Per la chat dal vivo, dove i messaggi devono arrivare all'istante e vuoi indicatori di digitazione, presenza e traduzione automatica. Lo stesso socket alimenta i widget per i visitatori e la dashboard degli operatori. Usalo per creare una console operatore personalizzata o per gestire la chat dal vivo dal tuo backend.

Quale dovrei usare?

Caso d'usoConsigliato
Aggiungere un chatbot a un sito webWidget Embed
Mostrare la chat all'interno del layout della tua paginaChat integrata (widget embed)
UI di chat personalizzata in JavaScript o TypeScriptJavaScript SDK
UI di chat personalizzata o app mobileREST API
Automazione server-to-server (senza UI)REST API
Dashboard di chat dal vivo in tempo reale per operatori umaniWebSocket API

Consulta Casi d'uso per scenari concreti resi possibili da queste integrazioni.