API REST
Le istruzioni riportate di seguito sono valide solo per desktop e laptop.
La REST API di tawk.to ti permette di automatizzare e gestire molti aspetti del tuo account, semplificando le attività e integrando tawk.to con i tuoi sistemi esistenti.
Puoi utilizzare la REST API per:
Creare proprietà e invitare automaticamente i membri del team
Recuperare elenchi filtrati di ticket, chat o membri della proprietà
Visualizzare le statistiche delle chat per agente, tag, reparto e data
Gestire i webhook
Creare e elencare articoli della Knowledge Base
Creare e personalizzare i widget di chat
Nota: la REST API è pensata per sviluppatori o chiunque abbia dimestichezza con il codice. Se sei alle prime armi con le API, considera di lavorare con uno sviluppatore.
Per riferimenti tecnici e aggiornamenti, visita il Developer Portal di tawk.to.
Per saperne di più sull’uso dei webhook, consulta questa guida:Creazione e gestione dei Webhook
Per prima cosa, richiedi l’accesso alla REST API
La REST API è disponibile su richiesta. Per iniziare:
Compila il Modulo di richiesta di accesso alla REST API.
Una volta approvata la tua richiesta, riceverai un nome utente, una password e un link alla documentazione della REST API.
Crea una chiave API
Dopo aver ottenuto l’accesso alla REST API:
Accedi al tuo account tawk.to.
Fai clic sulla tua immagine del profilo nell’angolo in basso a sinistra della Dashboard.
3.Fai clic su Modifica profilo.
4.Fai clic su Chiavi REST API nel menu a sinistra.
5.Fai clic su Crea chiave.
Importante: conserva la tua chiave API in modo sicuro. Non condividerla con persone non autorizzate.
Per eliminare una chiave, seleziona la chiave e fai clic su Elimina.
Autentica le tue richieste
Tutte le richieste alla REST API devono:
Utilizzare HTTPS
Utilizzare l’HTTP Basic Authentication con la tua chiave API come nome utente nell’intestazione Authorization
Come configurare questo dipende dal client HTTP o dal linguaggio di programmazione che usi. La maggior parte supporta nativamente la Basic Authentication.
Per saperne di più sull’intestazione di autorizzazione HTTP, consulta questa pagina.
URL base e stile dei metodi
URL base: https://api.tawk.to/v1/
La REST API utilizza metodi in stile HTTP RPC. Passa i parametri nel corpo delle richieste POST, a meno che nella documentazione non sia specificato diversamente.
Esempio di richiesta
Ottenere i dettagli dell’agente corrente
Endpoint: POST https://api.tawk.to/v1/agent.me
Autenticazione: HTTP Basic (chiave API come nome utente)
Risposta: JSON con indicatore di successo; in caso di errore, viene restituito un codice di errore breve.
Gestione delle risposte e degli errori
Le richieste andate a buon fine restituiscono un JSON con un chiaro indicatore di successo.
Se qualcosa va storto, la risposta includerà un codice di errore che puoi utilizzare per effettuare il debug o gestire il problema.
Consulta la documentazione della REST API per l’elenco completo di metodi, parametri e codici di errore.
Per domande sull’uso della REST API, rivolgiti alla nostra community di sviluppatori.
Considerazioni importanti
Sicurezza
Conserva le tue chiavi API in modo sicuro e ruotale regolarmente.Test
Prova le tue richieste in un ambiente di staging prima di applicare modifiche in produzione.Gestione degli errori
Prevedi tentativi di ripetizione con backoff in caso di problemi temporanei.Webhook
Valida i payload in arrivo per confermare che le richieste siano genuine.Alternative
Se hai bisogno solo di personalizzare il widget sul tuo sito, l’API JavaScript potrebbe essere più semplice della REST API.
Se hai commenti su questo articolo o hai bisogno di ulteriore assistenza:
Contattaci via live chat
Prenota una chiamata con il nostro team
Visita la nostra community