Chiamare API esterne nei tuoi flussi di chat
Attualmente, il componente di chat API è supportato solo per WhatsApp Bot. In arrivo presto per gli altri canali.
Cos'è un'API esterna?
Un'API esterna (Application Programming Interface) si riferisce a un insieme di regole e protocolli che consentono a un'applicazione software di interagire e comunicare con un altro sistema software esterno, servizio o piattaforma. Consente a diversi programmi software di accedere e scambiare dati e funzionalità senza soluzione di continuità, anche se sono sviluppati da organizzazioni diverse o funzionano su server diversi.
Tipi di API
Esistono diversi tipi di API, ciascuno con scopi e casi d'uso specifici.
Attualmente supportiamo le API RESTful basate su JSON con chiave API, Token JWT o API pubbliche
Flussi di lavoro per l'utilizzo delle API nel ChatFlow
Ecco il flusso per utilizzare le API nei Chatflow
Utilizzare le API nei Chatflow
Per integrare perfettamente le API nei tuoi flussi di chat in Acconsentobot, segui questi passaggi:
Passaggio 1: Accedere alla Dashboard di Acconsentobot
- Accedi al tuo account Acconsentobot e accedi alla dashboard.
Passaggio 2: Navigare nella Sezione Sviluppatori
- Dalla barra di navigazione laterale, individua e clicca su "Altro".
- All'interno della sezione "Altro", seleziona "Sviluppatori".
Passaggio 3: Preparare gli Attributi Personalizzati
- Prima di procedere, assicurati di aver aggiunto tutti gli attributi personalizzati necessari che ti serviranno per le interazioni API. Gli attributi personalizzati aiuteranno a catturare e gestire i dati. Consulta il documento prima di creare e gestire gli attributi personalizzati
Gestire e Utilizzare gli Attributi Personalizzati
Passaggio 4: Aggiungere una Nuova API
- Nella sezione "Sviluppatori", trova "Le Tue API" e clicca su "Aggiungi API" in alto a destra.
Passaggio 5: Configurare la Tua API
- In "Configura API", imposta i seguenti dettagli. La struttura è simile a Postman per testare le API:
- Nome API: Questo è il nome visualizzato per l'API, utilizzato per una migliore leggibilità all'interno di Acconsentobot.
- Metodo API: Specifica il metodo HTTP (ad esempio, GET, POST, PUT).
- Inserisci URL API: Fornisci l'URL per l'API che intendi chiamare.
- Parametri Query: Aggiungi eventuali parametri query richiesti.
- Intestazioni: Includi le intestazioni necessarie per l'API.
- Corpo: Definisci il corpo della richiesta se necessario.
Nota: Se desideri inserire variabili personalizzate all'interno dell'API, usa "/" come segnaposto. Tuttavia, per la configurazione iniziale, dovrai inserire i valori effettivi per testare l'API e salvare la struttura della risposta.
Passaggio 6: Testare l'API
- Procedi a "Gestisci Risposta API" e clicca su "Testa" l'API con valori effettivi. Questo aiuterà Acconsentobot a comprendere la struttura della risposta API.
Passaggio 7: Mappare la Risposta API agli Attributi Personalizzati
- Nella scheda "Gestisci Risposta API", puoi mappare le variabili della risposta API ai tuoi attributi personalizzati Acconsentobot.
Passaggio 8: Sostituire i Valori Effettivi
- Se necessario, sostituisci i valori effettivi nella configurazione della tua API con gli attributi personalizzati che hai mappato.
Passaggio 9: Accedere al Tuo Chatflow
- Vai al chatflow del tuo Bot cliccando su "Modifica il tuo Chatflow" nella sezione "Bot".
Passaggio 10: Selezionare il Componente di Chat "API"
- Nell'elenco dei componenti di chat, scegli il componente di chat "API".
Passaggio 11: Chiamare l'API
- Nel pannello destro, chiama l'API selezionando l'API che hai configurato in precedenza tramite il suo nome.
Passaggio 12: Mappare le Domande Successive
- Mappa la domanda successiva in base al codice di risposta della tua API (ad esempio, 200, 300, ecc.). Se il codice di risposta dell'API non corrisponde a nessun valore predefinito, attiverà la risposta mappata a "altri".
Ed è fatto! La tua API è pronta per migliorare la funzionalità del tuo chatbot e fornire interazioni dinamiche basate sulle risposte API.